View a markdown version of this page

AWS::MediaPackageV2::Channel - 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).

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

AWS::MediaPackageV2::Channel

Creates a channel to receive content.

After it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

Syntax

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

JSON

{
  "Type" : "AWS::MediaPackageV2::Channel",
  "Properties" : {
      "ChannelGroupName" : String,
      "ChannelName" : String,
      "Description" : String,
      "InputSwitchConfiguration" : InputSwitchConfiguration,
      "InputType" : String,
      "MultiviewConfiguration" : MultiviewConfiguration,
      "OutputHeaderConfiguration" : OutputHeaderConfiguration,
      "OutputLockingMode" : String,
      "Tags" : [ Tag, ... ]
    }
}

Properties

ChannelGroupName

The name of the channel group associated with the channel configuration.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 256

Update requires: Replacement

ChannelName

The name of the channel.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 256

Update requires: Replacement

Description

The description of the channel.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

InputSwitchConfiguration

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

Required: No

Type: InputSwitchConfiguration

Update requires: No interruption

InputType

The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

The allowed values are:

  • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

  • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

  • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

Required: No

Type: String

Allowed values: HLS | CMAF | MULTIVIEW

Update requires: Replacement

MultiviewConfiguration

The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

Required: No

Type: MultiviewConfiguration

Update requires: No interruption

OutputHeaderConfiguration

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

Required: No

Type: OutputHeaderConfiguration

Update requires: No interruption

OutputLockingMode

The output locking mode configured for the channel.

The allowed values are:

  • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

  • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

Required: No

Type: String

Allowed values: EPOCH_LOCKED | NON_EPOCH_LOCKED

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returnsarn:aws:mediapackagev2:region:AccountId:ChannelGroup/ChannelGroupName/Channel/ChannelName.

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

Fn::GetAtt

The attributes of the channels. You can only use the GetAtt function for readOnly properties. For example, you can use the GetAtt function to retrieve the read-only CreatedAt property.

Arn

The Amazon Resource Name (ARN) of the channel.

AttachedMultiviewChannels

The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.

CreatedAt

The timestamp of the creation of the channel.

IngestEndpoints

The ingest endpoints associated with the channel.

IngestEndpointUrls

The ingest domain URL where the source stream should be sent.

ModifiedAt

The timestamp of the modification of the channel.