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

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

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

Overview

Note:

When passing CreateLedgerRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "LedgerName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
  deletion_protection: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protection ⇒ Boolean

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.

#name ⇒ String

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

    The name of the ledger that you want to create.

#permissions_mode ⇒ String

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

Possible values:

  • ALLOW_ALL

Returns:

  • (String) —

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

#tags ⇒ Hash<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>) —

    The key-value pairs to add as tags to the ledger that you want to create.