PUTBUCKETCORS()`¶

About PutBucketCors¶

This operation is not supported for directory buckets.

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

The request's Origin header must match AllowedOrigin elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.
Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

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¶

METHODS /AWS1/IF_S3~PUTBUCKETCORS
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IO_CORSCONFIGURATION TYPE REF TO /AWS1/CL_S3_CORSCONFIGURATION OPTIONAL
    !IV_CONTENTMD5 TYPE /AWS1/S3_CONTENTMD5 OPTIONAL
    !IV_CHECKSUMALGORITHM TYPE /AWS1/S3_CHECKSUMALGORITHM OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_bucket` `TYPE /AWS1/S3_BUCKETNAME` `/AWS1/S3_BUCKETNAME`¶

Specifies the bucket impacted by the corsconfiguration.

`io_corsconfiguration` `TYPE REF TO /AWS1/CL_S3_CORSCONFIGURATION` `/AWS1/CL_S3_CORSCONFIGURATION`¶

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Optional arguments:¶

`iv_contentmd5` `TYPE /AWS1/S3_CONTENTMD5` `/AWS1/S3_CONTENTMD5`¶

The Base64 encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

`iv_checksumalgorithm` `TYPE /AWS1/S3_CHECKSUMALGORITHM` `/AWS1/S3_CHECKSUMALGORITHM`¶

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

`iv_expectedbucketowner` `TYPE /AWS1/S3_ACCOUNTID` `/AWS1/S3_ACCOUNTID`¶

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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.

lo_client->putbucketcors(
  io_corsconfiguration = new /aws1/cl_s3_corsconfiguration(
    it_corsrules = VALUE /aws1/cl_s3_corsrule=>tt_corsrules(
      (
        new /aws1/cl_s3_corsrule(
          it_allowedheaders = VALUE /aws1/cl_s3_allowedheaders_w=>tt_allowedheaders(
            ( new /aws1/cl_s3_allowedheaders_w( |string| ) )
          )
          it_allowedmethods = VALUE /aws1/cl_s3_allowedmethods_w=>tt_allowedmethods(
            ( new /aws1/cl_s3_allowedmethods_w( |string| ) )
          )
          it_allowedorigins = VALUE /aws1/cl_s3_allowedorigins_w=>tt_allowedorigins(
            ( new /aws1/cl_s3_allowedorigins_w( |string| ) )
          )
          it_exposeheaders = VALUE /aws1/cl_s3_exposeheaders_w=>tt_exposeheaders(
            ( new /aws1/cl_s3_exposeheaders_w( |string| ) )
          )
          iv_id = |string|
          iv_maxageseconds = 123
        )
      )
    )
  )
  iv_bucket = |string|
  iv_checksumalgorithm = |string|
  iv_contentmd5 = |string|
  iv_expectedbucketowner = |string|
).

To set cors configuration on a bucket.¶

The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.

lo_client->putbucketcors(
  io_corsconfiguration = new /aws1/cl_s3_corsconfiguration(
    it_corsrules = VALUE /aws1/cl_s3_corsrule=>tt_corsrules(
      (
        new /aws1/cl_s3_corsrule(
          it_allowedheaders = VALUE /aws1/cl_s3_allowedheaders_w=>tt_allowedheaders(
            ( new /aws1/cl_s3_allowedheaders_w( |*| ) )
          )
          it_allowedmethods = VALUE /aws1/cl_s3_allowedmethods_w=>tt_allowedmethods(
            ( new /aws1/cl_s3_allowedmethods_w( |PUT| ) )
            ( new /aws1/cl_s3_allowedmethods_w( |POST| ) )
            ( new /aws1/cl_s3_allowedmethods_w( |DELETE| ) )
          )
          it_allowedorigins = VALUE /aws1/cl_s3_allowedorigins_w=>tt_allowedorigins(
            ( new /aws1/cl_s3_allowedorigins_w( |http://www.example.com| ) )
          )
          it_exposeheaders = VALUE /aws1/cl_s3_exposeheaders_w=>tt_exposeheaders(
            ( new /aws1/cl_s3_exposeheaders_w( |x-amz-server-side-encryption| ) )
          )
          iv_maxageseconds = 3000
        )
      )
      (
        new /aws1/cl_s3_corsrule(
          it_allowedheaders = VALUE /aws1/cl_s3_allowedheaders_w=>tt_allowedheaders(
            ( new /aws1/cl_s3_allowedheaders_w( |Authorization| ) )
          )
          it_allowedmethods = VALUE /aws1/cl_s3_allowedmethods_w=>tt_allowedmethods(
            ( new /aws1/cl_s3_allowedmethods_w( |GET| ) )
          )
          it_allowedorigins = VALUE /aws1/cl_s3_allowedorigins_w=>tt_allowedorigins(
            ( new /aws1/cl_s3_allowedorigins_w( |*| ) )
          )
          iv_maxageseconds = 3000
        )
      )
    )
  )
  iv_bucket = ||
  iv_contentmd5 = ||
).

/AWS1/IF_S3=>PUTBUCKETCORS()¶