StreamProps

class aws_cdk.aws_kinesis.StreamProps(*, encryption=None, encryption_key=None, retention_period_hours=None, shard_count=None, stream_name=None)

Bases: object

__init__(*, encryption=None, encryption_key=None, retention_period_hours=None, shard_count=None, stream_name=None)

Properties for a Kinesis Stream.

Parameters
  • encryption (Optional[StreamEncryption]) – The 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: Unencrypted

  • encryption_key (Optional[IKey]) – External KMS key to use for stream encryption. The ‘encryption’ property must be set to “Kms”. Default: If encryption is set to “Kms” and this property is undefined, a new KMS key will be created and associated with this stream.

  • retention_period_hours (Union[int, float, None]) – The number of hours for the data records that are stored in shards to remain accessible. Default: 24

  • shard_count (Union[int, float, None]) – The number of shards for the stream. Default: 1

  • stream_name (Optional[str]) – Enforces a particular physical stream name. Default:

stability :stability: experimental

Attributes

encryption

The 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 :default: Unencrypted

stability :stability: experimental

Return type

Optional[StreamEncryption]

encryption_key

External KMS key to use for stream encryption.

The ‘encryption’ property must be set to “Kms”.

default :default:

If encryption is set to “Kms” and this property is undefined, a new KMS key will be created and associated with this stream.

stability :stability: experimental

Return type

Optional[IKey]

retention_period_hours

The number of hours for the data records that are stored in shards to remain accessible.

default :default: 24

stability :stability: experimental

Return type

Union[int, float, None]

shard_count

The number of shards for the stream.

default :default: 1

stability :stability: experimental

Return type

Union[int, float, None]

stream_name

Enforces a particular physical stream name.

default :default:

stability :stability: experimental

Return type

Optional[str]