AWS::KinesisVideo::Stream - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::KinesisVideo::Stream",
  "Properties" : {
      "DataRetentionInHours" : Integer,
      "DeviceName" : String,
      "KmsKeyId" : String,
      "MediaType" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::KinesisVideo::Stream
Properties: 
  DataRetentionInHours: Integer
  DeviceName: String
  KmsKeyId: String
  MediaType: String
  Name: String
  Tags: 
    - Tag

Properties

DataRetentionInHours

How long the stream retains data, in hours.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

DeviceName

The name of the device that is associated with the stream.

Required: No

Type: String

Minimum: 1

Maximum: 128

Pattern: [a-zA-Z0-9_.-]+

Update requires: No interruption

KmsKeyId

The ID of the Amazon Key Management Service (Amazon KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: .+

Update requires: No interruption

MediaType

The MediaType of the stream.

Required: No

Type: String

Minimum: 1

Maximum: 128

Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*

Update requires: No interruption

Name

The name of the stream.

Required: No

Type: String

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the stream.