Class: Aws::S3::Types::PutBucketEncryptionRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutBucketEncryptionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  Specifies default encryption for a bucket using server-side encryption with different key options.

• #checksum_algorithm ⇒ String

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

• #content_md5 ⇒ String

  The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

• #server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

  Specifies the default server-side-encryption configuration.

Instance Attribute Details

#bucket ⇒ String

Specifies default encryption for a bucket using server-side encryption with different key options.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format ‘s3express-control.region-code.amazonaws.com/bucket-name `. Virtual-hosted-style requests aren’t supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ‘ bucket-base-name–zone-id–x-s3` (for example, ` DOC-EXAMPLE-BUCKET–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

Returns:

• (String)

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

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

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object 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.

<note markdown=“1”> For directory buckets, when you use Amazon Web Services SDKs, ‘CRC32` is the default checksum algorithm that’s used for performance.

</note>

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

Returns:

• (String)

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

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

#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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

#expected_bucket_owner ⇒ String

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).

<note markdown=“1”> For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code ‘501 Not Implemented`.

</note>

Returns:

• (String)

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

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

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

Specifies the default server-side-encryption configuration.

Returns:

• (Types::ServerSideEncryptionConfiguration)

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

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