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

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.

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)


5886
5887
5888
5889
5890
5891
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5886

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

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


5886
5887
5888
5889
5890
5891
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5886

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

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

Returns:

  • (String)


5886
5887
5888
5889
5890
5891
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5886

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