Package software.amazon.awscdk.services.qldb

Class CfnLedger

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qldb.CfnLedger
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILedgerRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:41.554Z") @Stability(Stable) public class CfnLedger extends CfnResource implements IInspectable, ILedgerRef, ITaggable
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();

See Also:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnLedger

      @Stability(Stable) @NotNull public static Boolean isCfnLedger(@NotNull Object x)
      Checks whether the given object is a CfnLedger.

      Parameters:
      x - This parameter is required.

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getLedgerRef

      @Stability(Stable) @NotNull public LedgerReference getLedgerRef()
      A reference to a Ledger resource.
      Specified by:
      getLedgerRef in interface ILedgerRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getPermissionsMode

      @Stability(Stable) @NotNull public String getPermissionsMode()
      The permissions mode to assign to the ledger that you want to create.

    • setPermissionsMode

      @Stability(Stable) public void setPermissionsMode(@NotNull String value)
      The permissions mode to assign to the ledger that you want to create.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Specifies whether the ledger is protected from being deleted by any user.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      Specifies whether the ledger is protected from being deleted by any user.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Specifies whether the ledger is protected from being deleted by any user.

    • getKmsKey

      @Stability(Stable) @Nullable public String getKmsKey()
      The key in AWS Key Management Service ( AWS ) to use for encryption of data at rest in the ledger.

    • setKmsKey

      @Stability(Stable) public void setKmsKey(@Nullable String value)
      The key in AWS Key Management Service ( AWS ) to use for encryption of data at rest in the ledger.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the ledger that you want to create.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the ledger that you want to create.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.