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:

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

Returns:

  • (Boolean)

    Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.

#kms_master_key_idString

The KMS Master Key (CMK) which should be used for the 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 KMS Master Key alias/aws/dynamodb.

Returns:

  • (String)

    The KMS Master Key (CMK) which should be used for the KMS encryption.

#sse_typeString

Server-side encryption type:

  • AES256 - Server-side encryption which uses the AES256 algorithm (not applicable).

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

    Possible values:

    • AES256
    • KMS

Returns:

  • (String)

    Server-side encryption type:.