AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::S3Outposts::Endpoint

CfnEndpoint

This AWS::S3Outposts::Endpoint resource specifies an endpoint and associates it with the specified Outpost. Amazon S3 on Outposts access points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to S3 on Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see [Accessing S3 on Outposts using VPC-only access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html) . > It can take up to 5 minutes for this resource to be created.

Import

import { CfnEndpoint } from 'aws-cdk-lib/aws-s3outposts';

Or use the module namespace:

import * as s3outposts from 'aws-cdk-lib/aws-s3outposts';
// s3outposts.CfnEndpoint

Properties

Configuration passed to the constructor as CfnEndpointProps.

outpostIdRequired
string

The ID of the Outpost.

securityGroupIdRequired
string

The ID of the security group used for the endpoint.

subnetIdRequired
string

The ID of the subnet used for the endpoint.

accessTypeOptional
string

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.

Default: - "Private"

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

failedReasonOptional
IResolvable | FailedReasonProperty

The failure reason, if any, for a create or delete endpoint operation.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::S3Outposts::EndpointView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-s3outposts
CFN TypeAWS::S3Outposts::Endpoint
Properties6

Related Constructs

Explore This Service

External Links