Struct aws_sdk_qldb::types::builders::LedgerEncryptionDescriptionBuilder

#[non_exhaustive]
pub struct LedgerEncryptionDescriptionBuilder { /* private fields */ }

A builder for LedgerEncryptionDescription.

Implementations

impl LedgerEncryptionDescriptionBuilder

pub fn kms_key_arn(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_kms_key_arn(self, input: Option<String>) -> Self

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.

pub fn get_kms_key_arn(&self) -> &Option<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.

pub fn encryption_status(self, input: EncryptionStatus) -> Self

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.

This field is required.

pub fn set_encryption_status(self, input: Option<EncryptionStatus>) -> Self

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.

pub fn get_encryption_status(&self) -> &Option<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.

pub fn inaccessible_kms_key_date_time(self, input: DateTime) -> Self

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.

pub fn set_inaccessible_kms_key_date_time(self, input: Option<DateTime>) -> Self

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.

pub fn get_inaccessible_kms_key_date_time(&self) -> &Option<DateTime>

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.

pub fn build(self) -> Result<LedgerEncryptionDescription, BuildError>

Consumes the builder and constructs a LedgerEncryptionDescription. This method will fail if any of the following fields are not set:

• kms_key_arn
• encryption_status

Trait Implementations

impl Clone for LedgerEncryptionDescriptionBuilder

fn clone(&self) -> LedgerEncryptionDescriptionBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LedgerEncryptionDescriptionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LedgerEncryptionDescriptionBuilder

fn default() -> LedgerEncryptionDescriptionBuilder

Returns the “default value” for a type.

impl PartialEq for LedgerEncryptionDescriptionBuilder

fn eq(&self, other: &LedgerEncryptionDescriptionBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LedgerEncryptionDescriptionBuilder