Class: Aws::QLDB::Types::UpdateLedgerRequest

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

Overview

Note:

When making an API call, you may pass UpdateLedgerRequest data as a hash:

{
  name: "LedgerName", # required
  deletion_protection: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


1471
1472
1473
1474
1475
1476
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1471

class UpdateLedgerRequest < Struct.new(
  :name,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the ledger.

Returns:

  • (String)


1471
1472
1473
1474
1475
1476
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 1471

class UpdateLedgerRequest < Struct.new(
  :name,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end