Interface IStreamProps
Properties for a Kinesis Stream.
Namespace: Amazon.CDK.AWS.Kinesis
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStreamProps
Syntax (vb)
Public Interface IStreamProps
Remarks
ExampleMetadata: infused
Examples
var key = new Key(this, "MyKey");
new Stream(this, "MyEncryptedStream", new StreamProps {
Encryption = StreamEncryption.KMS,
EncryptionKey = key
});
Synopsis
Properties
Encryption | The kind of server-side encryption to apply to this stream. |
EncryptionKey | External KMS key to use for stream encryption. |
RetentionPeriod | The number of hours for the data records that are stored in shards to remain accessible. |
ShardCount | The number of shards for the stream. |
StreamMode | The capacity mode of this stream. |
StreamName |
Properties
Encryption
The kind of server-side encryption to apply to this stream.
virtual Nullable<StreamEncryption> Encryption { get; }
Property Value
System.Nullable<StreamEncryption>
Remarks
If you choose KMS, you can specify a KMS key via encryptionKey
. If
encryption key is not specified, a key will automatically be created.
Default: - StreamEncryption.KMS if encrypted Streams are supported in the region or StreamEncryption.UNENCRYPTED otherwise. StreamEncryption.KMS if an encryption key is supplied through the encryptionKey property
EncryptionKey
External KMS key to use for stream encryption.
virtual IKey EncryptionKey { get; }
Property Value
Remarks
The 'encryption' property must be set to "Kms".
Default: - Kinesis Data Streams master key ('/alias/aws/kinesis'). If encryption is set to StreamEncryption.KMS and this property is undefined, a new KMS key will be created and associated with this stream.
RetentionPeriod
The number of hours for the data records that are stored in shards to remain accessible.
virtual Duration RetentionPeriod { get; }
Property Value
Remarks
Default: Duration.hours(24)
ShardCount
The number of shards for the stream.
virtual Nullable<double> ShardCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
Can only be provided if streamMode is Provisioned.
Default: 1
StreamMode
The capacity mode of this stream.
virtual Nullable<StreamMode> StreamMode { get; }
Property Value
System.Nullable<StreamMode>
Remarks
Default: StreamMode.PROVISIONED
StreamName
virtual string StreamName { get; }
Property Value
System.String