Package software.amazon.awscdk.services.kinesisvideo

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.kinesisvideo.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:39.087Z") @Stability(Stable) public class CfnStream extends CfnResource implements IInspectable, IStreamRef, ITaggable
Specifies a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works .

You must have permissions for the KinesisVideo:CreateStream action.

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.kinesisvideo.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .dataRetentionInHours(123)
         .deviceName("deviceName")
         .kmsKeyId("kmsKeyId")
         .mediaType("mediaType")
         .name("name")
         .streamStorageConfiguration(StreamStorageConfigurationProperty.builder()
                 .defaultStorageTier("defaultStorageTier")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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::KinesisVideo::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::KinesisVideo::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.

    • 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 stream.

    • 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

    • getDataRetentionInHours

      @Stability(Stable) @Nullable public Number getDataRetentionInHours()
      How long the stream retains data, in hours.

    • setDataRetentionInHours

      @Stability(Stable) public void setDataRetentionInHours(@Nullable Number value)
      How long the stream retains data, in hours.

    • getDeviceName

      @Stability(Stable) @Nullable public String getDeviceName()
      The name of the device that is associated with the stream.

    • setDeviceName

      @Stability(Stable) public void setDeviceName(@Nullable String value)
      The name of the device that is associated with the stream.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the AWS Key Management Service ( AWS ) key that Kinesis Video Streams uses to encrypt data on the stream.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the AWS Key Management Service ( AWS ) key that Kinesis Video Streams uses to encrypt data on the stream.

    • getMediaType

      @Stability(Stable) @Nullable public String getMediaType()
      The MediaType of the stream.

    • setMediaType

      @Stability(Stable) public void setMediaType(@Nullable String value)
      The MediaType of the stream.

    • getName

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

    • setName

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

    • getStreamStorageConfiguration

      @Stability(Stable) @Nullable public Object getStreamStorageConfiguration()
      The configuration for stream storage, including the default storage tier for stream data.

      Returns union: either IResolvable or CfnStream.StreamStorageConfigurationProperty

    • setStreamStorageConfiguration

      @Stability(Stable) public void setStreamStorageConfiguration(@Nullable IResolvable value)
      The configuration for stream storage, including the default storage tier for stream data.

    • setStreamStorageConfiguration

      @Stability(Stable) public void setStreamStorageConfiguration(@Nullable CfnStream.StreamStorageConfigurationProperty value)
      The configuration for stream storage, including the default storage tier for stream data.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.