Package software.amazon.awscdk.services.qldb

Class CfnLedger

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.qldb.CfnLedger
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:01.018Z") @Stability(Stable) public class CfnLedger extends CfnResource implements IInspectable
A CloudFormation AWS::QLDB::Ledger.

The AWS::QLDB::Ledger resource specifies a new Amazon Quantum Ledger Database (Amazon QLDB) ledger in your AWS account . Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. You can use QLDB to track all application data changes, and maintain a complete and verifiable history of changes over time.

For more information, see CreateLedger in the Amazon QLDB API Reference .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qldb.*;
 CfnLedger cfnLedger = CfnLedger.Builder.create(this, "MyCfnLedger")
         .permissionsMode("permissionsMode")
         // the properties below are optional
         .deletionProtection(false)
         .kmsKey("kmsKey")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLedger

      protected CfnLedger(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLedger

      protected CfnLedger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLedger

      @Stability(Stable) public CfnLedger(@NotNull Construct scope, @NotNull String id, @NotNull CfnLedgerProps props)
      Create a new AWS::QLDB::Ledger.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getPermissionsMode

      @Stability(Stable) @NotNull public 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.

    • setPermissionsMode

      @Stability(Stable) public void setPermissionsMode(@NotNull String value)
      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.

    • getDeletionProtection

      @Stability(Stable) @Nullable public 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 .

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      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 .

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      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 .

    • getKmsKey

      @Stability(Stable) @Nullable public String getKmsKey()
      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 .

    • setKmsKey

      @Stability(Stable) public void setKmsKey(@Nullable String value)
      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 .

    • getName

      @Stability(Stable) @Nullable public 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 .

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      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 .