NAME

Paws::QLDB::CreateLedger - Arguments for method CreateLedger on Paws::QLDB

DESCRIPTION

This class represents the parameters used for calling the method CreateLedger on the Amazon QLDB service. Use the attributes of this class as arguments to method CreateLedger.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLedger.

SYNOPSIS

my $qldb = Paws->service('QLDB');
my $CreateLedgerResponse = $qldb->CreateLedger(
  Name               => 'MyLedgerName',
  PermissionsMode    => 'ALLOW_ALL',
  DeletionProtection => 1,                # OPTIONAL
  Tags               => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
);

# Results:
my $Arn                = $CreateLedgerResponse->Arn;
my $CreationDateTime   = $CreateLedgerResponse->CreationDateTime;
my $DeletionProtection = $CreateLedgerResponse->DeletionProtection;
my $Name               = $CreateLedgerResponse->Name;
my $PermissionsMode    = $CreateLedgerResponse->PermissionsMode;
my $State              = $CreateLedgerResponse->State;

# Returns a L<Paws::QLDB::CreateLedgerResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/qldb/CreateLedger

ATTRIBUTES

DeletionProtection => Bool

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. You can disable it by calling the UpdateLedger operation to set the flag to false.

REQUIRED Name => Str

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 (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the Amazon QLDB Developer Guide.

REQUIRED PermissionsMode => Str

The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values:

• ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for ledgers.

  This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.

• STANDARD: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.

  By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started with the standard permissions mode (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) in the Amazon QLDB Developer Guide.

We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data.

Valid values are: "ALLOW_ALL", "STANDARD"

Tags => Paws::QLDB::Tags

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateLedger in Paws::QLDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues