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

Class: Aws::DynamoDB::Types::SSESpecification

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

Overview

Note:

When passing SSESpecification as input to an Aws::Client method, you can use a vanilla Hash:

{
  enabled: false,
  sse_type: "AES256", # accepts AES256, KMS
  kms_master_key_id: "KMSMasterKeyId",
}

Represents the settings used to enable server-side encryption.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

Returns:

  • (Boolean) —

    Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK.

#kms_master_key_id ⇒ String

The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB customer master key alias/aws/dynamodb.

Returns:

  • (String) —

    The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption.

#sse_type ⇒ String

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account and is managed by AWS KMS (AWS KMS charges apply).

^

Possible values:

  • AES256
  • KMS

Returns:

  • (String) —

    Server-side encryption type.