Amazonka.DynamoDB.Types.SSESpecification

Documentation

data SSESpecification

Represents the settings used to enable server-side encryption.

See: newSSESpecification smart constructor.

Constructors

SSESpecification'

Fields

• enabled :: Maybe Bool

  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.

• kmsMasterKeyId :: Maybe Text

  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.

• sSEType :: Maybe SSEType

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

Instances

FromJSON SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

parseJSON :: Value -> Parser SSESpecification

parseJSONList :: Value -> Parser [SSESpecification]

ToJSON SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

toJSON :: SSESpecification -> Value

toEncoding :: SSESpecification -> Encoding

toJSONList :: [SSESpecification] -> Value

toEncodingList :: [SSESpecification] -> Encoding

Generic SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Associated Types

type Rep SSESpecification :: Type -> Type

Methods

from :: SSESpecification -> Rep SSESpecification x

to :: Rep SSESpecification x -> SSESpecification

Read SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

readsPrec :: Int -> ReadS SSESpecification

readList :: ReadS [SSESpecification]

readPrec :: ReadPrec SSESpecification

readListPrec :: ReadPrec [SSESpecification]

Show SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

showsPrec :: Int -> SSESpecification -> ShowS

show :: SSESpecification -> String

showList :: [SSESpecification] -> ShowS

NFData SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

rnf :: SSESpecification -> ()

Eq SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

(==) :: SSESpecification -> SSESpecification -> Bool

(/=) :: SSESpecification -> SSESpecification -> Bool

Hashable SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

Methods

hashWithSalt :: Int -> SSESpecification -> Int

hash :: SSESpecification -> Int

type Rep SSESpecification

Defined in Amazonka.DynamoDB.Types.SSESpecification

type Rep SSESpecification = D1 ('MetaData "SSESpecification" "Amazonka.DynamoDB.Types.SSESpecification" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "SSESpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "kmsMasterKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sSEType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSEType)))))

newSSESpecification :: SSESpecification

Create a value of SSESpecification with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:enabled:SSESpecification', sSESpecification_enabled - 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.

$sel:kmsMasterKeyId:SSESpecification', sSESpecification_kmsMasterKeyId - 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.

$sel:sSEType:SSESpecification', sSESpecification_sSEType - 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).

sSESpecification_enabled :: Lens' SSESpecification (Maybe Bool)

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.

sSESpecification_kmsMasterKeyId :: Lens' SSESpecification (Maybe Text)

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.

sSESpecification_sSEType :: Lens' SSESpecification (Maybe SSEType)

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