AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IVS::Channel

CfnChannel

The `AWS::IVS::Channel` resource specifies an channel. A channel stores configuration information related to your live stream. For more information, see [CreateChannel](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/API_CreateChannel.html) in the *Amazon IVS Low-Latency Streaming API Reference* . > By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The Channel resource *does not* create a stream key; to create a stream key, use the StreamKey resource instead.

Import

import { CfnChannel } from 'aws-cdk-lib/aws-ivs';

Or use the module namespace:

import * as ivs from 'aws-cdk-lib/aws-ivs';
// ivs.CfnChannel

Properties

Configuration passed to the constructor as CfnChannelProps.

authorizedOptional
boolean | IResolvable

Whether the channel is authorized. *Default* : `false`

Default: - false

containerFormatOptional
string

Indicates which content-packaging format is used (MPEG-TS or fMP4). If `multitrackInputConfiguration` is specified and `enabled` is `true` , then `containerFormat` is required and must be set to `FRAGMENTED_MP4` . Otherwise, `containerFormat` may be set to `TS` or `FRAGMENTED_MP4` . Default: `TS` .

Default: - "TS"

insecureIngestOptional
boolean | IResolvable

Whether the channel allows insecure RTMP ingest. *Default* : `false`

Default: - false

latencyModeOptional
string

Channel latency mode. Valid values:. - `NORMAL` : Use NORMAL to broadcast and deliver live video up to Full HD. - `LOW` : Use LOW for near real-time interactions with viewers. > In the console, `LOW` and `NORMAL` correspond to `Ultra-low` and `Standard` , respectively. *Default* : `LOW`

Default: - "LOW"

multitrackInputConfigurationOptional
IResolvable | MultitrackInputConfigurationProperty

Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

nameOptional
string

Channel name.

Default: - "-"

presetOptional
string

An optional transcode preset for the channel. This is selectable only for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel types, the default preset is `HIGHER_BANDWIDTH_DELIVERY` . For other channel types ( `BASIC` and `STANDARD` ), `preset` is the empty string ("").

recordingConfigurationArnOptional
string | IRecordingConfigurationRef

The ARN of a RecordingConfiguration resource. An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the [RecordingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html) resource for more information and an example. *Default* : "" (empty string, recording is disabled)

Default: - ""

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-channel-tag.html) .

typeOptional
string

The channel type, which determines the allowable resolution and bitrate. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.* For details, see [Channel Types](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) . *Default* : `STANDARD`

Default: - "STANDARD"

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IVS::ChannelView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ivs
CFN TypeAWS::IVS::Channel
Properties10

Related Constructs

Explore This Service

External Links