StreamArgs

data class StreamArgs(val exclusiveEndTime: Output<String>? = null, val inclusiveStartTime: Output<String>? = null, val kinesisConfiguration: Output<StreamKinesisConfigurationArgs>? = null, val ledgerName: Output<String>? = null, val roleArn: Output<String>? = null, val streamName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<StreamArgs>

Resource schema for AWS::QLDB::Stream.

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(exclusiveEndTime: Output<String>? = null, inclusiveStartTime: Output<String>? = null, kinesisConfiguration: Output<StreamKinesisConfigurationArgs>? = null, ledgerName: Output<String>? = null, roleArn: Output<String>? = null, streamName: Output<String>? = null, tags: Output<List<TagArgs>>? = null)

Properties

Link copied to clipboard
val exclusiveEndTime: Output<String>? = null

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 .

Link copied to clipboard
val inclusiveStartTime: Output<String>? = null

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 .

Link copied to clipboard

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

Link copied to clipboard
val ledgerName: Output<String>? = null

The name of the ledger.

Link copied to clipboard
val roleArn: Output<String>? = null

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.

Link copied to clipboard
val streamName: Output<String>? = null

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 .

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): StreamArgs