StreamArgs class

The set of arguments for Stream. The set of arguments for Stream.

Constructors

StreamArgs({Input<String?>? exclusiveEndTime, required Input<String> inclusiveStartTime, required Input<StreamKinesisConfiguration> kinesisConfiguration, required Input<String> ledgerName, Input<String?>? region, required Input<String> roleArn, required Input<String> streamName, Input<Map<String, String>?>? tags})
Creates a new StreamArgs. exclusiveEndTime 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: "2019-06-13T21:36:34Z". inclusiveStartTime 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". 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 The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. ledgerName The name of the QLDB ledger. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn ARN of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource. streamName 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 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.
const
StreamArgs.fromMap(Map<String, dynamic> map)
factory

Properties

exclusiveEndTime → Input<String?>?
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: "2019-06-13T21:36:34Z".
final
hashCode → int
The hash code for this object.
no setterinherited
inclusiveStartTime → Input<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". 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.
final
kinesisConfiguration → Input<StreamKinesisConfiguration>
The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below.
final
ledgerName → Input<String>
The name of the QLDB ledger.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String>
ARN of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamName → Input<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 the Amazon QLDB Developer Guide.
final
tags → Input<Map<String, String>?>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited