/AWS1/CL_QLDLEDGERENCDESC

Information about the encryption of data at rest in an Amazon QLDB ledger. This includes the current status, the key in Key Management Service (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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_kmskeyarn TYPE /AWS1/QLDARN /AWS1/QLDARN

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 Amazon Web Services owned KMS key for encryption. It will display AWS_OWNED_KMS_KEY when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.

iv_encryptionstatus TYPE /AWS1/QLDENCRYPTIONSTATUS /AWS1/QLDENCRYPTIONSTATUS

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.

Optional arguments:

iv_inacciblekmskeydatetime TYPE /AWS1/QLDTIMESTAMP /AWS1/QLDTIMESTAMP

The date and time, in epoch time format, when the 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 KMS key is accessible.

---

Queryable Attributes

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 Amazon Web Services owned KMS key for encryption. It will display AWS_OWNED_KMS_KEY when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.

Accessible with the following methods

Method	Description
GET_KMSKEYARN()	Getter for KMSKEYARN, with configurable default
ASK_KMSKEYARN()	Getter for KMSKEYARN w/ exceptions if field has no value
HAS_KMSKEYARN()	Determine if KMSKEYARN has a value

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.

Accessible with the following methods

Method	Description
GET_ENCRYPTIONSTATUS()	Getter for ENCRYPTIONSTATUS, with configurable default
ASK_ENCRYPTIONSTATUS()	Getter for ENCRYPTIONSTATUS w/ exceptions if field has no va
HAS_ENCRYPTIONSTATUS()	Determine if ENCRYPTIONSTATUS has a value

InaccessibleKmsKeyDateTime

The date and time, in epoch time format, when the 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 KMS key is accessible.

Accessible with the following methods

Method	Description
GET_INACCIBLEKMSKEYDATETIME()	Getter for INACCESSIBLEKMSKEYDATETIME, with configurable def
ASK_INACCIBLEKMSKEYDATETIME()	Getter for INACCESSIBLEKMSKEYDATETIME w/ exceptions if field
HAS_INACCIBLEKMSKEYDATETIME()	Determine if INACCESSIBLEKMSKEYDATETIME has a value