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

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

Overview

Note:

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

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

Represents the settings used to enable server-side encryption.

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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)


6170
6171
6172
6173
6174
6175
# File 'lib/aws-sdk-dynamodb/types.rb', line 6170

class SSESpecification < Struct.new(
  :enabled,
  :sse_type,
  :kms_master_key_id)
  include Aws::Structure
end

#kms_master_key_idString

The KMS Customer 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 Customer Master Key alias/aws/dynamodb.

Returns:

  • (String)


6170
6171
6172
6173
6174
6175
# File 'lib/aws-sdk-dynamodb/types.rb', line 6170

class SSESpecification < Struct.new(
  :enabled,
  :sse_type,
  :kms_master_key_id)
  include Aws::Structure
end

#sse_typeString

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

  • ‘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).

^

Returns:

  • (String)


6170
6171
6172
6173
6174
6175
# File 'lib/aws-sdk-dynamodb/types.rb', line 6170

class SSESpecification < Struct.new(
  :enabled,
  :sse_type,
  :kms_master_key_id)
  include Aws::Structure
end