Skip to content

Resource: awsQldbStream

Provides an AWS Quantum Ledger Database (QLDB) Stream resource

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.qldbStream.QldbStream(this, "example", {
  inclusiveStartTime: "2021-01-01T00:00:00Z",
  kinesisConfiguration: {
    aggregationEnabled: false,
    streamArn:
      "arn:aws:kinesis:us-east-1:xxxxxxxxxxxx:stream/example-kinesis-stream",
  },
  ledgerName: "existing-ledger-name",
  roleArn: "sample-role-arn",
  streamName: "sample-ledger-stream",
  tags: {
    example: "tag",
  },
});

Argument Reference

The following arguments are supported:

  • exclusiveEndTime - (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. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: "20190613T21:36:34Z".
  • inclusiveStartTime - (Required) 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: "20190613T21:36:34Z". This cannot be in the future and must be before exclusiveEndTime. If you provide a value that is before the ledger's creationDateTime, QLDB effectively defaults it to the ledger's creationDateTime.
  • kinesisConfiguration - (Required) The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
  • ledgerName - (Required) The name of the QLDB ledger.
  • roleArn - (Required) 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 - (Required) 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 the Amazon QLDB Developer Guide.
  • tags - (Optional) Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

kinesisConfiguration

The kinesisConfiguration block supports the following arguments:

  • aggregationEnabled - (Optional) Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default: true.
  • streamArn - (Required) The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the QLDB Stream.
  • arn - The ARN of the QLDB Stream.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.