Class: Aws::S3::Types::PutBucketCorsRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutBucketCorsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutBucketCorsRequest data as a hash:

{
  bucket: "BucketName", # required
  cors_configuration: { # required
    cors_rules: [ # required
      {
        id: "ID",
        allowed_headers: ["AllowedHeader"],
        allowed_methods: ["AllowedMethod"], # required
        allowed_origins: ["AllowedOrigin"], # required
        expose_headers: ["ExposeHeader"],
        max_age_seconds: 1,
      },
    ],
  },
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  expected_bucket_owner: "AccountId",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  Specifies the bucket impacted by the ‘cors`configuration.

• #checksum_algorithm ⇒ String

  Indicates the algorithm used to create the checksum for the object when using the SDK.

• #content_md5 ⇒ String

  The base64-encoded 128-bit MD5 digest of the data.

• #cors_configuration ⇒ Types::CORSConfiguration

  Describes the cross-origin access configuration for objects in an Amazon S3 bucket.

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

Instance Attribute Details

#bucket ⇒ String

Specifies the bucket impacted by the ‘cors`configuration.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 11565

class PutBucketCorsRequest < Struct.new(
  :bucket,
  :cors_configuration,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 11565

class PutBucketCorsRequest < Struct.new(
  :bucket,
  :cors_configuration,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ String

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.

[1]: www.ietf.org/rfc/rfc1864.txt

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 11565

class PutBucketCorsRequest < Struct.new(
  :bucket,
  :cors_configuration,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configuration ⇒ Types::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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/cors.html

Returns:

• (Types::CORSConfiguration)

# File 'lib/aws-sdk-s3/types.rb', line 11565

class PutBucketCorsRequest < Struct.new(
  :bucket,
  :cors_configuration,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 11565

class PutBucketCorsRequest < Struct.new(
  :bucket,
  :cors_configuration,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end