Struct aws_sdk_qldb::output::DescribeLedgerOutput

#[non_exhaustive]
pub struct DescribeLedgerOutput {
    pub name: Option<String>,
    pub arn: Option<String>,
    pub state: Option<LedgerState>,
    pub creation_date_time: Option<DateTime>,
    pub permissions_mode: Option<PermissionsMode>,
    pub deletion_protection: Option<bool>,
    pub encryption_description: Option<LedgerEncryptionDescription>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the ledger.

arn: Option<String>

The Amazon Resource Name (ARN) for the ledger.

state: Option<LedgerState>

The current status of the ledger.

creation_date_time: Option<DateTime>

The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

permissions_mode: Option<PermissionsMode>

The permissions mode of the ledger.

deletion_protection: Option<bool>

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

encryption_description: Option<LedgerEncryptionDescription>

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

Implementations

impl DescribeLedgerOutput

pub fn name(&self) -> Option<&str>

The name of the ledger.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the ledger.

pub fn state(&self) -> Option<&LedgerState>

The current status of the ledger.

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

The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

pub fn permissions_mode(&self) -> Option<&PermissionsMode>

The permissions mode of the ledger.

pub fn deletion_protection(&self) -> Option<bool>

The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set the flag to false.

pub fn encryption_description(&self) -> Option<&LedgerEncryptionDescription>

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

impl DescribeLedgerOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeLedgerOutput

Trait Implementations

impl Clone for DescribeLedgerOutput

fn clone(&self) -> DescribeLedgerOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeLedgerOutput

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

Formats the value using the given formatter.

impl PartialEq<DescribeLedgerOutput> for DescribeLedgerOutput

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

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

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

This method tests for !=.

impl StructuralPartialEq for DescribeLedgerOutput