Package software.amazon.awscdk.services.mediaconnect

Class CfnRouterInput

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediaconnect.CfnRouterInput

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IRouterInputRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:14.219Z")
@Stability(Stable)
public class CfnRouterInput
extends CfnResource
implements IInspectable, IRouterInputRef, ITaggableV2

Represents a router input in AWS Elemental MediaConnect that is used to ingest content to be transmitted to router outputs.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconnect.*;
 Object automatic;
 Object default_;
 CfnRouterInput cfnRouterInput = CfnRouterInput.Builder.create(this, "MyCfnRouterInput")
         .configuration(RouterInputConfigurationProperty.builder()
                 .failover(FailoverRouterInputConfigurationProperty.builder()
                         .networkInterfaceArn("networkInterfaceArn")
                         .protocolConfigurations(List.of(FailoverRouterInputProtocolConfigurationProperty.builder()
                                 .rist(RistRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         .recoveryLatencyMilliseconds(123)
                                         .build())
                                 .rtp(RtpRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         // the properties below are optional
                                         .forwardErrorCorrection("forwardErrorCorrection")
                                         .build())
                                 .srtCaller(SrtCallerRouterInputConfigurationProperty.builder()
                                         .minimumLatencyMilliseconds(123)
                                         .sourceAddress("sourceAddress")
                                         .sourcePort(123)
                                         // the properties below are optional
                                         .decryptionConfiguration(SrtDecryptionConfigurationProperty.builder()
                                                 .encryptionKey(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                                         .roleArn("roleArn")
                                                         .secretArn("secretArn")
                                                         .build())
                                                 .build())
                                         .streamId("streamId")
                                         .build())
                                 .srtListener(SrtListenerRouterInputConfigurationProperty.builder()
                                         .minimumLatencyMilliseconds(123)
                                         .port(123)
                                         // the properties below are optional
                                         .decryptionConfiguration(SrtDecryptionConfigurationProperty.builder()
                                                 .encryptionKey(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                                         .roleArn("roleArn")
                                                         .secretArn("secretArn")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build()))
                         .sourcePriorityMode("sourcePriorityMode")
                         // the properties below are optional
                         .primarySourceIndex(123)
                         .build())
                 .mediaConnectFlow(MediaConnectFlowRouterInputConfigurationProperty.builder()
                         .sourceTransitDecryption(FlowTransitEncryptionProperty.builder()
                                 .encryptionKeyConfiguration(FlowTransitEncryptionKeyConfigurationProperty.builder()
                                         .automatic(automatic)
                                         .secretsManager(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                                 .roleArn("roleArn")
                                                 .secretArn("secretArn")
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .encryptionKeyType("encryptionKeyType")
                                 .build())
                         // the properties below are optional
                         .flowArn("flowArn")
                         .flowOutputArn("flowOutputArn")
                         .build())
                 .merge(MergeRouterInputConfigurationProperty.builder()
                         .mergeRecoveryWindowMilliseconds(123)
                         .networkInterfaceArn("networkInterfaceArn")
                         .protocolConfigurations(List.of(MergeRouterInputProtocolConfigurationProperty.builder()
                                 .rist(RistRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         .recoveryLatencyMilliseconds(123)
                                         .build())
                                 .rtp(RtpRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         // the properties below are optional
                                         .forwardErrorCorrection("forwardErrorCorrection")
                                         .build())
                                 .build()))
                         .build())
                 .standard(StandardRouterInputConfigurationProperty.builder()
                         .networkInterfaceArn("networkInterfaceArn")
                         .protocolConfiguration(RouterInputProtocolConfigurationProperty.builder()
                                 .rist(RistRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         .recoveryLatencyMilliseconds(123)
                                         .build())
                                 .rtp(RtpRouterInputConfigurationProperty.builder()
                                         .port(123)
                                         // the properties below are optional
                                         .forwardErrorCorrection("forwardErrorCorrection")
                                         .build())
                                 .srtCaller(SrtCallerRouterInputConfigurationProperty.builder()
                                         .minimumLatencyMilliseconds(123)
                                         .sourceAddress("sourceAddress")
                                         .sourcePort(123)
                                         // the properties below are optional
                                         .decryptionConfiguration(SrtDecryptionConfigurationProperty.builder()
                                                 .encryptionKey(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                                         .roleArn("roleArn")
                                                         .secretArn("secretArn")
                                                         .build())
                                                 .build())
                                         .streamId("streamId")
                                         .build())
                                 .srtListener(SrtListenerRouterInputConfigurationProperty.builder()
                                         .minimumLatencyMilliseconds(123)
                                         .port(123)
                                         // the properties below are optional
                                         .decryptionConfiguration(SrtDecryptionConfigurationProperty.builder()
                                                 .encryptionKey(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                                         .roleArn("roleArn")
                                                         .secretArn("secretArn")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         // the properties below are optional
                         .protocol("protocol")
                         .build())
                 .build())
         .maximumBitrate(123)
         .name("name")
         .routingScope("routingScope")
         .tier("tier")
         // the properties below are optional
         .availabilityZone("availabilityZone")
         .maintenanceConfiguration(MaintenanceConfigurationProperty.builder()
                 .default(default_)
                 .preferredDayTime(PreferredDayTimeMaintenanceConfigurationProperty.builder()
                         .day("day")
                         .time("time")
                         .build())
                 .build())
         .regionName("regionName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitEncryption(RouterInputTransitEncryptionProperty.builder()
                 .encryptionKeyConfiguration(RouterInputTransitEncryptionKeyConfigurationProperty.builder()
                         .automatic(automatic)
                         .secretsManager(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                 .roleArn("roleArn")
                                 .secretArn("secretArn")
                                 .build())
                         .build())
                 // the properties below are optional
                 .encryptionKeyType("encryptionKeyType")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-routerinput.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRouterInput.Builder	A fluent builder for CfnRouterInput.
static interface	CfnRouterInput.FailoverRouterInputConfigurationProperty	Configuration settings for a failover router input that allows switching between two input sources.
static interface	CfnRouterInput.FailoverRouterInputProtocolConfigurationProperty	Example:
static interface	CfnRouterInput.FlowTransitEncryptionKeyConfigurationProperty	Example:
static interface	CfnRouterInput.FlowTransitEncryptionProperty	The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
static interface	CfnRouterInput.MaintenanceConfigurationProperty	Example:
static interface	CfnRouterInput.MediaConnectFlowRouterInputConfigurationProperty	Configuration settings for connecting a router input to a flow output.
static interface	CfnRouterInput.MergeRouterInputConfigurationProperty	Configuration settings for a merge router input that combines two input sources.
static interface	CfnRouterInput.MergeRouterInputProtocolConfigurationProperty	Example:
static interface	CfnRouterInput.PreferredDayTimeMaintenanceConfigurationProperty	Configuration for preferred day and time maintenance settings.
static interface	CfnRouterInput.RistRouterInputConfigurationProperty	The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
static interface	CfnRouterInput.RouterInputConfigurationProperty	Example:
static interface	CfnRouterInput.RouterInputProtocolConfigurationProperty	Example:
static interface	CfnRouterInput.RouterInputTransitEncryptionKeyConfigurationProperty	Example:
static interface	CfnRouterInput.RouterInputTransitEncryptionProperty	The transit encryption settings for a router input.
static interface	CfnRouterInput.RtpRouterInputConfigurationProperty	The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
static interface	CfnRouterInput.SecretsManagerEncryptionKeyConfigurationProperty	The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.
static interface	CfnRouterInput.SrtCallerRouterInputConfigurationProperty	The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
static interface	CfnRouterInput.SrtDecryptionConfigurationProperty	Contains the configuration settings for decrypting SRT streams, including the encryption key details and decryption parameters.
static interface	CfnRouterInput.SrtListenerRouterInputConfigurationProperty	The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
static interface	CfnRouterInput.StandardRouterInputConfigurationProperty	The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.mediaconnect.IRouterInputRef

IRouterInputRef.Jsii$Default, IRouterInputRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnRouterInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRouterInput(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRouterInput(software.constructs.Construct scope, String id, CfnRouterInputProps props)	Create a new AWS::MediaConnect::RouterInput.

Method Summary

Modifier and Type	Method	Description
static String	arnForRouterInput(IRouterInputRef resource)
String	getAttrArn()	The Amazon Resource Name (ARN) of the router input.
String	getAttrCreatedAt()	The timestamp when the router input was created.
String	getAttrId()	The unique identifier of the router input.
String	getAttrInputType()	The type of the router input.
String	getAttrIpAddress()	The IP address of the router input.
String	getAttrMaintenanceType()	The type of maintenance configuration applied to this router input.
Number	getAttrRoutedOutputs()	The number of router outputs associated with the router input.
String	getAttrState()	The current state of the router input.
String	getAttrUpdatedAt()	The timestamp when the router input was last updated.
String	getAvailabilityZone()	The Availability Zone of the router input.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	The configuration settings for a router input.
Object	getMaintenanceConfiguration()	The maintenance configuration settings applied to this router input.
Number	getMaximumBitrate()	The maximum bitrate for the router input.
String	getName()	The name of the router input.
String	getRegionName()	The AWS Region where the router input is located.
RouterInputReference	getRouterInputRef()	A reference to a RouterInput resource.
String	getRoutingScope()	Indicates whether the router input is configured for Regional or global routing.
List<CfnTag>	getTags()	Key-value pairs that can be used to tag and organize this router input.
String	getTier()	The tier level of the router input.
Object	getTransitEncryption()	Encryption information.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnRouterInput(Object x)	Checks whether the given object is a CfnRouterInput.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAvailabilityZone(String value)	The Availability Zone of the router input.
void	setConfiguration(IResolvable value)	The configuration settings for a router input.
void	setConfiguration(CfnRouterInput.RouterInputConfigurationProperty value)	The configuration settings for a router input.
void	setMaintenanceConfiguration(IResolvable value)	The maintenance configuration settings applied to this router input.
void	setMaintenanceConfiguration(CfnRouterInput.MaintenanceConfigurationProperty value)	The maintenance configuration settings applied to this router input.
void	setMaximumBitrate(Number value)	The maximum bitrate for the router input.
void	setName(String value)	The name of the router input.
void	setRegionName(String value)	The AWS Region where the router input is located.
void	setRoutingScope(String value)	Indicates whether the router input is configured for Regional or global routing.
void	setTags(List<CfnTag> value)	Key-value pairs that can be used to tag and organize this router input.
void	setTier(String value)	The tier level of the router input.
void	setTransitEncryption(IResolvable value)	Encryption information.
void	setTransitEncryption(CfnRouterInput.RouterInputTransitEncryptionProperty value)	Encryption information.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnRouterInput

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

CfnRouterInput

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

CfnRouterInput

@Stability(Stable)
public CfnRouterInput(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRouterInputProps props)

Create a new AWS::MediaConnect::RouterInput.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForRouterInput

@Stability(Stable)
@NotNull
public static String arnForRouterInput(@NotNull
 IRouterInputRef resource)

Parameters:

resource - This parameter is required.

isCfnRouterInput

@Stability(Stable)
@NotNull
public static Boolean isCfnRouterInput(@NotNull
 Object x)

Checks whether the given object is a CfnRouterInput.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

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

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp when the router input was created.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique identifier of the router input.

getAttrInputType

@Stability(Stable)
@NotNull
public String getAttrInputType()

The type of the router input.

getAttrIpAddress

@Stability(Stable)
@NotNull
public String getAttrIpAddress()

The IP address of the router input.

getAttrMaintenanceType

@Stability(Stable)
@NotNull
public String getAttrMaintenanceType()

The type of maintenance configuration applied to this router input.

getAttrRoutedOutputs

@Stability(Stable)
@NotNull
public Number getAttrRoutedOutputs()

The number of router outputs associated with the router input.

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The current state of the router input.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp when the router input was last updated.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRouterInputRef

@Stability(Stable)
@NotNull
public RouterInputReference getRouterInputRef()

A reference to a RouterInput resource.

Specified by:

getRouterInputRef in interface IRouterInputRef

getConfiguration

@Stability(Stable)
@NotNull
public Object getConfiguration()

The configuration settings for a router input.

Returns union: either IResolvable or CfnRouterInput.RouterInputConfigurationProperty

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 IResolvable value)

The configuration settings for a router input.

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 CfnRouterInput.RouterInputConfigurationProperty value)

The configuration settings for a router input.

getMaximumBitrate

@Stability(Stable)
@NotNull
public Number getMaximumBitrate()

The maximum bitrate for the router input.

setMaximumBitrate

@Stability(Stable)
public void setMaximumBitrate(@NotNull
 Number value)

The maximum bitrate for the router input.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the router input.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the router input.

getRoutingScope

@Stability(Stable)
@NotNull
public String getRoutingScope()

Indicates whether the router input is configured for Regional or global routing.

setRoutingScope

@Stability(Stable)
public void setRoutingScope(@NotNull
 String value)

Indicates whether the router input is configured for Regional or global routing.

getTier

@Stability(Stable)
@NotNull
public String getTier()

The tier level of the router input.

setTier

@Stability(Stable)
public void setTier(@NotNull
 String value)

The tier level of the router input.

getAvailabilityZone

@Stability(Stable)
@Nullable
public String getAvailabilityZone()

The Availability Zone of the router input.

setAvailabilityZone

@Stability(Stable)
public void setAvailabilityZone(@Nullable
 String value)

The Availability Zone of the router input.

getMaintenanceConfiguration

@Stability(Stable)
@Nullable
public Object getMaintenanceConfiguration()

The maintenance configuration settings applied to this router input.

Returns union: either IResolvable or CfnRouterInput.MaintenanceConfigurationProperty

setMaintenanceConfiguration

@Stability(Stable)
public void setMaintenanceConfiguration(@Nullable
 IResolvable value)

The maintenance configuration settings applied to this router input.

setMaintenanceConfiguration

@Stability(Stable)
public void setMaintenanceConfiguration(@Nullable
 CfnRouterInput.MaintenanceConfigurationProperty value)

The maintenance configuration settings applied to this router input.

getRegionName

@Stability(Stable)
@Nullable
public String getRegionName()

The AWS Region where the router input is located.

setRegionName

@Stability(Stable)
public void setRegionName(@Nullable
 String value)

The AWS Region where the router input is located.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

Key-value pairs that can be used to tag and organize this router input.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

Key-value pairs that can be used to tag and organize this router input.

getTransitEncryption

@Stability(Stable)
@Nullable
public Object getTransitEncryption()

Encryption information.

Returns union: either IResolvable or CfnRouterInput.RouterInputTransitEncryptionProperty

setTransitEncryption

@Stability(Stable)
public void setTransitEncryption(@Nullable
 IResolvable value)

Encryption information.

setTransitEncryption

@Stability(Stable)
public void setTransitEncryption(@Nullable
 CfnRouterInput.RouterInputTransitEncryptionProperty value)

Encryption information.