Stream
A Kinesis stream. Can be encrypted with a KMS key.
Import
import { Stream } from 'aws-cdk-lib/aws-kinesis';Or use the module namespace:
import * as kinesis from 'aws-cdk-lib/aws-kinesis';
// kinesis.StreamProperties
Configuration passed to the constructor as StreamProps.
encryptionOptionalStreamEncryptionThe kind of server-side encryption to apply to this stream. 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
encryptionKeyOptionalIKeyExternal KMS key to use for stream encryption. 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.
removalPolicyOptionalRemovalPolicyPolicy to apply when the stream is removed from the stack.
Default: RemovalPolicy.RETAIN
retentionPeriodOptionalDurationThe number of hours for the data records that are stored in shards to remain accessible.
Default: Duration.hours(24)
shardCountOptionalnumberThe number of shards for the stream. Can only be provided if streamMode is Provisioned.
Default: 1
shardLevelMetricsOptionalShardLevelMetrics[]A list of shard-level metrics in properties to enable enhanced monitoring mode.
Default: undefined - AWS Kinesis default is disabled
streamModeOptionalStreamModeThe capacity mode of this stream.
Default: StreamMode.PROVISIONED
streamNameOptionalstringEnforces a particular physical stream name.
Default: <generated>
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-kinesis