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

Interface IRouterInput

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, IRouterInputRef, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IRouterInput.Jsii$Default
All Known Implementing Classes:
IRouterInput.Jsii$Proxy, RouterInput
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-31T10:49:55.177Z") @Stability(Experimental) public interface IRouterInput extends software.amazon.jsii.JsiiSerializable, IResource, IRouterInputRef
(experimental) Interface for Router Input.

  • Method Details

    • getEndpoints

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

    • getGrants

      @Stability(Experimental) @NotNull RouterInputGrants getGrants()
      (experimental) Collection of grant methods for this router input.

    • getIpAddress

      @Stability(Experimental) @NotNull String getIpAddress()
      (experimental) The IP address of the router input.

    • getRouterInputArn

      @Stability(Experimental) @NotNull String getRouterInputArn()
      (experimental) The Amazon Resource Name (ARN) of the router input.

    • getRouterInputId

      @Stability(Experimental) @NotNull String getRouterInputId()
      (experimental) The unique identifier of the router input.

    • getCreatedAt

      @Stability(Experimental) @Nullable default String getCreatedAt()
      (experimental) The timestamp when the router input was created.

    • 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.

    • getUpdatedAt

      @Stability(Experimental) @Nullable default String getUpdatedAt()
      (experimental) The timestamp when the router input was last updated.

    • metric

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

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Parameters:
      metricName - This parameter is required.

    • metricBitrate

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

      Default: - average over 60 seconds

      Parameters:
      props -

    • metricBitrate

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

      Default: - average over 60 seconds

    • metricConnected

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

      Parameters:
      props -

    • metricConnected

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

      Applies to SRT sources only.

      Default: - minimum over 60 seconds

    • metricContinuityCounterErrors

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

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricContinuityCounterErrors

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

      Default: - sum over 60 seconds

    • metricFailoverSwitches

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

      Parameters:
      props -

    • metricFailoverSwitches

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

      Default: - sum over 60 seconds

    • metricLatency

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

      Parameters:
      props -

    • metricLatency

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

      Applies to RIST, SRT, and RTP-FEC.

      Default: - average over 60 seconds

    • metricNotRecoveredPackets

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

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricNotRecoveredPackets

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

      Default: - sum over 60 seconds

    • metricTotalPackets

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

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricTotalPackets

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

      Default: - sum over 60 seconds