Package software.amazon.awscdk.cfnpropertymixins.services.qldb

Interface CfnLedgerMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLedgerMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.467Z")
@Stability(Stable)
public interface CfnLedgerMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnLedgerPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.qldb.*;
 CfnLedgerMixinProps cfnLedgerMixinProps = CfnLedgerMixinProps.builder()
         .deletionProtection(false)
         .kmsKey("kmsKey")
         .name("name")
         .permissionsMode("permissionsMode")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLedgerMixinProps.Builder	A builder for CfnLedgerMixinProps
static final class	CfnLedgerMixinProps.Jsii$Proxy	An implementation for CfnLedgerMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnLedgerMixinProps.Builder	builder()
default Object	getDeletionProtection()	Specifies whether the ledger is protected from being deleted by any user.
default String	getKmsKey()	The key in AWS Key Management Service ( AWS ) to use for encryption of data at rest in the ledger.
default String	getName()	The name of the ledger that you want to create.
default String	getPermissionsMode()	The permissions mode to assign to the ledger that you want to create.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

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 this parameter to false .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-deletionprotection

getKmsKey

@Stability(Stable)
@Nullable
default String getKmsKey()

The key in AWS Key Management Service ( AWS ) 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 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-kmskey

getName

@Stability(Stable)
@Nullable
default String getName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-name

getPermissionsMode

@Stability(Stable)
@Nullable
default String getPermissionsMode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-permissionsmode

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html#cfn-qldb-ledger-tags

builder

@Stability(Stable)
static CfnLedgerMixinProps.Builder builder()

Returns:

a CfnLedgerMixinProps.Builder of CfnLedgerMixinProps