Package software.amazon.awscdk.services.kinesis

Interface StreamProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StreamProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:40.747Z") @Stability(Stable) public interface StreamProps extends software.amazon.jsii.JsiiSerializable
Properties for a Kinesis Stream.

Example: 

 Key key = new Key(this, "MyKey");
 Stream.Builder.create(this, "MyEncryptedStream")
         .encryption(StreamEncryption.KMS)
         .encryptionKey(key)
         .build();

  • Method Details

    • getEncryption

      @Stability(Stable) @Nullable default StreamEncryption getEncryption()
      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: - 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

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      External 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.

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      Policy to apply when the stream is removed from the stack.

      Default: RemovalPolicy.RETAIN

    • getRetentionPeriod

      @Stability(Stable) @Nullable default Duration getRetentionPeriod()
      The number of hours for the data records that are stored in shards to remain accessible.

      Default: Duration.hours(24)

    • getShardCount

      @Stability(Stable) @Nullable default Number getShardCount()
      The number of shards for the stream.

      Can only be provided if streamMode is Provisioned.

      Default: 1

    • getShardLevelMetrics

      @Stability(Stable) @Nullable default List<ShardLevelMetrics> getShardLevelMetrics()
      A list of shard-level metrics in properties to enable enhanced monitoring mode.

      Default: undefined - AWS Kinesis default is disabled

      See Also:

    • getStreamMode

      @Stability(Stable) @Nullable default StreamMode getStreamMode()
      The capacity mode of this stream.

      Default: StreamMode.PROVISIONED

    • getStreamName

      @Stability(Stable) @Nullable default String getStreamName()
      Enforces a particular physical stream name.

      Default:

    • builder

      @Stability(Stable) static StreamProps.Builder builder()
      Returns:
      a StreamProps.Builder of StreamProps