[ aws . s3outposts ]

create-endpoint

Description

Creates an endpoint and associates it with the specified Outpost.

Note

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

Related actions include:

• DeleteEndpoint

• ListEndpoints

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-endpoint
--outpost-id <value>
--subnet-id <value>
--security-group-id <value>
[--access-type <value>]
[--customer-owned-ipv4-pool <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--outpost-id (string)

The ID of the Outposts.

--subnet-id (string)

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

--security-group-id (string)

The ID of the security group to use with the endpoint.

--access-type (string)

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).

Note

Private is the default access type value.

Possible values:

• Private

• CustomerOwnedIp

--customer-owned-ipv4-pool (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

EndpointArn -> (string)

The Amazon Resource Name (ARN) of the endpoint.