Interface ICfnStreamProps
Properties for defining a CfnStream
.
Namespace: Amazon.CDK.AWS.Kinesis
Assembly: Amazon.CDK.AWS.Kinesis.dll
Syntax (csharp)
public interface ICfnStreamProps
Syntax (vb)
Public Interface ICfnStreamProps
Remarks
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 cfnStreamProps = 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
Properties
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. |
Properties
Name
The name of the Kinesis stream.
virtual string Name { get; }
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.
virtual Nullable<double> RetentionPeriodHours { get; }
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.
virtual Nullable<double> ShardCount { get; }
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.
virtual object StreamEncryption { get; }
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.
virtual object StreamModeDetails { get; }
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.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .