interface IChannel 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IChannelRef

Implemented by Channel

Obtainable from Channel.fromChannelArn()

Represents a MediaLive Channel.

Properties

Name	Type	Description
channelArn🔹	string	The ARN of the channel.
channelId🔹	string	The ID of the channel.
channelRef🔹	ChannelReference	A reference to a Channel resource.
env🔹	ResourceEnvironment	The environment this resource belongs to.
grants🔹	ChannelGrants	Collection of grant methods for this channel — start, stop, and update its schedule.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
channelInputs?🔹	string[]	The IDs of the inputs attached to this channel.

---

channelArn🔹

Type: string

The ARN of the channel.

---

channelId🔹

Type: string

The ID of the channel.

---

channelRef🔹

Type: ChannelReference

A reference to a Channel resource.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

grants🔹

Type: ChannelGrants

Collection of grant methods for this channel — start, stop, and update its schedule.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

channelInputs?🔹

Type: string[] (optional)

The IDs of the inputs attached to this channel.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, pipeline, props?)🔹	Create a CloudWatch metric for this channel scoped to a specific pipeline.
metricActiveAlerts(pipeline, props?)🔹	Metric for the total number of active alerts on this channel.
metricDroppedFrames(pipeline, props?)🔹	Metric for dropped frames.
metricFillMsec(pipeline, props?)🔹	Metric for fill milliseconds — the time MediaLive has filled the video output with fill frames because the input did not deliver content within the expected window.
metricInputLossSeconds(pipeline, props?)🔹	Metric for input loss seconds (RTP and MediaConnect inputs only).
metricInputVideoFrameRate(pipeline, props?)🔹	Metric for the input video frame rate (frames per second).
metricNetworkIn(pipeline, props?)🔹	Metric for the rate of inbound network traffic to MediaLive in Mbps.
metricNetworkOut(pipeline, props?)🔹	Metric for the rate of outbound network traffic from MediaLive in Mbps.
metricSvqTime(pipeline, props?)🔹	Metric for SVQ time (speed-vs-quality), expressed as a percent.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

metric(metricName, pipeline, props?)🔹

public metric(metricName: string, pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• metricName string
• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Create a CloudWatch metric for this channel scoped to a specific pipeline.

Channel metrics are published per-pipeline. STANDARD channels run two redundant pipelines (PIPELINE_0 and PIPELINE_1); to cover both, build a metric for each. SINGLE_PIPELINE channels only publish on PIPELINE_0. See the {@link https://docs.aws.amazon.com/medialive/latest/ug/monitoring-eml-metrics.html MediaLive metrics docs} for the full set of metric names and recommended statistics.

---

metricActiveAlerts(pipeline, props?)🔹

public metricActiveAlerts(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for the total number of active alerts on this channel.

---

metricDroppedFrames(pipeline, props?)🔹

public metricDroppedFrames(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for dropped frames.

A non-zero value indicates the encoder cannot keep up with the incoming video in real time.

---

metricFillMsec(pipeline, props?)🔹

public metricFillMsec(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for fill milliseconds — the time MediaLive has filled the video output with fill frames because the input did not deliver content within the expected window.

A non-zero value indicates an unhealthy input.

---

metricInputLossSeconds(pipeline, props?)🔹

public metricInputLossSeconds(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for input loss seconds (RTP and MediaConnect inputs only).

---

metricInputVideoFrameRate(pipeline, props?)🔹

public metricInputVideoFrameRate(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for the input video frame rate (frames per second).

---

metricNetworkIn(pipeline, props?)🔹

public metricNetworkIn(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for the rate of inbound network traffic to MediaLive in Mbps.

---

metricNetworkOut(pipeline, props?)🔹

public metricNetworkOut(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for the rate of outbound network traffic from MediaLive in Mbps.

---

metricSvqTime(pipeline, props?)🔹

public metricSvqTime(pipeline: Pipeline, props?: MetricOptions): Metric

Parameters

• pipeline Pipeline
• props MetricOptions

Returns

• Metric

Metric for SVQ time (speed-vs-quality), expressed as a percent.

Indicates the share of time MediaLive reduced quality optimisations to keep up with real-time output.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.