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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/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.

Constant Summary collapse

SENSITIVE =
[]

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)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7224

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

#kms_master_key_idString

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)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7224

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

#sse_typeString

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

^

Returns:

  • (String)


7224
7225
7226
7227
7228
7229
7230
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 7224

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