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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  server_side_encryption_configuration: { # required
    rules: [ # required
      {
        apply_server_side_encryption_by_default: {
          sse_algorithm: "AES256", # required, accepts AES256, aws:kms
          kms_master_key_id: "SSEKMSKeyId",
        },
        bucket_key_enabled: false,
      },
    ],
  },
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon S3 User Guide.

Returns:

  • (String)


11646
11647
11648
11649
11650
11651
11652
11653
11654
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11646

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

#checksum_algorithmString

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.

Returns:

  • (String)


11646
11647
11648
11649
11650
11651
11652
11653
11654
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11646

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

#content_md5String

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.

Returns:

  • (String)


11646
11647
11648
11649
11650
11651
11652
11653
11654
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11646

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

#expected_bucket_ownerString

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)


11646
11647
11648
11649
11650
11651
11652
11653
11654
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11646

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

#server_side_encryption_configurationTypes::ServerSideEncryptionConfiguration

Specifies the default server-side-encryption configuration.



11646
11647
11648
11649
11650
11651
11652
11653
11654
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11646

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