Class CfnStream
Creates a Kinesis stream that captures and transports data records that are emitted from data sources.
Inherited Members
Namespace: Amazon.CDK.AWS.Kinesis
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStream : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStream
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For information about creating streams, see CreateStream in the Amazon Kinesis API Reference.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html
CloudformationResource: AWS::Kinesis::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.Kinesis;
var cfnStream = new CfnStream(this, "MyCfnStream", new CfnStreamProps {
Name = "name",
RetentionPeriodHours = 123,
ShardCount = 123,
StreamEncryption = new StreamEncryptionProperty {
EncryptionType = "encryptionType",
KeyId = "keyId"
},
StreamModeDetails = new StreamModeDetailsProperty {
StreamMode = "streamMode"
},
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 Kinesis stream, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | The name of the Kinesis stream. |
RetentionPeriodHours | The number of hours for the data records that are stored in shards to remain accessible. |
ShardCount | The number of shards that the stream uses. |
StreamEncryption | When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. |
StreamModeDetails | Specifies the capacity mode to which you want to set your data stream. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. |
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 = null)
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 Kinesis stream, such as arn:aws:kinesis:us-east-2:123456789012:stream/mystream
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
Name
The name of the Kinesis stream.
public virtual string Name { get; set; }
Property Value
System.String
RetentionPeriodHours
The number of hours for the data records that are stored in shards to remain accessible.
public virtual Nullable<double> RetentionPeriodHours { get; set; }
Property Value
System.Nullable<System.Double>
ShardCount
The number of shards that the stream uses.
public virtual Nullable<double> ShardCount { get; set; }
Property Value
System.Nullable<System.Double>
StreamEncryption
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
public virtual object StreamEncryption { get; set; }
Property Value
System.Object
StreamModeDetails
Specifies the capacity mode to which you want to set your data stream.
public virtual object StreamModeDetails { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
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>