interface ChannelProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.MediaLive.Alpha.ChannelProps`
Go	`github.com/aws/aws-cdk-go/awsmedialivealpha/v2#ChannelProps`
Java	`software.amazon.awscdk.services.medialive.alpha.ChannelProps`
Python	`aws_cdk.aws_medialive_alpha.ChannelProps`
TypeScript (source)	`@aws-cdk/aws-medialive-alpha` » `ChannelProps`

Properties for creating a MediaLive Channel.

Example

declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;

new medialive.Channel(stack, 'Channel', {
  inputs: [{
    input,
    audioSelectors: [
      medialive.AudioSelector.byLanguage('eng', 'eng', medialive.AudioLanguageSelectionPolicy.STRICT),
    ],
    captionSelectors: [
      medialive.CaptionSelector.embedded('embedded'),
    ],
    videoSelector: {
      colorSpace: medialive.VideoColorSpace.HDR10,
      colorSpaceUsage: medialive.VideoColorSpaceUsage.FORCE,
      selectBy: medialive.VideoSelection.byProgramId(1),
    },
  }],
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties

Name	Type	Description
inputs🔹	`InputAttachment[]`	The input attachments for this channel.
outputGroups🔹	`OutputGroupConfiguration[]`	The initial output groups for this channel. At least one is required. Additional output groups can be added with `addOutputGroup()`.
anywhereSettings?🔹	`AnywhereSettings`	Anywhere settings for running the channel on AWS Elemental Anywhere.
availBlanking?🔹	`AvailBlanking`	Settings for blanking video, audio, and captions during ad avails.
availSettings?🔹	`AvailSettings`	Ad avail handling configuration.
blackoutSlate?🔹	`BlackoutSlate`	Blackout slate configuration.
channelClass?🔹	`ChannelClass`	The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).
channelEngineVersion?🔹	`string`	The engine version for the channel.
channelName?🔹	`string`	The name of the channel.
channelSecurityGroups?🔹	`IInputSecurityGroupRef[]`	Input security groups to associate with the channel.
colorCorrections?🔹	`ColorCorrection[]`	Global color correction rules applied to all outputs.
featureActivations?🔹	`FeatureActivations`	Feature activations for the channel (e.g. Input Prepare schedule actions).
globalConfiguration?🔹	`GlobalConfiguration`	Global configuration settings for the channel.
inferenceFeedArn?🔹	`string`	An AWS Elemental Inference feed to send this channel's media to for inference processing.
inputSpecification?🔹	`InputSpecification`	The input specification for this channel.
linkedChannelSettings?🔹	`LinkedChannelSettings`	Linked channel settings for primary/follower channel configurations.
logLevel?🔹	`LogLevel`	The log level for the channel.
maintenance?🔹	`MaintenanceSettings`	Maintenance window configuration for the channel.
motionGraphicsConfiguration?🔹	`MotionGraphicsConfiguration`	Motion graphics overlay configuration.
nielsenConfiguration?🔹	`NielsenConfiguration`	Nielsen watermark configuration.
role?🔹	`IRole`	The IAM role for MediaLive to assume when running this channel.
scte35SegmentationScope?🔹	`Scte35SegmentationScope`	Which output groups receive SCTE-35 segmentation cues.
tags?🔹	`{ [string]: string }`	Tags to add to the channel.
thumbnailConfiguration?🔹	`ThumbnailConfiguration`	Thumbnail generation configuration.
timecodeConfig?🔹	`TimecodeConfig`	Timecode configuration for the channel.
vpc?🔹	`VpcOutputSettings`	VPC output settings.

inputs🔹

Type: InputAttachment[]

The input attachments for this channel.

At least one is required. Additional inputs can be added with addInput().

outputGroups🔹

Type: OutputGroupConfiguration[]

The initial output groups for this channel. At least one is required. Additional output groups can be added with addOutputGroup().

A single channel can contain multiple output groups with different codecs (e.g. H.264 and H.265 ladders) sharing the same input.

anywhereSettings?🔹

Type: AnywhereSettings (optional, default: not an Anywhere channel)

Anywhere settings for running the channel on AWS Elemental Anywhere.

availBlanking?🔹

Type: AvailBlanking (optional, default: avail blanking disabled)

Settings for blanking video, audio, and captions during ad avails.

availSettings?🔹

Type: AvailSettings (optional, default: no avail configuration)

Ad avail handling configuration.

Defines how SCTE-35 markers are processed.

blackoutSlate?🔹

Type: BlackoutSlate (optional, default: blackout slate disabled)

Blackout slate configuration.

Controls what is displayed during blackout events.

channelClass?🔹

Type: ChannelClass (optional, default: ChannelClass.SINGLE_PIPELINE)

The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).

