Interface ICfnStreamProps
Properties for defining a CfnStream
.
Namespace: Amazon.CDK.AWS.QLDB
Assembly: Amazon.CDK.AWS.QLDB.dll
Syntax (csharp)
public interface ICfnStreamProps
Syntax (vb)
Public Interface ICfnStreamProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QLDB;
var cfnStreamProps = new CfnStreamProps {
InclusiveStartTime = "inclusiveStartTime",
KinesisConfiguration = new KinesisConfigurationProperty {
AggregationEnabled = false,
StreamArn = "streamArn"
},
LedgerName = "ledgerName",
RoleArn = "roleArn",
StreamName = "streamName",
// the properties below are optional
ExclusiveEndTime = "exclusiveEndTime",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
ExclusiveEndTime | The exclusive date and time that specifies when the stream ends. |
InclusiveStartTime | The inclusive start date and time from which to start streaming journal data. |
KinesisConfiguration | The configuration settings of the Kinesis Data Streams destination for your stream request. |
LedgerName | The name of the ledger. |
RoleArn | 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 | The name that you want to assign to the QLDB journal stream. |
Tags | An array of key-value pairs to apply to this resource. |
Properties
ExclusiveEndTime
The exclusive date and time that specifies when the stream ends.
virtual string ExclusiveEndTime { get; }
Property Value
System.String
Remarks
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
.
InclusiveStartTime
The inclusive start date and time from which to start streaming journal data.
string InclusiveStartTime { get; }
Property Value
System.String
Remarks
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
The configuration settings of the Kinesis Data Streams destination for your stream request.
object KinesisConfiguration { get; }
Property Value
System.Object
Remarks
LedgerName
The name of the ledger.
string LedgerName { get; }
Property Value
System.String
Remarks
RoleArn
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.
string RoleArn { get; }
Property Value
System.String
Remarks
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
The name that you want to assign to the QLDB journal stream.
string StreamName { get; }
Property Value
System.String
Remarks
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 .