Skip to content

EncryptionSpecification

Used by
Source code in docs_src/capo_keyspaces/types/encryption_specification.py 
14
15
16
17
18
class EncryptionSpecification(TypedDict, closed=True):
    type: "capo_keyspaces.types.encryption_type.EncryptionType"
    """<p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    kms_key_identifier: NotRequired["capo_keyspaces.types.kms_key_arn.kmsKeyARN"]
    """<p>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</p>"""

kms_key_identifier instance-attribute 

kms_key_identifier: NotRequired[kmsKeyARN]

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

type instance-attribute 

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.