Class CfnStream
A CloudFormation AWS::QLDB::Stream
.
Inherited Members
Namespace: Amazon.CDK.AWS.QLDB
Assembly: Amazon.CDK.AWS.QLDB.dll
Syntax (csharp)
public class CfnStream : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStream
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::QLDB::Stream
resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
For more information, see StreamJournalToKinesis in the Amazon QLDB API Reference .
CloudformationResource: AWS::QLDB::Stream
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 cfnStream = new CfnStream(this, "MyCfnStream", 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
Constructors
CfnStream(Construct, String, ICfnStreamProps) | Create a new |
CfnStream(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStream(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the QLDB journal stream. |
AttrId | The unique ID that QLDB assigns to each QLDB journal stream. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStream(Construct, String, ICfnStreamProps)
Create a new AWS::QLDB::Stream
.
public CfnStream(Construct scope, string id, ICfnStreamProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnStreamProps
- resource properties.
CfnStream(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStream(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStream(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStream(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the QLDB journal stream.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy
.
CloudformationAttribute: Arn
AttrId
The unique ID that QLDB assigns to each QLDB journal stream.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example: IiPT4brpZCqCq3f4MTHbYy
.
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ExclusiveEndTime
The exclusive date and time that specifies when the stream ends.
public virtual string ExclusiveEndTime { get; set; }
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.
public virtual string InclusiveStartTime { get; set; }
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.
public virtual object KinesisConfiguration { get; set; }
Property Value
System.Object
Remarks
LedgerName
The name of the ledger.
public virtual string LedgerName { get; set; }
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.
public virtual string RoleArn { get; set; }
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.
public virtual string StreamName { get; set; }
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 .
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>