Class CfnStream
The AWS::QLDB::Stream
resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger.
Inherited Members
Namespace: Amazon.CDK.AWS.QLDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStream : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStream
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html
CloudformationResource: AWS::QLDB::Stream
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(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 |
CfnStream(Construct, String, ICfnStreamProps) |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnStream(Construct, String, ICfnStreamProps)
public CfnStream(Construct scope, string id, ICfnStreamProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnStreamProps
Resource properties.
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
InclusiveStartTime
The inclusive start date and time from which to start streaming journal data.
public virtual string InclusiveStartTime { get; set; }
Property Value
System.String
KinesisConfiguration
The configuration settings of the Kinesis Data Streams destination for your stream request.
public virtual object KinesisConfiguration { get; set; }
Property Value
System.Object
LedgerName
The name of the ledger.
public virtual string LedgerName { get; set; }
Property Value
System.String
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
StreamName
The name that you want to assign to the QLDB journal stream.
public virtual string StreamName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>