Package software.amazon.awscdk.services.medialive.alpha

Interface IChannel

All Superinterfaces:

IChannelRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IChannel.Jsii$Default

All Known Implementing Classes:

Channel, IChannel.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:41.147Z")
@Stability(Experimental)
public interface IChannel
extends software.amazon.jsii.JsiiSerializable, IResource, IChannelRef

(experimental) Represents a MediaLive Channel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IChannel.Jsii$Default	Internal default implementation for IChannel.
static final class	IChannel.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getChannelArn()	(experimental) The ARN of the channel.
String	getChannelId()	(experimental) The ID of the channel.
default List<String>	getChannelInputs()	(experimental) The IDs of the inputs attached to this channel.
ChannelGrants	getGrants()	(experimental) Collection of grant methods for this channel — start, stop, and update its schedule.
Metric	metric(String metricName, Pipeline pipeline)	(experimental) Create a CloudWatch metric for this channel scoped to a specific pipeline.
Metric	metric(String metricName, Pipeline pipeline, MetricOptions props)	(experimental) Create a CloudWatch metric for this channel scoped to a specific pipeline.
Metric	metricActiveAlerts(Pipeline pipeline)	(experimental) Metric for the total number of active alerts on this channel.
Metric	metricActiveAlerts(Pipeline pipeline, MetricOptions props)	(experimental) Metric for the total number of active alerts on this channel.
Metric	metricDroppedFrames(Pipeline pipeline)	(experimental) Metric for dropped frames.
Metric	metricDroppedFrames(Pipeline pipeline, MetricOptions props)	(experimental) Metric for dropped frames.
Metric	metricFillMsec(Pipeline pipeline)	(experimental) 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.
Metric	metricFillMsec(Pipeline pipeline, MetricOptions props)	(experimental) 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.
Metric	metricInputLossSeconds(Pipeline pipeline)	(experimental) Metric for input loss seconds (RTP and MediaConnect inputs only).
Metric	metricInputLossSeconds(Pipeline pipeline, MetricOptions props)	(experimental) Metric for input loss seconds (RTP and MediaConnect inputs only).
Metric	metricInputVideoFrameRate(Pipeline pipeline)	(experimental) Metric for the input video frame rate (frames per second).
Metric	metricInputVideoFrameRate(Pipeline pipeline, MetricOptions props)	(experimental) Metric for the input video frame rate (frames per second).
Metric	metricNetworkIn(Pipeline pipeline)	(experimental) Metric for the rate of inbound network traffic to MediaLive in Mbps.
Metric	metricNetworkIn(Pipeline pipeline, MetricOptions props)	(experimental) Metric for the rate of inbound network traffic to MediaLive in Mbps.
Metric	metricNetworkOut(Pipeline pipeline)	(experimental) Metric for the rate of outbound network traffic from MediaLive in Mbps.
Metric	metricNetworkOut(Pipeline pipeline, MetricOptions props)	(experimental) Metric for the rate of outbound network traffic from MediaLive in Mbps.
Metric	metricSvqTime(Pipeline pipeline)	(experimental) Metric for SVQ time (speed-vs-quality), expressed as a percent.
Metric	metricSvqTime(Pipeline pipeline, MetricOptions props)	(experimental) Metric for SVQ time (speed-vs-quality), expressed as a percent.

Methods inherited from interface software.amazon.awscdk.interfaces.medialive.IChannelRef

getChannelRef

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelArn

@Stability(Experimental)
@NotNull
String getChannelArn()

(experimental) The ARN of the channel.

getChannelId

@Stability(Experimental)
@NotNull
String getChannelId()

(experimental) The ID of the channel.

getGrants

@Stability(Experimental)
@NotNull
ChannelGrants getGrants()

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

getChannelInputs

@Stability(Experimental)
@Nullable
default List<String> getChannelInputs()

(experimental) The IDs of the inputs attached to this channel.

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

(experimental) 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

invalid @link

{@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.

Parameters:

metricName - This parameter is required.

pipeline - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 Pipeline pipeline)

(experimental) 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

invalid @link

{@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.

Parameters:

metricName - This parameter is required.

pipeline - This parameter is required.

metricActiveAlerts

@Stability(Experimental)
@NotNull
Metric metricActiveAlerts(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

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

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricActiveAlerts

@Stability(Experimental)
@NotNull
Metric metricActiveAlerts(@NotNull
 Pipeline pipeline)

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

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

metricDroppedFrames

@Stability(Experimental)
@NotNull
Metric metricDroppedFrames(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

(experimental) Metric for dropped frames.

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

Default: - sum over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricDroppedFrames

@Stability(Experimental)
@NotNull
Metric metricDroppedFrames(@NotNull
 Pipeline pipeline)

(experimental) Metric for dropped frames.

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

Default: - sum over 5 minutes

Parameters:

pipeline - This parameter is required.

metricFillMsec

@Stability(Experimental)
@NotNull
Metric metricFillMsec(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

(experimental) 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.

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricFillMsec

@Stability(Experimental)
@NotNull
Metric metricFillMsec(@NotNull
 Pipeline pipeline)

(experimental) 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.

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

metricInputLossSeconds

@Stability(Experimental)
@NotNull
Metric metricInputLossSeconds(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

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

Default: - sum over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricInputLossSeconds

@Stability(Experimental)
@NotNull
Metric metricInputLossSeconds(@NotNull
 Pipeline pipeline)

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

Default: - sum over 5 minutes

Parameters:

pipeline - This parameter is required.

metricInputVideoFrameRate

@Stability(Experimental)
@NotNull
Metric metricInputVideoFrameRate(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

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

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricInputVideoFrameRate

@Stability(Experimental)
@NotNull
Metric metricInputVideoFrameRate(@NotNull
 Pipeline pipeline)

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

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

metricNetworkIn

@Stability(Experimental)
@NotNull
Metric metricNetworkIn(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

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

Default: - average over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricNetworkIn

@Stability(Experimental)
@NotNull
Metric metricNetworkIn(@NotNull
 Pipeline pipeline)

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

Default: - average over 5 minutes

Parameters:

pipeline - This parameter is required.

metricNetworkOut

@Stability(Experimental)
@NotNull
Metric metricNetworkOut(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

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

Default: - average over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricNetworkOut

@Stability(Experimental)
@NotNull
Metric metricNetworkOut(@NotNull
 Pipeline pipeline)

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

Default: - average over 5 minutes

Parameters:

pipeline - This parameter is required.

metricSvqTime

@Stability(Experimental)
@NotNull
Metric metricSvqTime(@NotNull
 Pipeline pipeline,
 @Nullable
 MetricOptions props)

(experimental) 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.

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.

props -

metricSvqTime

@Stability(Experimental)
@NotNull
Metric metricSvqTime(@NotNull
 Pipeline pipeline)

(experimental) 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.

Default: - max over 5 minutes

Parameters:

pipeline - This parameter is required.