amazonka-keyspaces-2.0: Amazon Keyspaces SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KeySpaces.Types.EncryptionSpecification

Description

 
Synopsis

Documentation

data EncryptionSpecification Source #

Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):

• Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).

• Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).

For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest in the Amazon Keyspaces Developer Guide.

For more information about KMS, see KMS management service concepts in the Key Management Service Developer Guide.

See: newEncryptionSpecification smart constructor.

Constructors

EncryptionSpecification' 

Fields

  • kmsKeyIdentifier :: Maybe Text

    The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

  • type' :: EncryptionType

    The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

    type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

    type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

    The default is type:AWS_OWNED_KMS_KEY.

    For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

Instances

Instances details
FromJSON EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

ToJSON EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

Generic EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

Associated Types

type Rep EncryptionSpecification :: Type -> Type #

Read EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

Show EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

NFData EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

Methods

rnf :: EncryptionSpecification -> () #

Eq EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

Hashable EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

type Rep EncryptionSpecification Source # 
Instance details

Defined in Amazonka.KeySpaces.Types.EncryptionSpecification

type Rep EncryptionSpecification = D1 ('MetaData "EncryptionSpecification" "Amazonka.KeySpaces.Types.EncryptionSpecification" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "EncryptionSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType)))

newEncryptionSpecification Source #

Create a value of EncryptionSpecification 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:kmsKeyIdentifier:EncryptionSpecification', encryptionSpecification_kmsKeyIdentifier - The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

$sel:type':EncryptionSpecification', encryptionSpecification_type - The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

encryptionSpecification_kmsKeyIdentifier :: Lens' EncryptionSpecification (Maybe Text) Source #

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

encryptionSpecification_type :: Lens' EncryptionSpecification EncryptionType Source #

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.