class RouterOutput (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaConnect.Alpha.RouterOutput
Go	github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#RouterOutput
Java	software.amazon.awscdk.services.mediaconnect.alpha.RouterOutput
Python	aws_cdk.aws_mediaconnect_alpha.RouterOutput
TypeScript (source)	@aws-cdk/aws-mediaconnect-alpha » RouterOutput

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IRouterOutput, IRouterOutputRef

Defines an AWS Elemental MediaConnect Router Output.

Example

declare const stack: Stack;
declare const networkInterface: RouterNetworkInterface;

const output = new RouterOutput(stack, 'SrtOutput', {
  routerOutputName: 'srt-output',
  maximumBitrate: Bitrate.mbps(10),
  routingScope: RoutingScope.REGIONAL,
  // tier defaults to RouterOutputTier.OUTPUT_20 (lowest cost)
  configuration: RouterOutputConfiguration.standard({
    protocol: RouterOutputProtocol.srtListener({
      port: 9001,
      minimumLatency: Duration.millis(200),
    }),
    networkInterface: networkInterface,
  }),
});

Initializer

new RouterOutput(scope: Construct, id: string, props: RouterOutputProps)

Parameters

• scope Construct
• id string
• props RouterOutputProps

Construct Props

Name	Type	Description
configuration🔹	RouterOutputConfiguration	Configuration for the Router Output (standard, MediaConnect Flow, or MediaLive).
maximumBitrate🔹	Bitrate	Maximum bitrate in bits per second that the Router Output can handle.
routingScope🔹	RoutingScope	Routing scope for the Router Output.
maintenanceConfiguration?🔹	MaintenanceConfiguration	Maintenance window configuration.
regionName?🔹	string	AWS region where the Router Output will be created.
routerOutputName?🔹	string	Name of the Router Output.
tags?🔹	{ [string]: string }	Tags to add to the Router Output.
tier?🔹	RouterOutputTier	Routing tier that determines the maximum number of outputs.

---

configuration🔹

Type: RouterOutputConfiguration

Configuration for the Router Output (standard, MediaConnect Flow, or MediaLive).

---

maximumBitrate🔹

Type: Bitrate

Maximum bitrate in bits per second that the Router Output can handle.

---

routingScope🔹

Type: RoutingScope

Routing scope for the Router Output.

---

maintenanceConfiguration?🔹

Type: MaintenanceConfiguration (optional, default: Default maintenance window will be used)

Maintenance window configuration.

---

regionName?🔹

Type: string (optional, default: Defaults to the same region as stack)

AWS region where the Router Output will be created.

---

routerOutputName?🔹

Type: string (optional, default: Generated automatically)

Name of the Router Output.

---

tags?🔹

Type: { [string]: string } (optional, default: No tagging)

Tags to add to the Router Output.

---

tier?🔹

Type: RouterOutputTier (optional, default: RouterOutputTier.OUTPUT_20)

Routing tier that determines the maximum number of outputs.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
ipAddress🔹	string	The IP address of the router output.
node🔹	Node	The tree node.
routerOutputArn🔹	string	The Amazon Resource Name (ARN) of the router output.
routerOutputId🔹	string	The unique identifier of the router output.
routerOutputName🔹	string	The name of the router output.
routerOutputRef🔹	RouterOutputReference	A reference to this Router Output resource.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	The timestamp when the router output was created.
updatedAt?🔹	string	The timestamp when the router output was last updated.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

ipAddress🔹

Type: string

The IP address of the router output.

---

node🔹

Type: Node

The tree node.

---

routerOutputArn🔹

Type: string

The Amazon Resource Name (ARN) of the router output.

---

routerOutputId🔹

Type: string

The unique identifier of the router output.

---

routerOutputName🔹

Type: string

The name of the router output.

---

routerOutputRef🔹

Type: RouterOutputReference

A reference to this Router Output resource.

Required by the auto-generated IRouterOutputRef interface.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

The timestamp when the router output was created.

---

updatedAt?🔹

Type: string (optional)

The timestamp when the router output was last updated.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Create a CloudWatch metric for this router output.
metricArqRequests(props?)🔹	Metric for the number of retransmitted packets requested through ARQ.
metricBitrate(props?)🔹	Metric for the bitrate of the router output's payload.
metricConnected(props?)🔹	Metric for the router output connection state (1 connected, 0 disconnected).
metricTotalPackets(props?)🔹	Metric for the total number of packets sent by the router output.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromRouterOutputArn(scope, id, routerOutputArn)🔹	Import an existing Router Output from its ARN.
static fromRouterOutputAttributes(scope, id, attrs)🔹	Import an existing Router Output from attributes.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Create a CloudWatch metric for this router output.

---

metricArqRequests(props?)🔹

public metricArqRequests(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of retransmitted packets requested through ARQ.

Applies to RIST and SRT outputs.

---

metricBitrate(props?)🔹

public metricBitrate(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the bitrate of the router output's payload.

---

metricConnected(props?)🔹

public metricConnected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the router output connection state (1 connected, 0 disconnected).

Applies to SRT outputs only.

---

metricTotalPackets(props?)🔹

public metricTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the total number of packets sent by the router output.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• 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. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromRouterOutputArn(scope, id, routerOutputArn)🔹

public static fromRouterOutputArn(scope: Construct, id: string, routerOutputArn: string): IRouterOutput

Parameters

• scope Construct — The parent construct.
• id string — The construct id.
• routerOutputArn string — The ARN of the Router Output.

Returns

• IRouterOutput

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.

---

static fromRouterOutputAttributes(scope, id, attrs)🔹

public static fromRouterOutputAttributes(scope: Construct, id: string, attrs: RouterOutputAttributes): IRouterOutput

Parameters

• scope Construct — The parent construct.
• id string — The construct id.
• attrs RouterOutputAttributes — The Router Output attributes.

Returns

• IRouterOutput

Import an existing Router Output from attributes.

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