View a markdown version of this page

AWS::IoT::Stream - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::IoT::Stream

Describes a group of files that can be streamed.

Syntax

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

JSON

{
  "Type" : "AWS::IoT::Stream",
  "Properties" : {
      "Description" : String,
      "Files" : [ StreamFile, ... ],
      "RoleArn" : String,
      "StreamId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoT::Stream
Properties:
  Description: String
  Files: 
    - StreamFile
  RoleArn: String
  StreamId: String
  Tags: 
    - Tag

Properties

Description

The description of the stream.

Required: No

Type: String

Pattern: ^[^\p{C}]+$

Maximum: 2028

Update requires: No interruption

Files

The files to stream.

Required: Yes

Type: Array of StreamFile

Minimum: 1

Maximum: 50

Update requires: No interruption

RoleArn

An IAM role AWS IoT assumes to access your S3 files.

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

StreamId

The stream ID.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreatedAt

The date when the stream was created.

LastUpdatedAt

The date when the stream was last updated.

StreamVersion

The stream version.