channelEngineVersion?🔹

Type: string (optional, default: service default)

The engine version for the channel.

channelName?🔹

Type: string (optional, default: auto-generated)

The name of the channel.

channelSecurityGroups?🔹

Type: IInputSecurityGroupRef[] (optional, default: no channel security groups)

Input security groups to associate with the channel.

Controls which IP addresses can connect to the channel's outputs (pull-style outputs where downstream systems initiate connections).

colorCorrections?🔹

Type: ColorCorrection[] (optional, default: no color corrections)

Global color correction rules applied to all outputs.

featureActivations?🔹

Type: FeatureActivations (optional, default: all features disabled)

Feature activations for the channel (e.g. Input Prepare schedule actions).

globalConfiguration?🔹

Type: GlobalConfiguration (optional, default: default global configuration)

Global configuration settings for the channel.

inferenceFeedArn?🔹

Type: string (optional, default: the channel is not associated to an inference feed)

An AWS Elemental Inference feed to send this channel's media to for inference processing.

Future breaking change: this will change when Elemental Inference is released as an L2 construct.

inputSpecification?🔹

Type: InputSpecification (optional, default: InputSpecification.standard() (AVC codec, 20 Mbps max, HD resolution))

The input specification for this channel.

Defines the expected codec, bitrate, and resolution of the inputs, and whether they are standard, CDI, or Elemental Link inputs.

linkedChannelSettings?🔹

Type: LinkedChannelSettings (optional, default: not a linked channel)

Linked channel settings for primary/follower channel configurations.

logLevel?🔹

Type: LogLevel (optional, default: LogLevel.DISABLED)

The log level for the channel.

maintenance?🔹

Type: MaintenanceSettings (optional, default: default maintenance window)

Maintenance window configuration for the channel.

motionGraphicsConfiguration?🔹

Type: MotionGraphicsConfiguration (optional, default: motion graphics disabled)

Motion graphics overlay configuration.

nielsenConfiguration?🔹

Type: NielsenConfiguration (optional, default: no Nielsen configuration)

Nielsen watermark configuration.

role?🔹

Type: IRole (optional, default: a role is auto-created with confused-deputy prevention)

The IAM role for MediaLive to assume when running this channel.

[disable-awslint:prefer-ref-interface]

scte35SegmentationScope?🔹

Type: Scte35SegmentationScope (optional, default: service default)

Which output groups receive SCTE-35 segmentation cues.

tags?🔹

Type: { [string]: string } (optional, default: no tags)

Tags to add to the channel.

thumbnailConfiguration?🔹

Type: ThumbnailConfiguration (optional, default: thumbnails disabled)

Thumbnail generation configuration.

timecodeConfig?🔹

Type: TimecodeConfig (optional, default: EMBEDDED source, no sync threshold)

Timecode configuration for the channel.

vpc?🔹

Type: VpcOutputSettings (optional, default: no VPC (outputs use public endpoints))

VPC output settings.

When set, all output endpoints are created in the specified VPC.

AWS CDK

2.268.0