interface CfnStreamProps

Language	Type name
.NET	`Amazon.CDK.AWS.QLDB.CfnStreamProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsqldb#CfnStreamProps`
Java	`software.amazon.awscdk.services.qldb.CfnStreamProps`
Python	`aws_cdk.aws_qldb.CfnStreamProps`
TypeScript	`aws-cdk-lib` » `aws_qldb` » `CfnStreamProps`

Properties for defining a CfnStream.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qldb as qldb } from 'aws-cdk-lib';
const cfnStreamProps: qldb.CfnStreamProps = {
  inclusiveStartTime: 'inclusiveStartTime',
  kinesisConfiguration: {
    aggregationEnabled: false,
    streamArn: 'streamArn',
  },
  ledgerName: 'ledgerName',
  roleArn: 'roleArn',
  streamName: 'streamName',

  // the properties below are optional
  exclusiveEndTime: 'exclusiveEndTime',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
inclusiveStartTime	`string`	The inclusive start date and time from which to start streaming journal data.
kinesisConfiguration	`IResolvable` `\|` `KinesisConfigurationProperty`	The configuration settings of the Kinesis Data Streams destination for your stream request.
ledgerName	`string`	The name of the ledger.
roleArn	`string`	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.
streamName	`string`	The name that you want to assign to the QLDB journal stream.
exclusiveEndTime?	`string`	The exclusive date and time that specifies when the stream ends.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

inclusiveStartTime

Type: string

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 .

kinesisConfiguration

Type: IResolvable | KinesisConfigurationProperty

The configuration settings of the Kinesis Data Streams destination for your stream request.

ledgerName

Type: string

The name of the ledger.

roleArn

Type: string

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.

streamName

Type: string

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 .

exclusiveEndTime?

Type: string (optional)

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 .

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .