Class: Aws::S3::Types::ServerSideEncryptionByDefault

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

Overview

Note:

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

{
  sse_algorithm: "AES256", # required, accepts AES256, aws:kms
  kms_master_key_id: "SSEKMSKeyId",
}

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn’t specify any server-side encryption, this default encryption will be applied. For more information, see [PUT Bucket encryption] in the *Amazon S3 API Reference*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:kms_master_key_id]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_master_key_id ⇒ String

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations].

**For example:**

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see [Using symmetric and asymmetric keys] in the *Amazon Web Services Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy [2]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html

Returns:

  • (String) 


14285
14286
14287
14288
14289
14290
 
# File 'lib/aws-sdk-s3/types.rb', line 14285

class ServerSideEncryptionByDefault < Struct.new(
  :sse_algorithm,
  :kms_master_key_id)
  SENSITIVE = [:kms_master_key_id]
  include Aws::Structure
end

#sse_algorithm ⇒ String

Server-side encryption algorithm to use for the default encryption.

Returns:

  • (String) 


14285
14286
14287
14288
14289
14290
 
# File 'lib/aws-sdk-s3/types.rb', line 14285

class ServerSideEncryptionByDefault < Struct.new(
  :sse_algorithm,
  :kms_master_key_id)
  SENSITIVE = [:kms_master_key_id]
  include Aws::Structure
end