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 Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

Returns:

  • (Boolean)


8131
8132
8133
8134
8135
8136
8137
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8131

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

#kms_master_key_idString

The KMS key that should be used for the KMS encryption. To specify a key, 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 key alias/aws/dynamodb.

Returns:

  • (String)


8131
8132
8133
8134
8135
8136
8137
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8131

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 Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

^

Returns:

  • (String)


8131
8132
8133
8134
8135
8136
8137
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8131

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