interface IRouterOutput 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IRouterOutputRef

Implemented by RouterOutput

Obtainable from RouterOutput.fromRouterOutputArn(), RouterOutput.fromRouterOutputAttributes()

Interface for Router Output.

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 a RouterOutput 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.

---

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 a RouterOutput resource.

---

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.

Methods

Name	Description
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 automatic repeat request (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.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

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.

Router output metrics are dimensioned by RouterOutputARN. See the MediaConnect documentation for available metric names (e.g. RouterOutputBitRate, RouterOutputTotalPackets).

---

metricArqRequests(props?)🔹

public metricArqRequests(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of retransmitted packets requested through automatic repeat request (ARQ).

Applies to RIST and SRT outputs only.

---

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.

---

with(...mixins)🔹

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

Parameters

• mixins IMixin — The mixins to apply.

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.