Package software.amazon.awscdk.services.kinesisvideo

Class CfnStream

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.kinesisvideo.CfnStream
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.380Z") @Stability(Stable) public class CfnStream extends CfnResource implements IInspectable
A CloudFormation AWS::KinesisVideo::Stream.

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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnStream

      @Stability(Stable) public CfnStream(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • 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 KMS ) 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 KMS ) 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.