Skip to content

Create Endpoint

s3outposts_create_endpoint R Documentation

Creates an endpoint and associates it with the specified Outpost

Description

Creates an endpoint and associates it with the specified Outpost.

It can take up to 5 minutes for this action to finish.

Related actions include:

  • delete_endpoint

  • list_endpoints

Usage

s3outposts_create_endpoint(OutpostId, SubnetId, SecurityGroupId,
  AccessType, CustomerOwnedIpv4Pool)

Arguments

OutpostId

[required] The ID of the Outposts.

SubnetId

[required] The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

SecurityGroupId

[required] The ID of the security group to use with the endpoint.

AccessType

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

CustomerOwnedIpv4Pool

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

Value

A list with the following syntax: 

list(
  EndpointArn = "string"
)

Request syntax

svc$create_endpoint(
  OutpostId = "string",
  SubnetId = "string",
  SecurityGroupId = "string",
  AccessType = "Private"|"CustomerOwnedIp",
  CustomerOwnedIpv4Pool = "string"
)