CreateEndpointCommand

Suggest an Edit

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:

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3OutpostsClient, CreateEndpointCommand } from "@aws-sdk/client-s3outposts"; // ES Modules import
// const { S3OutpostsClient, CreateEndpointCommand } = require("@aws-sdk/client-s3outposts"); // CommonJS import
const client = new S3OutpostsClient(config);
const input = { // CreateEndpointRequest
  OutpostId: "STRING_VALUE", // required
  SubnetId: "STRING_VALUE", // required
  SecurityGroupId: "STRING_VALUE", // required
  AccessType: "Private" || "CustomerOwnedIp",
  CustomerOwnedIpv4Pool: "STRING_VALUE",
};
const command = new CreateEndpointCommand(input);
const response = await client.send(command);
// { // CreateEndpointResult
//   EndpointArn: "STRING_VALUE",
// };

CreateEndpointCommand Input

See CreateEndpointCommandInput for more details

Parameter
Type
Description
OutpostId
Required
string | undefined

The ID of the Outposts.

SecurityGroupId
Required
string | undefined

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

SubnetId
Required
string | undefined

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

AccessType
EndpointAccessType | undefined

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
string | undefined

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

CreateEndpointCommand Output

See CreateEndpointCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EndpointArn
string | undefined

The Amazon Resource Name (ARN) of the endpoint.

Throws

Name
Fault
Details
AccessDeniedException
client

Access was denied for this action.

ConflictException
client

There was a conflict with this action, and it could not be completed.

InternalServerException
server

There was an exception with the internal server.

OutpostOfflineException
client

The service link connection to your Outposts home Region is down. Check your connection and try again.

ResourceNotFoundException
client

The requested resource was not found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

There was an exception validating this data.

S3OutpostsServiceException
Base exception class for all service exceptions from S3Outposts service.