aws-cdk-lib.aws_s3outposts.CfnEndpointProps

interface CfnEndpointProps

LanguageType name
.NETAmazon.CDK.AWS.S3Outposts.CfnEndpointProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3outposts#CfnEndpointProps
Javasoftware.amazon.awscdk.services.s3outposts.CfnEndpointProps
Pythonaws_cdk.aws_s3outposts.CfnEndpointProps
TypeScript aws-cdk-lib » 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 { aws_s3outposts as s3outposts } from 'aws-cdk-lib';
const cfnEndpointProps: s3outposts.CfnEndpointProps = {
  outpostId: 'outpostId',
  securityGroupId: 'securityGroupId',
  subnetId: 'subnetId',

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

Properties

NameTypeDescription
outpostIdstringThe ID of the Outpost.
securityGroupIdstringThe ID of the security group to use with the endpoint.
subnetIdstringThe ID of the subnet.
accessType?stringThe container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
customerOwnedIpv4Pool?stringThe 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.