Class: Aws::QLDB::Types::LedgerEncryptionDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qldb/types.rb

Overview

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

[1]: docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_status ⇒ String

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.

Returns:

  • (String) 


854
855
856
857
858
859
860
 
# File 'lib/aws-sdk-qldb/types.rb', line 854

class LedgerEncryptionDescription < Struct.new(
  :kms_key_arn,
  :encryption_status,
  :inaccessible_kms_key_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#inaccessible_kms_key_date_time ⇒ Time

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.

Returns:

  • (Time) 


854
855
856
857
858
859
860
 
# File 'lib/aws-sdk-qldb/types.rb', line 854

class LedgerEncryptionDescription < Struct.new(
  :kms_key_arn,
  :encryption_status,
  :inaccessible_kms_key_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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.

Returns:

  • (String) 


854
855
856
857
858
859
860
 
# File 'lib/aws-sdk-qldb/types.rb', line 854

class LedgerEncryptionDescription < Struct.new(
  :kms_key_arn,
  :encryption_status,
  :inaccessible_kms_key_date_time)
  SENSITIVE = []
  include Aws::Structure
end