Interface ICfnStreamMixinProps

Properties for CfnStreamPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QLDB

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnStreamMixinProps

Syntax (vb)

Public Interface ICfnStreamMixinProps

Remarks

See: 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.CfnPropertyMixins.AWS.QLDB;

             var cfnStreamMixinProps = new CfnStreamMixinProps {
                 ExclusiveEndTime = "exclusiveEndTime",
                 InclusiveStartTime = "inclusiveStartTime",
                 KinesisConfiguration = new KinesisConfigurationProperty {
                     AggregationEnabled = false,
                     StreamArn = "streamArn"
                 },
                 LedgerName = "ledgerName",
                 RoleArn = "roleArn",
                 StreamName = "streamName",
                 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.

string? ExclusiveEndTime { get; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-exclusiveendtime

InclusiveStartTime

The inclusive start date and time from which to start streaming journal data.

string? InclusiveStartTime { get; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-inclusivestarttime

KinesisConfiguration

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

object? KinesisConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-kinesisconfiguration

Type union: either IResolvable or CfnStreamPropsMixin.IKinesisConfigurationProperty

LedgerName

The name of the ledger.

string? LedgerName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-ledgername

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.

object? RoleArn { get; }

Property Value

object

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-rolearn

Type union: either string or IRoleRef

StreamName

The name that you want to assign to the QLDB journal stream.

string? StreamName { get; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html#cfn-qldb-stream-streamname