Skip to content

/AWS1/IF_S3C=>CREATEACCESSPOINT()

About CreateAccessPoint

Creates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API Reference.

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:

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature

IMPORTING

Required arguments:

iv_accountid TYPE /AWS1/S3CACCOUNTID /AWS1/S3CACCOUNTID

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

iv_name TYPE /AWS1/S3CACCESSPOINTNAME /AWS1/S3CACCESSPOINTNAME

The name you want to assign to this access point.

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

iv_bucket TYPE /AWS1/S3CBUCKETNAME /AWS1/S3CBUCKETNAME

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:::outpost//bucket/. 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.

Optional arguments:

io_vpcconfiguration TYPE REF TO /AWS1/CL_S3CVPCCONFIGURATION /AWS1/CL_S3CVPCCONFIGURATION

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

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

io_publicaccessblockconf TYPE REF TO /AWS1/CL_S3CPUBLICACCBLOCKCONF /AWS1/CL_S3CPUBLICACCBLOCKCONF

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

iv_bucketaccountid TYPE /AWS1/S3CACCOUNTID /AWS1/S3CACCOUNTID

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.

io_scope TYPE REF TO /AWS1/CL_S3CSCOPE /AWS1/CL_S3CSCOPE

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Scope is only supported for access points attached to directory buckets.

it_tags TYPE /AWS1/CL_S3CTAG=>TT_TAGLIST TT_TAGLIST

An array of tags that you can apply to an access point. Tags are key-value pairs of metadata used to control access to your access points. For more information about tags, see Using tags with Amazon S3. For information about tagging access points, see Using tags for attribute-based access control (ABAC).

  • You must have the s3:TagResource permission to create an access point with tags for a general purpose bucket.

  • You must have the s3express:TagResource permission to create an access point with tags for a directory bucket.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3ccreateaccpointrslt /AWS1/CL_S3CCREATEACCPOINTRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_s3c~createaccesspoint(
  io_publicaccessblockconf = new /aws1/cl_s3cpublicaccblockconf(
    iv_blockpublicacls = ABAP_TRUE
    iv_blockpublicpolicy = ABAP_TRUE
    iv_ignorepublicacls = ABAP_TRUE
    iv_restrictpublicbuckets = ABAP_TRUE
  )
  io_scope = new /aws1/cl_s3cscope(
    it_permissions = VALUE /aws1/cl_s3cscopepermlist_w=>tt_scopepermissionlist(
      ( new /aws1/cl_s3cscopepermlist_w( |string| ) )
    )
    it_prefixes = VALUE /aws1/cl_s3cprefixeslist_w=>tt_prefixeslist(
      ( new /aws1/cl_s3cprefixeslist_w( |string| ) )
    )
  )
  io_vpcconfiguration = new /aws1/cl_s3cvpcconfiguration( |string| )
  it_tags = VALUE /aws1/cl_s3ctag=>tt_taglist(
    (
      new /aws1/cl_s3ctag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_accountid = |string|
  iv_bucket = |string|
  iv_bucketaccountid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_s3accesspointarn = lo_result->get_accesspointarn( ).
  lv_alias = lo_result->get_alias( ).
ENDIF.