software.amazon.awssdk.services.qldb.model

Interface CreateLedgerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>, QldbRequest.Builder, SdkBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateLedgerRequest

public static interface CreateLedgerRequest.Builder
extends QldbRequest.Builder, SdkPojo, CopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>

Method Summary

Modifier and Type	Method and Description
CreateLedgerRequest.Builder	deletionProtection(Boolean deletionProtection) The flag that prevents a ledger from being deleted by any user.
CreateLedgerRequest.Builder	kmsKey(String kmsKey) The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger.
CreateLedgerRequest.Builder	name(String name) The name of the ledger that you want to create.
CreateLedgerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateLedgerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateLedgerRequest.Builder	permissionsMode(PermissionsMode permissionsMode) The permissions mode to assign to the ledger that you want to create.
CreateLedgerRequest.Builder	permissionsMode(String permissionsMode) The permissions mode to assign to the ledger that you want to create.
CreateLedgerRequest.Builder	tags(Map<String,String> tags) The key-value pairs to add as tags to the ledger that you want to create.

Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateLedgerRequest.Builder name(String name)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateLedgerRequest.Builder tags(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

permissionsMode

CreateLedgerRequest.Builder permissionsMode(String permissionsMode)

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.

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

permissionsMode

CreateLedgerRequest.Builder permissionsMode(PermissionsMode permissionsMode)

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.

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

deletionProtection

CreateLedgerRequest.Builder deletionProtection(Boolean deletionProtection)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKey

CreateLedgerRequest.Builder kmsKey(String kmsKey)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateLedgerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateLedgerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.