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

Class RouterOutput

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.mediaconnect.alpha.RouterOutput
All Implemented Interfaces:
IEnvironmentAware, IRouterOutputRef, IResource, IRouterOutput, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-31T10:49:55.217Z") @Stability(Experimental) public class RouterOutput extends Resource implements IRouterOutput
(experimental) Defines an AWS Elemental MediaConnect Router Output.

Example: 

 Stack stack;
 RouterNetworkInterface networkInterface;
 RouterOutput output = RouterOutput.Builder.create(stack, "SrtOutput")
         .routerOutputName("srt-output")
         .maximumBitrate(Bitrate.mbps(10))
         .routingScope(RoutingScope.REGIONAL)
         // tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
         .configuration(RouterOutputConfiguration.standard(StandardOutputConfigurationProps.builder()
                 .protocol(RouterOutputProtocol.srtListener(SrtListenerOutputProtocolProps.builder()
                         .port(9001)
                         .minimumLatency(Duration.millis(200))
                         .build()))
                 .networkInterface(networkInterface)
                 .build()))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • RouterOutput

      protected RouterOutput(software.amazon.jsii.JsiiObjectRef objRef)

    • RouterOutput

      protected RouterOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • RouterOutput

      @Stability(Experimental) public RouterOutput(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull RouterOutputProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromRouterOutputArn

      @Stability(Experimental) @NotNull public static IRouterOutput fromRouterOutputArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String routerOutputArn)
      (experimental) Import an existing Router Output from its ARN.

      The ARN only contains the service-generated ID (not the router output name). Accessing routerOutputName on an ARN import throws — use fromRouterOutputAttributes() to provide the name explicitly.

      Parameters:
      scope - The parent construct. This parameter is required.
      id - The construct id. This parameter is required.
      routerOutputArn - The ARN of the Router Output. This parameter is required.
      Returns:
      A Router Output construct

    • fromRouterOutputAttributes

      @Stability(Experimental) @NotNull public static IRouterOutput fromRouterOutputAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull RouterOutputAttributes attrs)
      (experimental) Import an existing Router Output from attributes.

      Use this when you need to reference a router output by name.

      Parameters:
      scope - The parent construct. This parameter is required.
      id - The construct id. This parameter is required.
      attrs - The Router Output attributes. This parameter is required.
      Returns:
      A Router Output construct

    • metric

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

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

    • metric

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

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

    • metricArqRequests

      @Stability(Experimental) @NotNull public Metric metricArqRequests(@Nullable MetricOptions props)
      (experimental) Metric for the number of retransmitted packets requested through ARQ.

      Applies to RIST and SRT outputs.

      Specified by:
      metricArqRequests in interface IRouterOutput
      Parameters:
      props -

    • metricArqRequests

      @Stability(Experimental) @NotNull public Metric metricArqRequests()
      (experimental) Metric for the number of retransmitted packets requested through ARQ.

      Applies to RIST and SRT outputs.

      Specified by:
      metricArqRequests in interface IRouterOutput

    • metricBitrate

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

      Specified by:
      metricBitrate in interface IRouterOutput
      Parameters:
      props -

    • metricBitrate

      @Stability(Experimental) @NotNull public Metric metricBitrate()
      (experimental) Metric for the bitrate of the router output's payload.
      Specified by:
      metricBitrate in interface IRouterOutput

    • metricConnected

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

      Applies to SRT outputs only.

      Specified by:
      metricConnected in interface IRouterOutput
      Parameters:
      props -

    • metricConnected

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

      Applies to SRT outputs only.

      Specified by:
      metricConnected in interface IRouterOutput

    • metricTotalPackets

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

      Specified by:
      metricTotalPackets in interface IRouterOutput
      Parameters:
      props -

    • metricTotalPackets

      @Stability(Experimental) @NotNull public Metric metricTotalPackets()
      (experimental) Metric for the total number of packets sent by the router output.
      Specified by:
      metricTotalPackets in interface IRouterOutput

    • getIpAddress

      @Stability(Experimental) @NotNull public String getIpAddress()
      (experimental) The IP address of the router output.
      Specified by:
      getIpAddress in interface IRouterOutput

    • getRouterOutputArn

      @Stability(Experimental) @NotNull public String getRouterOutputArn()
      (experimental) The Amazon Resource Name (ARN) of the router output.
      Specified by:
      getRouterOutputArn in interface IRouterOutput

    • getRouterOutputId

      @Stability(Experimental) @NotNull public String getRouterOutputId()
      (experimental) The unique identifier of the router output.
      Specified by:
      getRouterOutputId in interface IRouterOutput

    • getRouterOutputName

      @Stability(Experimental) @NotNull public String getRouterOutputName()
      (experimental) The name of the router output.
      Specified by:
      getRouterOutputName in interface IRouterOutput

    • getRouterOutputRef

      @Stability(Experimental) @NotNull public RouterOutputReference getRouterOutputRef()
      (experimental) A reference to this Router Output resource.

      Required by the auto-generated IRouterOutputRef interface.

      Specified by:
      getRouterOutputRef in interface IRouterOutputRef

    • getCreatedAt

      @Stability(Experimental) @Nullable public String getCreatedAt()
      (experimental) The timestamp when the router output was created.
      Specified by:
      getCreatedAt in interface IRouterOutput

    • getUpdatedAt

      @Stability(Experimental) @Nullable public String getUpdatedAt()
      (experimental) The timestamp when the router output was last updated.
      Specified by:
      getUpdatedAt in interface IRouterOutput