interface CfnEndpointProps

Language	Type name
.NET	Amazon.CDK.AWS.S3Outposts.CfnEndpointProps
Java	software.amazon.awscdk.services.s3outposts.CfnEndpointProps
Python	aws_cdk.aws_s3outposts.CfnEndpointProps
TypeScript	@aws-cdk/aws-s3outposts » CfnEndpointProps

Properties for defining a CfnEndpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as s3outposts from '@aws-cdk/aws-s3outposts';
const cfnEndpointProps: s3outposts.CfnEndpointProps = {
  outpostId: 'outpostId',
  securityGroupId: 'securityGroupId',
  subnetId: 'subnetId',

  // the properties below are optional
  accessType: 'accessType',
  customerOwnedIpv4Pool: 'customerOwnedIpv4Pool',
};

Properties

Name	Type	Description
outpostId	string	The ID of the Outpost.
securityGroupId	string	The ID of the security group to use with the endpoint.
subnetId	string	The ID of the subnet.
accessType?	string	The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
customerOwnedIpv4Pool?	string	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

---

outpostId

Type: string

The ID of the Outpost.

---

securityGroupId

Type: string

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

---

subnetId

Type: string

The ID of the subnet.

---

accessType?

Type: string (optional)

The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.

To use the Amazon 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?

Type: string (optional)

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

IP addresses are allocated from this pool for the endpoint.