interface IRouterInput 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IRouterInputRef

Implemented by RouterInput

Obtainable from RouterInput.fromRouterInputArn(), RouterInput.fromRouterInputAttributes()

Interface for Router Input.

Properties

Name	Type	Description
endpoints🔹	RouterInputEndpoint[]	The ingest endpoints (URL + port) where the router input listens.
env🔹	ResourceEnvironment	The environment this resource belongs to.
grants🔹	RouterInputGrants	Collection of grant methods for this router input.
ipAddress🔹	string	The IP address of the router input.
node🔹	Node	The tree node.
routerInputArn🔹	string	The Amazon Resource Name (ARN) of the router input.
routerInputId🔹	string	The unique identifier of the router input.
routerInputRef🔹	RouterInputReference	A reference to a RouterInput resource.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	The timestamp when the router input was created.
transitEncryptionSecret?🔹	ISecret	The Secrets Manager secret containing the transit encryption passphrase.
updatedAt?🔹	string	The timestamp when the router input was last updated.

---

endpoints🔹

Type: RouterInputEndpoint[]

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.

---

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.

---

grants🔹

Type: RouterInputGrants

Collection of grant methods for this router input.

---

ipAddress🔹

Type: string

The IP address of the router input.

---

node🔹

Type: Node

The tree node.

---

routerInputArn🔹

Type: string

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

---

routerInputId🔹

Type: string

The unique identifier of the router input.

---

routerInputRef🔹

Type: RouterInputReference

A reference to a RouterInput resource.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

The timestamp when the router input was created.

---

transitEncryptionSecret?🔹

Type: ISecret (optional)

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.

---

updatedAt?🔹

Type: string (optional)

The timestamp when the router input 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 input.
metricBitrate(props?)🔹	Metric for the bitrate of the router input's payload.
metricConnected(props?)🔹	Metric for the router input connection state (1 connected, 0 disconnected).
metricContinuityCounterErrors(props?)🔹	Metric for continuity counter errors in the transport stream.
metricFailoverSwitches(props?)🔹	Metric for the number of times the router input has switched sources in Failover mode.
metricLatency(props?)🔹	Metric for the recovery latency of the input stream.
metricNotRecoveredPackets(props?)🔹	Metric for packets lost in transit that were not recovered by error correction.
metricTotalPackets(props?)🔹	Metric for the total number of packets received by the router input.
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 input.

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

---

metricBitrate(props?)🔹

public metricBitrate(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

metricConnected(props?)🔹

public metricConnected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Applies to SRT sources only.

---

metricContinuityCounterErrors(props?)🔹

public metricContinuityCounterErrors(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for continuity counter errors in the transport stream.

---

metricFailoverSwitches(props?)🔹

public metricFailoverSwitches(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times the router input has switched sources in Failover mode.

---

metricLatency(props?)🔹

public metricLatency(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the recovery latency of the input stream.

Applies to RIST, SRT, and RTP-FEC.

---

metricNotRecoveredPackets(props?)🔹

public metricNotRecoveredPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for packets lost in transit that were not recovered by error correction.

---

metricTotalPackets(props?)🔹

public metricTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the total number of packets received by the router input.

---

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.