AWS::MediaLive::Channel

The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.

A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.

Syntax

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

JSON

{
  "Type" : "AWS::MediaLive::Channel",
  "Properties" : {
      "CdiInputSpecification" : CdiInputSpecification,
      "ChannelClass" : String,
      "Destinations" : [ OutputDestination, ... ],
      "EncoderSettings" : EncoderSettings,
      "InputAttachments" : [ InputAttachment, ... ],
      "InputSpecification" : InputSpecification,
      "LogLevel" : String,
      "Maintenance" : MaintenanceCreateSettings,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "Vpc" : VpcOutputSettings
    }
}

YAML

Type: AWS::MediaLive::Channel
Properties:
  CdiInputSpecification: 
    CdiInputSpecification
  ChannelClass: String
  Destinations: 
    - OutputDestination
  EncoderSettings: 
    EncoderSettings
  InputAttachments: 
    - InputAttachment
  InputSpecification: 
    InputSpecification
  LogLevel: String
  Maintenance: 
    MaintenanceCreateSettings
  Name: String
  RoleArn: String
  Tags: 
    - Tag
  Vpc: 
    VpcOutputSettings

Properties

CdiInputSpecification

Specification of CDI inputs for this channel.

Required: No

Type: CdiInputSpecification

Update requires: No interruption

ChannelClass

The class for this channel. For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.

Required: No

Type: String

Update requires: No interruption

Destinations

The settings that identify the destination for the outputs in this MediaLive output package.

Required: No

Type: Array of OutputDestination

Update requires: No interruption

EncoderSettings

The encoding configuration for the output content.

Required: No

Type: EncoderSettings

Update requires: No interruption

InputAttachments

The list of input attachments for the channel.

Required: No

Type: Array of InputAttachment

Update requires: No interruption

InputSpecification

The input specification for this channel. It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.

Required: No

Type: InputSpecification

Update requires: No interruption

LogLevel

The verbosity for logging activity for this channel. Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.

Required: No

Type: String

Update requires: No interruption

Maintenance

Maintenance settings for this channel.

Required: No

Type: MaintenanceCreateSettings

Update requires: No interruption

Name

A name for this audio selector. The AudioDescription (in an output) references this name in order to identify a specific input audio to include in that output.

Required: No

Type: String

Update requires: No interruption

RoleArn

The IAM role for MediaLive to assume when running this channel. The role is identified by its ARN.

Required: No

Type: String

Update requires: No interruption

Tags

A collection of tags for this channel. Each tag is a key-value pair.

Required: No

Type: Array of Tag

Update requires: No interruption

Vpc

Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Required: No

Type: VpcOutputSettings

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the channel.

For example: { "Ref": "myChannel" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the MediaLive channel. For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567

Id

User-specified id. This is used in an output group or an output.

Inputs

The inputs that are attached to this channel. The inputs are identified by their IDs (not by their names or their ARNs).