CfnStreamProps
- class aws_cdk.aws_qldb.CfnStreamProps(*, inclusive_start_time, kinesis_configuration, ledger_name, role_arn, stream_name, exclusive_end_time=None, tags=None)
Bases:
object
Properties for defining a
CfnStream
.- Parameters:
inclusive_start_time (
str
) – The inclusive start date and time from which to start streaming journal data. This parameter must be inISO 8601
date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z
. TheInclusiveStartTime
cannot be in the future and must be beforeExclusiveEndTime
. If you provide anInclusiveStartTime
that is before the ledger’sCreationDateTime
, QLDB effectively defaults it to the ledger’sCreationDateTime
.kinesis_configuration (
Union
[IResolvable
,KinesisConfigurationProperty
,Dict
[str
,Any
]]) – The configuration settings of the Kinesis Data Streams destination for your stream request.ledger_name (
str
) – The name of the ledger.role_arn (
str
) – 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 theiam:PassRole
action on the IAM role resource. This is required for all journal stream requests.stream_name (
str
) – 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 .exclusive_end_time (
Optional
[str
]) – 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. TheExclusiveEndTime
must be inISO 8601
date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_qldb as qldb cfn_stream_props = qldb.CfnStreamProps( inclusive_start_time="inclusiveStartTime", kinesis_configuration=qldb.CfnStream.KinesisConfigurationProperty( aggregation_enabled=False, stream_arn="streamArn" ), ledger_name="ledgerName", role_arn="roleArn", stream_name="streamName", # the properties below are optional exclusive_end_time="exclusiveEndTime", tags=[CfnTag( key="key", value="value" )] )
Attributes
- exclusive_end_time
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 inISO 8601
date and time format and in Universal Coordinated Time (UTC). For example:2019-06-13T21:36:34Z
.
- inclusive_start_time
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 beforeExclusiveEndTime
.If you provide an
InclusiveStartTime
that is before the ledger’sCreationDateTime
, QLDB effectively defaults it to the ledger’sCreationDateTime
.
- kinesis_configuration
The configuration settings of the Kinesis Data Streams destination for your stream request.
- ledger_name
The name of the ledger.
- role_arn
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.
- stream_name
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 .