@aws-cdk/aws-mediaconnect-alpha.IRouterInput

Experimental

@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IRouterInput Interface

Interface for Router Input.

IRouterInput

extends

• IResource,
• IRouterInputRef

implemented by

• RouterInput

Stability

Experimental

Source

lib/router-input.ts

Properties

createdAt?may be undefinedstringcreated_at?may be undefinedstrcreatedAt?may be undefinedStringCreatedAt?may be undefinedstringCreatedAt?may be undefined*string#

The timestamp when the router input was created.

endpointsRouterInputEndpoint[]endpointstyping.List[RouterInputEndpoint]endpointsList<RouterInputEndpoint>EndpointsRouterInputEndpoint[]Endpoints*[]RouterInputEndpointrequired#

The ingest endpoints (URL + port) where the router input listens.

notes

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.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

grantsRouterInputGrantsgrantsRouterInputGrantsgrantsRouterInputGrantsGrantsRouterInputGrantsGrantsRouterInputGrantsrequired#

Collection of grant methods for this router input.

ipAddressstringip_addressstripAddressStringIpAddressstringIpAddress*stringrequired#

The IP address of the router input.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

routerInputArnstringrouter_input_arnstrrouterInputArnStringRouterInputArnstringRouterInputArn*stringrequired#

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

routerInputIdstringrouter_input_idstrrouterInputIdStringRouterInputIdstringRouterInputId*stringrequired#

The unique identifier of the router input.

routerInputRefRouterInputReferencerouter_input_refRouterInputReferencerouterInputRefRouterInputReferenceRouterInputRefRouterInputReferenceRouterInputRefRouterInputReferencerequired#

A reference to a RouterInput resource.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

transitEncryptionSecret?may be undefinedISecrettransit_encryption_secret?may be undefinedISecrettransitEncryptionSecret?may be undefinedISecretTransitEncryptionSecret?may be undefinedISecretTransitEncryptionSecret?may be undefinedISecret#

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?may be undefinedstringupdated_at?may be undefinedstrupdatedAt?may be undefinedStringUpdatedAt?may be undefinedstringUpdatedAt?may be undefined*string#

The timestamp when the router input was last updated.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) 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?: MetricOptions): Metricdef metric_bitrate(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricBitrate(MetricOptions props)public Metric MetricBitrate(MetricOptions? props = null)func MetricBitrate(Props MetricOptions) Metric#

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

metricConnected(props?: MetricOptions): Metricdef metric_connected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricConnected(MetricOptions props)public Metric MetricConnected(MetricOptions? props = null)func MetricConnected(Props MetricOptions) Metric#

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

Applies to SRT sources only.

metricContinuityCounterErrors(props?: MetricOptions): Metricdef metric_continuity_counter_errors(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricContinuityCounterErrors(MetricOptions props)public Metric MetricContinuityCounterErrors(MetricOptions? props = null)func MetricContinuityCounterErrors(Props MetricOptions) Metric#

Metric for continuity counter errors in the transport stream.

metricFailoverSwitches(props?: MetricOptions): Metricdef metric_failover_switches(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricFailoverSwitches(MetricOptions props)public Metric MetricFailoverSwitches(MetricOptions? props = null)func MetricFailoverSwitches(Props MetricOptions) Metric#

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

metricLatency(props?: MetricOptions): Metricdef metric_latency(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricLatency(MetricOptions props)public Metric MetricLatency(MetricOptions? props = null)func MetricLatency(Props MetricOptions) Metric#

Metric for the recovery latency of the input stream.

Applies to RIST, SRT, and RTP-FEC.

metricNotRecoveredPackets(props?: MetricOptions): Metricdef metric_not_recovered_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricNotRecoveredPackets(MetricOptions props)public Metric MetricNotRecoveredPackets(MetricOptions? props = null)func MetricNotRecoveredPackets(Props MetricOptions) Metric#

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

metricTotalPackets(props?: MetricOptions): Metricdef metric_total_packets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTotalPackets(MetricOptions props)public Metric MetricTotalPackets(MetricOptions? props = null)func MetricTotalPackets(Props MetricOptions) Metric#

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

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining