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.119.0 (build 1634eac)",
date="2025-11-20T23:37:25.032Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnRouterInput.static interfaceConfiguration settings for a failover router input that allows switching between two input sources.static interfaceExample:static interfaceExample:static interfaceThe configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.static interfaceExample:static interfaceConfiguration settings for connecting a router input to a flow output.static interfaceConfiguration settings for a merge router input that combines two input sources.static interfaceExample:static interfaceConfiguration for preferred day and time maintenance settings.static interfaceThe configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.static interfaceExample:static interfaceExample:static interfaceExample:static interfaceThe transit encryption settings for a router input.static interfaceThe configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.static interfaceThe configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.static interfaceThe 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 interfaceContains the configuration settings for decrypting SRT streams, including the encryption key details and decryption parameters.static interfaceThe 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 interfaceThe 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.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.mediaconnect.IRouterInputRef
IRouterInputRef.Jsii$Default, IRouterInputRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnRouterInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnRouterInput(software.amazon.jsii.JsiiObjectRef objRef) CfnRouterInput(software.constructs.Construct scope, String id, CfnRouterInputProps props) Create a newAWS::MediaConnect::RouterInput. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForRouterInput(IRouterInputRef resource) The timestamp when the router input was created.The unique identifier of the router input.The IP address of the router input.The number of router outputs associated with the router input.The timestamp when the router input was last updated.The Availability Zone where you want to create the router input.Tag Manager which manages the tags for this resource.The configuration settings for a router input.The configuration settings for maintenance operations, including preferred maintenance windows and schedules.The maximum bitrate for the router input.getName()The name of the router input.The AWS Region for the router input.A reference to a RouterInput resource.getTags()Key-value pairs that can be used to tag and organize this router input.getTier()Information about the encryption of the flow.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetAvailabilityZone(String value) The Availability Zone where you want to create the router input.voidsetConfiguration(IResolvable value) The configuration settings for a router input.voidThe configuration settings for a router input.voidThe configuration settings for maintenance operations, including preferred maintenance windows and schedules.voidThe configuration settings for maintenance operations, including preferred maintenance windows and schedules.voidsetMaximumBitrate(Number value) The maximum bitrate for the router input.voidThe name of the router input.voidsetRegionName(String value) The AWS Region for the router input.voidsetRoutingScope(String value) voidKey-value pairs that can be used to tag and organize this router input.voidvoidsetTransitEncryption(IResolvable value) Information about the encryption of the flow.voidInformation about the encryption of the flow.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, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::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.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
-
getAttrCreatedAt
The timestamp when the router input was created. -
getAttrId
The unique identifier of the router input. -
getAttrInputType
-
getAttrIpAddress
The IP address of the router input. -
getAttrMaintenanceType
-
getAttrRoutedOutputs
The number of router outputs associated with the router input. -
getAttrState
-
getAttrUpdatedAt
The timestamp when the router input was last updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManagerin interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getRouterInputRef
A reference to a RouterInput resource.- Specified by:
getRouterInputRefin interfaceIRouterInputRef
-
getConfiguration
The configuration settings for a router input.Returns union: either
IResolvableorCfnRouterInput.RouterInputConfigurationProperty -
setConfiguration
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
The maximum bitrate for the router input. -
setMaximumBitrate
The maximum bitrate for the router input. -
getName
The name of the router input. -
setName
The name of the router input. -
getRoutingScope
-
setRoutingScope
-
getTier
-
setTier
-
getAvailabilityZone
The Availability Zone where you want to create the router input. -
setAvailabilityZone
The Availability Zone where you want to create the router input. -
getMaintenanceConfiguration
The configuration settings for maintenance operations, including preferred maintenance windows and schedules.Returns union: either
IResolvableorCfnRouterInput.MaintenanceConfigurationProperty -
setMaintenanceConfiguration
The configuration settings for maintenance operations, including preferred maintenance windows and schedules. -
setMaintenanceConfiguration
@Stability(Stable) public void setMaintenanceConfiguration(@Nullable CfnRouterInput.MaintenanceConfigurationProperty value) The configuration settings for maintenance operations, including preferred maintenance windows and schedules. -
getRegionName
The AWS Region for the router input. -
setRegionName
The AWS Region for the router input. -
getTags
Key-value pairs that can be used to tag and organize this router input. -
setTags
Key-value pairs that can be used to tag and organize this router input. -
getTransitEncryption
Information about the encryption of the flow.Returns union: either
IResolvableorCfnRouterInput.RouterInputTransitEncryptionProperty -
setTransitEncryption
Information about the encryption of the flow. -
setTransitEncryption
@Stability(Stable) public void setTransitEncryption(@Nullable CfnRouterInput.RouterInputTransitEncryptionProperty value) Information about the encryption of the flow.
-