software.amazon.awscdk.services.qldb

Class CfnLedger.Builder

java.lang.Object

software.amazon.awscdk.services.qldb.CfnLedger.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLedger>

Enclosing class:

CfnLedger

@Stability(value=Stable)
public static final class CfnLedger.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLedger>

A fluent builder for CfnLedger.

Method Summary

Modifier and Type	Method and Description
CfnLedger	build()
static CfnLedger.Builder	create(software.constructs.Construct scope, String id)
CfnLedger.Builder	deletionProtection(Boolean deletionProtection) Specifies whether the ledger is protected from being deleted by any user.
CfnLedger.Builder	deletionProtection(IResolvable deletionProtection) Specifies whether the ledger is protected from being deleted by any user.
CfnLedger.Builder	kmsKey(String kmsKey) The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.
CfnLedger.Builder	name(String name) The name of the ledger that you want to create.
CfnLedger.Builder	permissionsMode(String permissionsMode) The permissions mode to assign to the ledger that you want to create.
CfnLedger.Builder	tags(List<? extends CfnTag> tags) An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnLedger.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLedger.Builder.

permissionsMode

@Stability(value=Stable)
public CfnLedger.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 is required.

Returns:

this

deletionProtection

@Stability(value=Stable)
public CfnLedger.Builder deletionProtection(Boolean deletionProtection)

Specifies whether the ledger is protected from being deleted by any user.

If not defined during 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 parameter to false .

Parameters:

deletionProtection - Specifies whether the ledger is protected from being deleted by any user. This parameter is required.

Returns:

this

deletionProtection

@Stability(value=Stable)
public CfnLedger.Builder deletionProtection(IResolvable deletionProtection)

Specifies whether the ledger is protected from being deleted by any user.

If not defined during 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 parameter to false .

Parameters:

deletionProtection - Specifies whether the ledger is protected from being deleted by any user. This parameter is required.

Returns:

this

kmsKey

@Stability(value=Stable)
public CfnLedger.Builder kmsKey(String kmsKey)

The key in AWS Key Management Service ( AWS 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 AWS KMS key that is owned and managed by AWS on your behalf.
• Undefined : By default, use an AWS owned KMS key.
• A valid symmetric customer managed KMS key : Use the specified symmetric encryption 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 AWS 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 AWS 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 AWS Key Management Service Developer Guide .

Parameters:

kmsKey - The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnLedger.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 AWS 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. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnLedger.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnLedger build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLedger>