@aws-cdk/aws-medialive-alpha.IChannel

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IChannel Interface

Represents a MediaLive Channel.

IChannel

extends

• IResource,
• IChannelRef

implemented by

• Channel

Stability

Experimental

Source

lib/channel.ts

Properties

channelArnstringchannel_arnstrchannelArnStringChannelArnstringChannelArn*stringrequired#

The ARN of the channel.

channelIdstringchannel_idstrchannelIdStringChannelIdstringChannelId*stringrequired#

The ID of the channel.

channelInputsstring[]channel_inputstyping.List[str]channelInputsList<String>ChannelInputsstring[]ChannelInputs*[]*string#

The IDs of the inputs attached to this channel.

channelRefChannelReferencechannel_refChannelReferencechannelRefChannelReferenceChannelRefChannelReferenceChannelRefChannelReferencerequired#

A reference to a Channel resource.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

grantsChannelGrantsgrantsChannelGrantsgrantsChannelGrantsGrantsChannelGrantsGrantsChannelGrantsrequired#

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

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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: string, pipeline: Pipeline, props?: MetricOptions): Metricdef metric(self, metric_name: str, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, Pipeline pipeline, MetricOptions props)public Metric Metric(string metricName, Pipeline pipeline, MetricOptions? props = null)func Metric(MetricName *string, Pipeline Pipeline, Props MetricOptions) Metric#

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

notes

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: Pipeline, props?: MetricOptions): Metricdef metric_active_alerts(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricActiveAlerts(Pipeline pipeline, MetricOptions props)public Metric MetricActiveAlerts(Pipeline pipeline, MetricOptions? props = null)func MetricActiveAlerts(Pipeline Pipeline, Props MetricOptions) Metric#

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

metricDroppedFrames(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_dropped_frames(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricDroppedFrames(Pipeline pipeline, MetricOptions props)public Metric MetricDroppedFrames(Pipeline pipeline, MetricOptions? props = null)func MetricDroppedFrames(Pipeline Pipeline, Props MetricOptions) Metric#

Metric for dropped frames.

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

metricFillMsec(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_fill_msec(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFillMsec(Pipeline pipeline, MetricOptions props)public Metric MetricFillMsec(Pipeline pipeline, MetricOptions? props = null)func MetricFillMsec(Pipeline Pipeline, Props MetricOptions) 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: Pipeline, props?: MetricOptions): Metricdef metric_input_loss_seconds(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInputLossSeconds(Pipeline pipeline, MetricOptions props)public Metric MetricInputLossSeconds(Pipeline pipeline, MetricOptions? props = null)func MetricInputLossSeconds(Pipeline Pipeline, Props MetricOptions) Metric#

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

metricInputVideoFrameRate(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_input_video_frame_rate(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInputVideoFrameRate(Pipeline pipeline, MetricOptions props)public Metric MetricInputVideoFrameRate(Pipeline pipeline, MetricOptions? props = null)func MetricInputVideoFrameRate(Pipeline Pipeline, Props MetricOptions) Metric#

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

metricNetworkIn(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_network_in(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkIn(Pipeline pipeline, MetricOptions props)public Metric MetricNetworkIn(Pipeline pipeline, MetricOptions? props = null)func MetricNetworkIn(Pipeline Pipeline, Props MetricOptions) Metric#

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

metricNetworkOut(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_network_out(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNetworkOut(Pipeline pipeline, MetricOptions props)public Metric MetricNetworkOut(Pipeline pipeline, MetricOptions? props = null)func MetricNetworkOut(Pipeline Pipeline, Props MetricOptions) Metric#

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

metricSvqTime(pipeline: Pipeline, props?: MetricOptions): Metricdef metric_svq_time(self, pipeline: Pipeline, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSvqTime(Pipeline pipeline, MetricOptions props)public Metric MetricSvqTime(Pipeline pipeline, MetricOptions? props = null)func MetricSvqTime(Pipeline Pipeline, Props MetricOptions) 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: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining