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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) for the ledger.

Returns:

  • (String)


299
300
301
302
303
304
305
306
307
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 299

class DescribeLedgerResponse < Struct.new(
  :name,
  :arn,
  :state,
  :creation_date_time,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

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


299
300
301
302
303
304
305
306
307
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 299

class DescribeLedgerResponse < Struct.new(
  :name,
  :arn,
  :state,
  :creation_date_time,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

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


299
300
301
302
303
304
305
306
307
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 299

class DescribeLedgerResponse < Struct.new(
  :name,
  :arn,
  :state,
  :creation_date_time,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the ledger.

Returns:

  • (String)


299
300
301
302
303
304
305
306
307
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 299

class DescribeLedgerResponse < Struct.new(
  :name,
  :arn,
  :state,
  :creation_date_time,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The current status of the ledger.

Returns:

  • (String)


299
300
301
302
303
304
305
306
307
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 299

class DescribeLedgerResponse < Struct.new(
  :name,
  :arn,
  :state,
  :creation_date_time,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end