Package software.amazon.awscdk.services.kinesis

Interface CfnStreamProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnStreamProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.618Z") @Stability(Stable) public interface CfnStreamProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnStream.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesis.*;
 CfnStreamProps cfnStreamProps = CfnStreamProps.builder()
         .name("name")
         .retentionPeriodHours(123)
         .shardCount(123)
         .streamEncryption(StreamEncryptionProperty.builder()
                 .encryptionType("encryptionType")
                 .keyId("keyId")
                 .build())
         .streamModeDetails(StreamModeDetailsProperty.builder()
                 .streamMode("streamMode")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getName

      @Stability(Stable) @Nullable default String getName()
      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.

    • getRetentionPeriodHours

      @Stability(Stable) @Nullable default Number getRetentionPeriodHours()
      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.

    • getShardCount

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

      For greater provisioned throughput, increase the number of shards.

    • getStreamEncryption

      @Stability(Stable) @Nullable default Object getStreamEncryption()
      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.

    • getStreamModeDetails

      @Stability(Stable) @Nullable default Object getStreamModeDetails()
      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.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      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 .

    • builder

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