AWS::KinesisVideo::Stream - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

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 AWS 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

Maximum: 87600

Update requires: No interruption

DeviceName

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

Required: No

Type: String

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

Minimum: 1

Maximum: 128

Update requires: No interruption

KmsKeyId

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

Required: No

Type: String

Pattern: .+

Minimum: 1

Maximum: 2048

Update requires: No interruption

MediaType

The MediaType of the stream.

Required: No

Type: String

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

Minimum: 1

Maximum: 128

Update requires: No interruption

Name

The name of the stream.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the stream.