AWS CDK Reference

Appearance

v2.275.0

CfnStreamProps Struct ​

Properties for defining a CfnStream.

Source
Generated code
Type last changed
v2.273.0 · 8 Oct 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const cfnStreamProps: kinesis.CfnStreamProps = {
  desiredShardLevelMetrics: ['desiredShardLevelMetrics'],
  maxRecordSizeInKiB: 123,
  name: 'name',
  recordDistributionStrategy: 'recordDistributionStrategy',
  retentionPeriodHours: 123,
  shardCount: 123,
  streamEncryption: {
    encryptionType: 'encryptionType',
    keyId: 'keyId',
  },
  streamModeDetails: {
    streamMode: 'streamMode',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  warmThroughputMiBps: 123,
};

Properties ​

desiredShardLevelMetricsoptionalstring[]desired_shard_level_metricsoptionaltyping.List[str]desiredShardLevelMetricsoptionalList<String>DesiredShardLevelMetricsoptionalstring[]DesiredShardLevelMetricsoptional*[]*string#
A list of shard-level metrics in properties to enable enhanced monitoring mode.
maxRecordSizeInKiBoptionalnumbermax_record_size_in_ki_boptionalint | floatmaxRecordSizeInKiBoptionalNumberMaxRecordSizeInKiBoptionaldoubleMaxRecordSizeInKiBoptional*float64#
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the Kinesis stream.
notes

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.

recordDistributionStrategyoptionalstringrecord_distribution_strategyoptionalstrrecordDistributionStrategyoptionalStringRecordDistributionStrategyoptionalstringRecordDistributionStrategyoptional*string#
The record distribution strategy for the stream.

This property can ONLY be set when StreamMode is ON_DEMAND

retentionPeriodHoursoptionalnumberretention_period_hoursoptionalint | floatretentionPeriodHoursoptionalNumberRetentionPeriodHoursoptionaldoubleRetentionPeriodHoursoptional*float64#
The number of hours for the data records that are stored in shards to remain accessible.

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.

shardCountoptionalnumbershard_countoptionalint | floatshardCountoptionalNumberShardCountoptionaldoubleShardCountoptional*float64#
The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

streamEncryptionoptionalIResolvable | CfnStream.StreamEncryptionPropertystream_encryptionoptionaltyping.Union[IResolvable, StreamEncryptionProperty]streamEncryptionoptionalIResolvableStreamEncryptionoptionalIResolvableStreamEncryptionoptionalinterface{}#
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

streamModeDetailsoptionalIResolvable | CfnStream.StreamModeDetailsPropertystream_mode_detailsoptionaltyping.Union[IResolvable, StreamModeDetailsProperty]streamModeDetailsoptionalIResolvableStreamModeDetailsoptionalIResolvableStreamModeDetailsoptionalinterface{}#
Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .

warmThroughputMiBpsoptionalnumberwarm_throughput_mi_bpsoptionalint | floatwarmThroughputMiBpsoptionalNumberWarmThroughputMiBpsoptionaldoubleWarmThroughputMiBpsoptional*float64#
The target warm throughput in MB/s that the stream should be scaled to handle.

This represents the throughput capacity that will be immediately available for write operations.