You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ServerSideEncryptionByDefault as input to an Aws::Client method, you can use a vanilla 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 Simple Storage Service API Reference.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#kms_master_key_id ⇒ String

AWS Key Management Service (KMS) customer master 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 CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK 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 CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

Returns:

  • (String) —

    AWS Key Management Service (KMS) customer master key ID to use for the default encryption.

#sse_algorithm ⇒ String

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

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String) —

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