LedgerEncryptionDescription - Amazon Quantum Ledger Database (Amazon QLDB)

LedgerEncryptionDescription

Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in AWS Key Management Service (AWS KMS), and when the key became inaccessible (in the case of an error).

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

Contents

EncryptionStatus

The current state of encryption at rest for the ledger. This can be one of the following values:

  • ENABLED: Encryption is fully enabled using the specified key.

  • UPDATING: The ledger is actively processing the specified key change.

    Key changes in QLDB are asynchronous. The ledger is fully accessible without any performance impact while the key change is being processed. The amount of time it takes to update a key varies depending on the ledger size.

  • KMS_KEY_INACCESSIBLE: The specified customer managed KMS key is not accessible, and the ledger is impaired. Either the key was disabled or deleted, or the grants on the key were revoked. When a ledger is impaired, it is not accessible and does not accept any read or write requests.

    An impaired ledger automatically returns to an active state after you restore the grants on the key, or re-enable the key that was disabled. However, deleting a customer managed KMS key is irreversible. After a key is deleted, you can no longer access the ledgers that are protected with that key, and the data becomes unrecoverable permanently.

Type: String

Valid Values: ENABLED | UPDATING | KMS_KEY_INACCESSIBLE

Required: Yes

InaccessibleKmsKeyDateTime

The date and time, in epoch time format, when the AWS KMS key first became inaccessible, in the case of an error. (Epoch time format is the number of seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.)

This parameter is undefined if the AWS KMS key is accessible.

Type: Timestamp

Required: No

KmsKeyArn

The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an AWS owned KMS key for encryption.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: