QLDB / Client / create_ledger

create_ledger#

QLDB.Client.create_ledger(**kwargs)#

Creates a new ledger in your Amazon Web Services account in the current Region.

See also: AWS API Documentation

Request Syntax

response = client.create_ledger(
    Name='string',
    Tags={
        'string': 'string'
    },
    PermissionsMode='ALLOW_ALL'|'STANDARD',
    DeletionProtection=True|False,
    KmsKey='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

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

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

  • Tags (dict) –

    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.

    • (string) –

      • (string) –

  • PermissionsMode (string) –

    [REQUIRED]

    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 in the Amazon QLDB Developer Guide.

    Note

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

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

  • KmsKey (string) –

    The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see Encryption at rest in the Amazon QLDB Developer Guide.

    Use one of the following options to specify this parameter:

    • AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.

    • Undefined: By default, use an Amazon Web Services owned KMS key.

    • A valid symmetric customer managed KMS key: Use the specified KMS key in your account that you create, own, and manage. Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

    To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

    • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

    • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Alias name: alias/ExampleAlias

    • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

    For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Arn': 'string',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
    'CreationDateTime': datetime(2015, 1, 1),
    'PermissionsMode': 'ALLOW_ALL'|'STANDARD',
    'DeletionProtection': True|False,
    'KmsKeyArn': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the ledger.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the ledger.

    • State (string) –

      The current status of the ledger.

    • CreationDateTime (datetime) –

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

    • PermissionsMode (string) –

      The permissions mode of the ledger that you created.

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

    • KmsKeyArn (string) –

      The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Exceptions

  • QLDB.Client.exceptions.InvalidParameterException

  • QLDB.Client.exceptions.ResourceAlreadyExistsException

  • QLDB.Client.exceptions.LimitExceededException

  • QLDB.Client.exceptions.ResourceInUseException