Class CfnStream
A CloudFormation AWS::Kinesis::Stream
.
Inherited Members
Namespace: Amazon.CDK.AWS.Kinesis
Assembly: Amazon.CDK.AWS.Kinesis.dll
Syntax (csharp)
public class CfnStream : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStream
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates a Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see CreateStream in the Amazon Kinesis API Reference.
CloudformationResource: AWS::Kinesis::Stream
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-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.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(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 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 | 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(Construct, String, ICfnStreamProps)
Create a new AWS::Kinesis::Stream
.
public CfnStream(Construct scope, string id, ICfnStreamProps props = null)
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 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
Remarks
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
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>
Remarks
The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period in the Amazon Kinesis Developer Guide.
ShardCount
The number of shards that the stream uses.
public virtual Nullable<double> ShardCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For greater provisioned throughput, increase the number of shards.
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
Remarks
Removing this property from your stack template and updating your stack disables encryption.
StreamModeDetails
Specifies the capacity mode to which you want to set your data stream.
public virtual object StreamModeDetails { get; set; }
Property Value
System.Object
Remarks
Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
Tags
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
public virtual TagManager Tags { get; }
Property Value
Remarks
For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .
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>