Class: Aws::QLDB::Types::CreateLedgerRequest

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 CreateLedgerRequest data as a hash:

{
  name: "LedgerName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
  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)


100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 100

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

#nameString

The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Returns:

  • (String)


100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 100

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

#permissions_modeString

The permissions mode to assign to the ledger that you want to create.

Returns:

  • (String)


100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 100

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

#tagsHash<String,String>

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

  • (Hash<String,String>)


100
101
102
103
104
105
106
107
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/types.rb', line 100

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