Package software.amazon.awscdk.services.kinesis

Class CfnStream

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kinesis.CfnStream
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IStreamRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.789Z") @Stability(Stable) public class CfnStream extends CfnResource implements IInspectable, IStreamRef, ITaggable
Creates a Kinesis stream that captures and transports data records that are emitted from data sources.

For information about creating streams, see CreateStream in the Amazon Kinesis API Reference.

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.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .desiredShardLevelMetrics(List.of("desiredShardLevelMetrics"))
         .maxRecordSizeInKiB(123)
         .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()))
         .warmThroughputMiBps(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStream

      protected CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStream

      protected CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStream

      @Stability(Stable) public CfnStream(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnStreamProps props)
      Create a new AWS::Kinesis::Stream.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnStream

      @Stability(Stable) public CfnStream(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Kinesis::Stream.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForStream

      @Stability(Stable) @NotNull public static String arnForStream(@NotNull IStreamRef resource)
      Parameters:
      resource - This parameter is required.

    • fromStreamArn

      @Stability(Stable) @NotNull public static IStreamRef fromStreamArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IStreamRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromStreamName

      @Stability(Stable) @NotNull public static IStreamRef fromStreamName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String streamName)
      Creates a new IStreamRef from a streamName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      streamName - This parameter is required.

    • isCfnStream

      @Stability(Stable) @NotNull public static Boolean isCfnStream(@NotNull Object x)
      Checks whether the given object is a CfnStream.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon resource name (ARN) of the Kinesis stream, such as arn:aws:kinesis:us-east-2:123456789012:stream/mystream .

    • getAttrWarmThroughputObject

      @Stability(Stable) @NotNull public IResolvable getAttrWarmThroughputObject()
      Warm throughput configuration details for the stream.

      Only present for ON_DEMAND streams.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStreamRef

      @Stability(Stable) @NotNull public StreamReference getStreamRef()
      A reference to a Stream resource.
      Specified by:
      getStreamRef in interface IStreamRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDesiredShardLevelMetrics

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

    • setDesiredShardLevelMetrics

      @Stability(Stable) public void setDesiredShardLevelMetrics(@Nullable List<String> value)
      A list of shard-level metrics in properties to enable enhanced monitoring mode.

    • getMaxRecordSizeInKiB

      @Stability(Stable) @Nullable public Number getMaxRecordSizeInKiB()
      The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

    • setMaxRecordSizeInKiB

      @Stability(Stable) public void setMaxRecordSizeInKiB(@Nullable Number value)
      The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the Kinesis stream.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the Kinesis stream.

    • getRetentionPeriodHours

      @Stability(Stable) @Nullable public Number getRetentionPeriodHours()
      The number of hours for the data records that are stored in shards to remain accessible.

    • setRetentionPeriodHours

      @Stability(Stable) public void setRetentionPeriodHours(@Nullable Number value)
      The number of hours for the data records that are stored in shards to remain accessible.

    • getShardCount

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

    • setShardCount

      @Stability(Stable) public void setShardCount(@Nullable Number value)
      The number of shards that the stream uses.

    • getStreamEncryption

      @Stability(Stable) @Nullable public Object getStreamEncryption()
      When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

      Returns union: either IResolvable or CfnStream.StreamEncryptionProperty

    • setStreamEncryption

      @Stability(Stable) public void setStreamEncryption(@Nullable IResolvable value)
      When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

    • setStreamEncryption

      @Stability(Stable) public void setStreamEncryption(@Nullable CfnStream.StreamEncryptionProperty value)
      When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

    • getStreamModeDetails

      @Stability(Stable) @Nullable public Object getStreamModeDetails()
      Specifies the capacity mode to which you want to set your data stream.

      Returns union: either IResolvable or CfnStream.StreamModeDetailsProperty

    • setStreamModeDetails

      @Stability(Stable) public void setStreamModeDetails(@Nullable IResolvable value)
      Specifies the capacity mode to which you want to set your data stream.

    • setStreamModeDetails

      @Stability(Stable) public void setStreamModeDetails(@Nullable CfnStream.StreamModeDetailsProperty value)
      Specifies the capacity mode to which you want to set your data stream.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

    • getWarmThroughputMiBps

      @Stability(Stable) @Nullable public Number getWarmThroughputMiBps()
      The target warm throughput in MB/s that the stream should be scaled to handle.

    • setWarmThroughputMiBps

      @Stability(Stable) public void setWarmThroughputMiBps(@Nullable Number value)
      The target warm throughput in MB/s that the stream should be scaled to handle.