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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) for the ledger.

Returns:

  • (String) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#creation_date_time ⇒ Time

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) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#deletion_protection ⇒ Boolean

Specifies whether the ledger is protected from being deleted by any user. If not defined during 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 this parameter to false.

Returns:

  • (Boolean) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#encryption_description ⇒ Types::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). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Returns:



347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#name ⇒ String

The name of the ledger.

Returns:

  • (String) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#permissions_mode ⇒ String

The permissions mode of the ledger.

Returns:

  • (String) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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

#state ⇒ String

The current status of the ledger.

Returns:

  • (String) 


347
348
349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 347

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