S3Control / Client / create_access_point

create_access_point#

S3Control.Client.create_access_point(**kwargs)#

Note

This operation is not supported by directory buckets.

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 S3 User Guide.

Note

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

See also: AWS API Documentation

Request Syntax

response = client.create_access_point(
    AccountId='string',
    Name='string',
    Bucket='string',
    VpcConfiguration={
        'VpcId': 'string'
    },
    PublicAccessBlockConfiguration={
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    },
    BucketAccountId='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID for the account that owns the specified access point.

  • Name (string) –

    [REQUIRED]

    The name you want to assign to this access point.

  • Bucket (string) –

    [REQUIRED]

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

    For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

    For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

  • VpcConfiguration (dict) –

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

    Note

    This is required for creating an access point for Amazon S3 on Outposts buckets.

    • VpcId (string) – [REQUIRED]

      If this field is specified, this access point will only allow connections from the specified VPC ID.

  • PublicAccessBlockConfiguration (dict) –

    The PublicAccessBlock configuration that you want to apply to the access point.

    • BlockPublicAcls (boolean) –

      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.

      • PUT Object calls fail if the request includes a public ACL.

      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn’t affect existing policies or ACLs.

      This property is not supported for Amazon S3 on Outposts.

    • IgnorePublicAcls (boolean) –

      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn’t affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set.

      This property is not supported for Amazon S3 on Outposts.

    • BlockPublicPolicy (boolean) –

      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

      Enabling this setting doesn’t affect existing bucket policies.

      This property is not supported for Amazon S3 on Outposts.

    • RestrictPublicBuckets (boolean) –

      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Services service principals and authorized users within this account.

      Enabling this setting doesn’t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

      This property is not supported for Amazon S3 on Outposts.

  • BucketAccountId (string) –

    The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

    For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

Return type:

dict

Returns:

Response Syntax

{
    'AccessPointArn': 'string',
    'Alias': 'string'
}

Response Structure

  • (dict) –

    • AccessPointArn (string) –

      The ARN of the access point.

      Note

      This is only supported by Amazon S3 on Outposts.

    • Alias (string) –

      The name or alias of the access point.