CfnStreamProps

class aws_cdk.aws_kinesis.CfnStreamProps(*, name=None, retention_period_hours=None, shard_count=None, stream_encryption=None, stream_mode_details=None, tags=None)

Bases: object

Properties for defining a CfnStream.

Parameters
  • name (Optional[str]) – The name of the Kinesis stream. 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.

  • retention_period_hours (Union[int, float, None]) – 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.

  • shard_count (Union[int, float, None]) – The number of shards that the stream uses. For greater provisioned throughput, increase the number of shards.

  • stream_encryption (Union[StreamEncryptionProperty, IResolvable, None]) – 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.

  • stream_mode_details (Union[IResolvable, StreamModeDetailsProperty, None]) – 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.

  • tags (Optional[Sequence[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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kinesis as kinesis

cfn_stream_props = kinesis.CfnStreamProps(
    name="name",
    retention_period_hours=123,
    shard_count=123,
    stream_encryption=kinesis.CfnStream.StreamEncryptionProperty(
        encryption_type="encryptionType",
        key_id="keyId"
    ),
    stream_mode_details=kinesis.CfnStream.StreamModeDetailsProperty(
        stream_mode="streamMode"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

name

The name of the Kinesis stream.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-name

Return type

Optional[str]

retention_period_hours

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-retentionperiodhours

Return type

Union[int, float, None]

shard_count

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-shardcount

Return type

Union[int, float, None]

stream_encryption

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streamencryption

Return type

Union[StreamEncryptionProperty, IResolvable, None]

stream_mode_details

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-streammodedetails

Return type

Union[IResolvable, StreamModeDetailsProperty, None]

tags

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-stream.html#cfn-kinesis-stream-tags

Return type

Optional[List[CfnTag]]