Package software.amazon.awscdk.services.qldb

Class CfnStream

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.CfnStream
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IStreamRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:46.625Z") @Stability(Stable) public class CfnStream extends CfnResource implements IInspectable, IStreamRef, ITaggable
The AWS::QLDB::Stream resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger.

The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

For more information, see StreamJournalToKinesis 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.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .inclusiveStartTime("inclusiveStartTime")
         .kinesisConfiguration(KinesisConfigurationProperty.builder()
                 .aggregationEnabled(false)
                 .streamArn("streamArn")
                 .build())
         .ledgerName("ledgerName")
         .roleArn("roleArn")
         .streamName("streamName")
         // the properties below are optional
         .exclusiveEndTime("exclusiveEndTime")
         .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

    • CfnStream

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

    • CfnStream

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

    • CfnStream

      @Stability(Stable) public CfnStream(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStreamProps props)
      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

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the QLDB journal stream.

      For example: arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique ID that QLDB assigns to each QLDB journal stream.

      For example: IiPT4brpZCqCq3f4MTHbYy .

    • getCfnProperties

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

    • getStreamRef

      @Stability(Stable) @NotNull public StreamReference getStreamRef()
      A reference to a Stream resource.
      Specified by:
      getStreamRef in interface IStreamRef

    • getTags

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

    • getInclusiveStartTime

      @Stability(Stable) @NotNull public String getInclusiveStartTime()
      The inclusive start date and time from which to start streaming journal data.

    • setInclusiveStartTime

      @Stability(Stable) public void setInclusiveStartTime(@NotNull String value)
      The inclusive start date and time from which to start streaming journal data.

    • getKinesisConfiguration

      @Stability(Stable) @NotNull public Object getKinesisConfiguration()
      The configuration settings of the Kinesis Data Streams destination for your stream request.

      Returns union: either IResolvable or CfnStream.KinesisConfigurationProperty

    • setKinesisConfiguration

      @Stability(Stable) public void setKinesisConfiguration(@NotNull IResolvable value)
      The configuration settings of the Kinesis Data Streams destination for your stream request.

    • setKinesisConfiguration

      @Stability(Stable) public void setKinesisConfiguration(@NotNull CfnStream.KinesisConfigurationProperty value)
      The configuration settings of the Kinesis Data Streams destination for your stream request.

    • getLedgerName

      @Stability(Stable) @NotNull public String getLedgerName()
      The name of the ledger.

    • setLedgerName

      @Stability(Stable) public void setLedgerName(@NotNull String value)
      The name of the ledger.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

    • getStreamName

      @Stability(Stable) @NotNull public String getStreamName()
      The name that you want to assign to the QLDB journal stream.

    • setStreamName

      @Stability(Stable) public void setStreamName(@NotNull String value)
      The name that you want to assign to the QLDB journal stream.

    • getExclusiveEndTime

      @Stability(Stable) @Nullable public String getExclusiveEndTime()
      The exclusive date and time that specifies when the stream ends.

    • setExclusiveEndTime

      @Stability(Stable) public void setExclusiveEndTime(@Nullable String value)
      The exclusive date and time that specifies when the stream ends.

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