Package software.amazon.awscdk.services.mediaconnect.alpha

Interface IRouterInput.Jsii$Default

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

  • Method Details

    • getEndpoints

      @Stability(Experimental) @NotNull default List<RouterInputEndpoint> getEndpoints()
      (experimental) The ingest endpoints (URL + port) where the router input listens.

      Returns one entry for standard protocol-based variants (RTP, RIST, SRT listener), and one entry per source for failover and merge configurations built from those protocols. For example a failover RTP input will return: 

       [
   { url: 'rtp://203.0.113.10:5000', port: 5000 },
   { url: 'rtp://203.0.113.10:5001', port: 5001 },
 ]

      Accessing this on SRT caller (where the router input dials out to a remote source), MediaConnect Flow, MediaLive Channel, or imported inputs throws — those variants do not expose host:port pairs the input listens on.

      Specified by:
      getEndpoints in interface IRouterInput

    • getGrants

      @Stability(Experimental) @NotNull default RouterInputGrants getGrants()
      (experimental) Collection of grant methods for this router input.
      Specified by:
      getGrants in interface IRouterInput

    • getIpAddress

      @Stability(Experimental) @NotNull default String getIpAddress()
      (experimental) The IP address of the router input.
      Specified by:
      getIpAddress in interface IRouterInput

    • getRouterInputArn

      @Stability(Experimental) @NotNull default String getRouterInputArn()
      (experimental) The Amazon Resource Name (ARN) of the router input.
      Specified by:
      getRouterInputArn in interface IRouterInput

    • getRouterInputId

      @Stability(Experimental) @NotNull default String getRouterInputId()
      (experimental) The unique identifier of the router input.
      Specified by:
      getRouterInputId in interface IRouterInput

    • getCreatedAt

      @Stability(Experimental) @Nullable default String getCreatedAt()
      (experimental) The timestamp when the router input was created.
      Specified by:
      getCreatedAt in interface IRouterInput

    • getTransitEncryptionSecret

      @Stability(Experimental) @Nullable default ISecret getTransitEncryptionSecret()
      (experimental) The Secrets Manager secret containing the transit encryption passphrase.

      Only available when the Router Input was created with explicit transitEncryption configuration. Not available for automatic encryption or imported inputs.

      Specified by:
      getTransitEncryptionSecret in interface IRouterInput

    • getUpdatedAt

      @Stability(Experimental) @Nullable default String getUpdatedAt()
      (experimental) The timestamp when the router input was last updated.
      Specified by:
      getUpdatedAt in interface IRouterInput

    • metric

      @Stability(Experimental) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Create a CloudWatch metric for this router input.

      Router input metrics are dimensioned by RouterInputARN. See the MediaConnect documentation for available metric names (e.g. RouterInputBitRate, RouterInputNotRecoveredPackets).

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

    • metric

      @Stability(Experimental) @NotNull default Metric metric(@NotNull String metricName)
      (experimental) Create a CloudWatch metric for this router input.

      Router input metrics are dimensioned by RouterInputARN. See the MediaConnect documentation for available metric names (e.g. RouterInputBitRate, RouterInputNotRecoveredPackets).

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

    • metricBitrate

      @Stability(Experimental) @NotNull default Metric metricBitrate(@Nullable MetricOptions props)
      (experimental) Metric for the bitrate of the router input's payload.

      Default: - average over 60 seconds

      Specified by:
      metricBitrate in interface IRouterInput
      Parameters:
      props -

    • metricBitrate

      @Stability(Experimental) @NotNull default Metric metricBitrate()
      (experimental) Metric for the bitrate of the router input's payload.

      Default: - average over 60 seconds

      Specified by:
      metricBitrate in interface IRouterInput

    • metricConnected

      @Stability(Experimental) @NotNull default Metric metricConnected(@Nullable MetricOptions props)
      (experimental) Metric for the router input connection state (1 connected, 0 disconnected).

      Applies to SRT sources only.

      Default: - minimum over 60 seconds

      Specified by:
      metricConnected in interface IRouterInput
      Parameters:
      props -

    • metricConnected

      @Stability(Experimental) @NotNull default Metric metricConnected()
      (experimental) Metric for the router input connection state (1 connected, 0 disconnected).

      Applies to SRT sources only.

      Default: - minimum over 60 seconds

      Specified by:
      metricConnected in interface IRouterInput

    • metricContinuityCounterErrors

      @Stability(Experimental) @NotNull default Metric metricContinuityCounterErrors(@Nullable MetricOptions props)
      (experimental) Metric for continuity counter errors in the transport stream.

      Default: - sum over 60 seconds

      Specified by:
      metricContinuityCounterErrors in interface IRouterInput
      Parameters:
      props -

    • metricContinuityCounterErrors

      @Stability(Experimental) @NotNull default Metric metricContinuityCounterErrors()
      (experimental) Metric for continuity counter errors in the transport stream.

      Default: - sum over 60 seconds

      Specified by:
      metricContinuityCounterErrors in interface IRouterInput

    • metricFailoverSwitches

      @Stability(Experimental) @NotNull default Metric metricFailoverSwitches(@Nullable MetricOptions props)
      (experimental) Metric for the number of times the router input has switched sources in Failover mode.

      Default: - sum over 60 seconds

      Specified by:
      metricFailoverSwitches in interface IRouterInput
      Parameters:
      props -

    • metricFailoverSwitches

      @Stability(Experimental) @NotNull default Metric metricFailoverSwitches()
      (experimental) Metric for the number of times the router input has switched sources in Failover mode.

      Default: - sum over 60 seconds

      Specified by:
      metricFailoverSwitches in interface IRouterInput

    • metricLatency

      @Stability(Experimental) @NotNull default Metric metricLatency(@Nullable MetricOptions props)
      (experimental) Metric for the recovery latency of the input stream.

      Applies to RIST, SRT, and RTP-FEC.

      Default: - average over 60 seconds

      Specified by:
      metricLatency in interface IRouterInput
      Parameters:
      props -

    • metricLatency

      @Stability(Experimental) @NotNull default Metric metricLatency()
      (experimental) Metric for the recovery latency of the input stream.

      Applies to RIST, SRT, and RTP-FEC.

      Default: - average over 60 seconds

      Specified by:
      metricLatency in interface IRouterInput

    • metricNotRecoveredPackets

      @Stability(Experimental) @NotNull default Metric metricNotRecoveredPackets(@Nullable MetricOptions props)
      (experimental) Metric for packets lost in transit that were not recovered by error correction.

      Default: - sum over 60 seconds

      Specified by:
      metricNotRecoveredPackets in interface IRouterInput
      Parameters:
      props -

    • metricNotRecoveredPackets

      @Stability(Experimental) @NotNull default Metric metricNotRecoveredPackets()
      (experimental) Metric for packets lost in transit that were not recovered by error correction.

      Default: - sum over 60 seconds

      Specified by:
      metricNotRecoveredPackets in interface IRouterInput

    • metricTotalPackets

      @Stability(Experimental) @NotNull default Metric metricTotalPackets(@Nullable MetricOptions props)
      (experimental) Metric for the total number of packets received by the router input.

      Default: - sum over 60 seconds

      Specified by:
      metricTotalPackets in interface IRouterInput
      Parameters:
      props -

    • metricTotalPackets

      @Stability(Experimental) @NotNull default Metric metricTotalPackets()
      (experimental) Metric for the total number of packets received by the router input.

      Default: - sum over 60 seconds

      Specified by:
      metricTotalPackets in interface IRouterInput