Header menu logo FsCDK

KinesisStreamConfig Type

High-level Kinesis Stream builder following AWS best practices. **Default Security Settings:** - Encryption = enabled with AWS managed key - Retention period = 24 hours - Shard count = 1 (for low throughput) - Stream mode = PROVISIONED **Rationale:** These defaults follow AWS Well-Architected Framework: - Encryption at rest for data protection - 24-hour retention balances cost and recovery needs - Single shard for cost optimization (scale as needed) - Provisioned mode for predictable costs **Escape Hatch:** Access the underlying CDK Stream via the `Stream` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

Encryption

Full Usage: Encryption

Field type: StreamEncryption option
Field type: StreamEncryption option

EncryptionKey

Full Usage: EncryptionKey

Field type: IKey option
Field type: IKey option

GrantReads

Full Usage: GrantReads

Field type: IGrantable list
Field type: IGrantable list

GrantWrites

Full Usage: GrantWrites

Field type: IGrantable list
Field type: IGrantable list

RetentionPeriod

Full Usage: RetentionPeriod

Field type: Duration option
Field type: Duration option

ShardCount

Full Usage: ShardCount

Field type: int option
Field type: int option

StreamMode

Full Usage: StreamMode

Field type: StreamMode option
Field type: StreamMode option

StreamName

Full Usage: StreamName

Field type: string
Field type: string

StreamName_

Full Usage: StreamName_

Field type: string option
Field type: string option

Type something to start searching.