Package software.amazon.awscdk.services.qldb

Class CfnStream

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.CfnStream
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.023Z") @Stability(Stable) public class CfnStream extends CfnResource implements IInspectable
A CloudFormation AWS::QLDB::Stream.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnStreamProps props)
      Create a new AWS::QLDB::Stream.

      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.

    • 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

    • getTags

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

      For more information, see Tag .

    • getInclusiveStartTime

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

      This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .

      The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime .

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime , QLDB effectively defaults it to the ledger's CreationDateTime .

    • setInclusiveStartTime

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

      This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .

      The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime .

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime , QLDB effectively defaults it to the ledger's CreationDateTime .

    • getKinesisConfiguration

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

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

      To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

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

      To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.

    • getStreamName

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

      User-defined names can help identify and indicate the purpose of a stream.

      Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .

    • setStreamName

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

      User-defined names can help identify and indicate the purpose of a stream.

      Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .

    • getExclusiveEndTime

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

      If you don't define this parameter, the stream runs indefinitely until you cancel it.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .

    • setExclusiveEndTime

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

      If you don't define this parameter, the stream runs indefinitely until you cancel it.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .