CreateAccessPoint - Amazon Simple Storage Service

CreateAccessPoint

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Request Syntax

PUT /v20180820/accesspoint/name HTTP/1.1 x-amz-account-id: AccountId <?xml version="1.0" encoding="UTF-8"?> <CreateAccessPointRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/"> <Bucket>string</Bucket> <VpcConfiguration> <VpcId>string</VpcId> </VpcConfiguration> <PublicAccessBlockConfiguration> <BlockPublicAcls>boolean</BlockPublicAcls> <BlockPublicPolicy>boolean</BlockPublicPolicy> <IgnorePublicAcls>boolean</IgnorePublicAcls> <RestrictPublicBuckets>boolean</RestrictPublicBuckets> </PublicAccessBlockConfiguration> </CreateAccessPointRequest>

URI Request Parameters

The request uses the following URI parameters.

name

The name you want to assign to this access point.

Length Constraints: Minimum length of 3. Maximum length of 50.

Required: Yes

x-amz-account-id

The AWS account ID for the owner of the bucket for which you want to create an access point.

Length Constraints: Maximum length of 64.

Pattern: ^\d{12}$

Required: Yes

Request Body

The request accepts the following data in XML format.

CreateAccessPointRequest

Root level tag for the CreateAccessPointRequest parameters.

Required: Yes

Bucket

The name of the bucket that you want to associate this access point with.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Required: Yes

PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

Type: PublicAccessBlockConfiguration data type

Required: No

VpcConfiguration

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

Type: VpcConfiguration data type

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: