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

Interface IChannel.Jsii$Default

All Superinterfaces:
IChannel, IChannelRef, IChannelRef.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IChannel.Jsii$Proxy
Enclosing interface:
IChannel
@Internal public static interface IChannel.Jsii$Default extends IChannel, IResource.Jsii$Default, IChannelRef.Jsii$Default
Internal default implementation for IChannel.

  • Method Details

    • getChannelArn

      @Stability(Experimental) @NotNull default String getChannelArn()
      (experimental) The ARN of the channel.
      Specified by:
      getChannelArn in interface IChannel

    • getChannelId

      @Stability(Experimental) @NotNull default String getChannelId()
      (experimental) The ID of the channel.
      Specified by:
      getChannelId in interface IChannel

    • getGrants

      @Stability(Experimental) @NotNull default ChannelGrants getGrants()
      (experimental) Collection of grant methods for this channel — start, stop, and update its schedule.
      Specified by:
      getGrants in interface IChannel

    • getChannelInputs

      @Stability(Experimental) @Nullable default List<String> getChannelInputs()
      (experimental) The IDs of the inputs attached to this channel.
      Specified by:
      getChannelInputs in interface IChannel

    • metric

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      metric in interface IChannel
      Parameters:
      metricName - This parameter is required.
      pipeline - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      metric in interface IChannel
      Parameters:
      metricName - This parameter is required.
      pipeline - This parameter is required.

    • metricActiveAlerts

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricActiveAlerts in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricActiveAlerts

      @Stability(Experimental) @NotNull default Metric metricActiveAlerts(@NotNull Pipeline pipeline)
      (experimental) Metric for the total number of active alerts on this channel.

      Default: - max over 5 minutes

      Specified by:
      metricActiveAlerts in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricDroppedFrames

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricDroppedFrames in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricDroppedFrames

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricDroppedFrames in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricFillMsec

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricFillMsec in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricFillMsec

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricFillMsec in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricInputLossSeconds

      @Stability(Experimental) @NotNull default Metric metricInputLossSeconds(@NotNull Pipeline pipeline, @Nullable MetricOptions props)
      (experimental) Metric for input loss seconds (RTP and MediaConnect inputs only).

      Default: - sum over 5 minutes

      Specified by:
      metricInputLossSeconds in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricInputLossSeconds

      @Stability(Experimental) @NotNull default Metric metricInputLossSeconds(@NotNull Pipeline pipeline)
      (experimental) Metric for input loss seconds (RTP and MediaConnect inputs only).

      Default: - sum over 5 minutes

      Specified by:
      metricInputLossSeconds in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricInputVideoFrameRate

      @Stability(Experimental) @NotNull default Metric metricInputVideoFrameRate(@NotNull Pipeline pipeline, @Nullable MetricOptions props)
      (experimental) Metric for the input video frame rate (frames per second).

      Default: - max over 5 minutes

      Specified by:
      metricInputVideoFrameRate in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricInputVideoFrameRate

      @Stability(Experimental) @NotNull default Metric metricInputVideoFrameRate(@NotNull Pipeline pipeline)
      (experimental) Metric for the input video frame rate (frames per second).

      Default: - max over 5 minutes

      Specified by:
      metricInputVideoFrameRate in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricNetworkIn

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNetworkIn in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricNetworkIn

      @Stability(Experimental) @NotNull default Metric metricNetworkIn(@NotNull Pipeline pipeline)
      (experimental) Metric for the rate of inbound network traffic to MediaLive in Mbps.

      Default: - average over 5 minutes

      Specified by:
      metricNetworkIn in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricNetworkOut

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricNetworkOut in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricNetworkOut

      @Stability(Experimental) @NotNull default Metric metricNetworkOut(@NotNull Pipeline pipeline)
      (experimental) Metric for the rate of outbound network traffic from MediaLive in Mbps.

      Default: - average over 5 minutes

      Specified by:
      metricNetworkOut in interface IChannel
      Parameters:
      pipeline - This parameter is required.

    • metricSvqTime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSvqTime in interface IChannel
      Parameters:
      pipeline - This parameter is required.
      props -

    • metricSvqTime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSvqTime in interface IChannel
      Parameters:
      pipeline - This parameter is required.