You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::QLDB::Types::DescribeLedgerResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) for the ledger.

Returns:

  • (String)

    The Amazon Resource Name (ARN) for the ledger.

#creation_date_timeTime

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

Returns:

  • (Time)

    The date and time, in epoch time format, when the ledger was created.

#deletion_protectionBoolean

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 using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Returns:

  • (Boolean)

    The flag that prevents a ledger from being deleted by any user.

#nameString

The name of the ledger.

Returns:

  • (String)

    The name of the ledger.

#stateString

The current status of the ledger.

Possible values:

  • CREATING
  • ACTIVE
  • DELETING
  • DELETED

Returns:

  • (String)

    The current status of the ledger.