AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Elemental MediaConnect CreateRouterInput API operation.

Syntax

New-EMCNRouterInput
-SourceTransitDecryption_EncryptionKeyConfiguration_Automatic <AutomaticEncryptionKeyConfiguration>
-TransitEncryption_EncryptionKeyConfiguration_Automatic <AutomaticEncryptionKeyConfiguration>
-AvailabilityZone <String>
-PreferredDayTime_Day <Day>
-MaintenanceConfiguration_Default <DefaultMaintenanceConfiguration>
-SourceTransitDecryption_EncryptionKeyType <FlowTransitEncryptionKeyType>
-TransitEncryption_EncryptionKeyType <RouterInputTransitEncryptionKeyType>
-MediaConnectFlow_FlowArn <String>
-MediaConnectFlow_FlowOutputArn <String>
-Rtp_ForwardErrorCorrection <ForwardErrorCorrectionState>
-MaximumBitrate <Int64>
-Merge_MergeRecoveryWindowMillisecond <Int64>
-SrtCaller_MinimumLatencyMillisecond <Int64>
-SrtListener_MinimumLatencyMillisecond <Int64>
-Name <String>
-Failover_NetworkInterfaceArn <String>
-Merge_NetworkInterfaceArn <String>
-Standard_NetworkInterfaceArn <String>
-Rist_Port <Int32>
-Rtp_Port <Int32>
-SrtListener_Port <Int32>
-Failover_PrimarySourceIndex <Int32>
-Standard_Protocol <RouterInputProtocol>
-Failover_ProtocolConfiguration <FailoverRouterInputProtocolConfiguration[]>
-Merge_ProtocolConfiguration <MergeRouterInputProtocolConfiguration[]>
-Rist_RecoveryLatencyMillisecond <Int64>
-RegionName <String>
-SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_RoleArn <String>
-SrtCaller_DecryptionConfiguration_EncryptionKey_RoleArn <String>
-SrtListener_DecryptionConfiguration_EncryptionKey_RoleArn <String>
-TransitEncryption_EncryptionKeyConfiguration_SecretsManager_RoleArn <String>
-RoutingScope <RoutingScope>
-SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_SecretArn <String>
-SrtCaller_DecryptionConfiguration_EncryptionKey_SecretArn <String>
-SrtListener_DecryptionConfiguration_EncryptionKey_SecretArn <String>
-TransitEncryption_EncryptionKeyConfiguration_SecretsManager_SecretArn <String>
-SrtCaller_SourceAddress <String>
-SrtCaller_SourcePort <Int32>
-Failover_SourcePriorityMode <FailoverInputSourcePriorityMode>
-SrtCaller_StreamId <String>
-Tag <Hashtable>
-Tier <RouterInputTier>
-PreferredDayTime_Time <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaConnectConfig>

Description

Creates a new router input in AWS Elemental MediaConnect.

Parameters

-AvailabilityZone <String>
The Availability Zone where you want to create the router input. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaConnectConfig>
Amazon.PowerShell.Cmdlets.EMCN.AmazonMediaConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique identifier for the request to ensure idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Failover_NetworkInterfaceArn <String>
The ARN of the network interface to use for this failover router input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Failover_NetworkInterfaceArn
-Failover_PrimarySourceIndex <Int32>
The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Failover_PrimarySourceIndex
-Failover_ProtocolConfiguration <FailoverRouterInputProtocolConfiguration[]>
A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Failover_ProtocolConfigurations
-Failover_SourcePriorityMode <FailoverInputSourcePriorityMode>
The mode for determining source priority in failover configurations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Failover_SourcePriorityMode
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceConfiguration_Default <DefaultMaintenanceConfiguration>
Default maintenance configuration settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumBitrate <Int64>
The maximum bitrate for the router input.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaConnectFlow_FlowArn <String>
The ARN of the flow to connect to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_FlowArn
-MediaConnectFlow_FlowOutputArn <String>
The ARN of the flow output to connect to this router input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_FlowOutputArn
-Merge_MergeRecoveryWindowMillisecond <Int64>
The time window in milliseconds for merging the two input sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Merge_MergeRecoveryWindowMilliseconds
-Merge_NetworkInterfaceArn <String>
The ARN of the network interface to use for this merge router input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Merge_NetworkInterfaceArn
-Merge_ProtocolConfiguration <MergeRouterInputProtocolConfiguration[]>
A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Merge_ProtocolConfigurations
-Name <String>
The name of the router input.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredDayTime_Day <Day>
The preferred day for maintenance operations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaintenanceConfiguration_PreferredDayTime_Day
-PreferredDayTime_Time <String>
The preferred time for maintenance operations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaintenanceConfiguration_PreferredDayTime_Time
-RegionName <String>
The AWS Region for the router input. Defaults to the current region if not specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rist_Port <Int32>
The port number used for the RIST protocol in the router input configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_Rist_Port
-Rist_RecoveryLatencyMillisecond <Int64>
The recovery latency in milliseconds for the RIST protocol in the router input configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_Rist_RecoveryLatencyMilliseconds
-RoutingScope <RoutingScope>
Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rtp_ForwardErrorCorrection <ForwardErrorCorrectionState>
The state of forward error correction for the RTP protocol in the router input configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_Rtp_ForwardErrorCorrection
-Rtp_Port <Int32>
The port number used for the RTP protocol in the router input configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_Rtp_Port
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RouterInput'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaConnect.Model.CreateRouterInputResponse). Specifying the name of a property of type Amazon.MediaConnect.Model.CreateRouterInputResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceTransitDecryption_EncryptionKeyConfiguration_Automatic <AutomaticEncryptionKeyConfiguration>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_SourceTransitDecryption_EncryptionKeyConfiguration_Automatic
-SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_RoleArn <String>
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_RoleArn
-SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_SecretArn <String>
The ARN of the AWS Secrets Manager secret used for transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_SourceTransitDecryption_EncryptionKeyConfiguration_SecretsManager_SecretArn
-SourceTransitDecryption_EncryptionKeyType <FlowTransitEncryptionKeyType>
The type of encryption key to use for flow transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_MediaConnectFlow_SourceTransitDecryption_EncryptionKeyType
-SrtCaller_DecryptionConfiguration_EncryptionKey_RoleArn <String>
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_DecryptionConfiguration_EncryptionKey_RoleArn
-SrtCaller_DecryptionConfiguration_EncryptionKey_SecretArn <String>
The ARN of the AWS Secrets Manager secret used for transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_DecryptionConfiguration_EncryptionKey_SecretArn
-SrtCaller_MinimumLatencyMillisecond <Int64>
The minimum latency in milliseconds for the SRT protocol in caller mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_MinimumLatencyMilliseconds
-SrtCaller_SourceAddress <String>
The source IP address for the SRT protocol in caller mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_SourceAddress
-SrtCaller_SourcePort <Int32>
The source port number for the SRT protocol in caller mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_SourcePort
-SrtCaller_StreamId <String>
The stream ID for the SRT protocol in caller mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_StreamId
-SrtListener_DecryptionConfiguration_EncryptionKey_RoleArn <String>
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtListener_DecryptionConfiguration_EncryptionKey_RoleArn
-SrtListener_DecryptionConfiguration_EncryptionKey_SecretArn <String>
The ARN of the AWS Secrets Manager secret used for transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtListener_DecryptionConfiguration_EncryptionKey_SecretArn
-SrtListener_MinimumLatencyMillisecond <Int64>
The minimum latency in milliseconds for the SRT protocol in listener mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtListener_MinimumLatencyMilliseconds
-SrtListener_Port <Int32>
The port number for the SRT protocol in listener mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtListener_Port
-Standard_NetworkInterfaceArn <String>
The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_NetworkInterfaceArn
-Standard_Protocol <RouterInputProtocol>
The protocol used by the standard router input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_Protocol
-Tag <Hashtable>
Key-value pairs that can be used to tag and organize this router input. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Tier <RouterInputTier>
The tier level for the router input.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransitEncryption_EncryptionKeyConfiguration_Automatic <AutomaticEncryptionKeyConfiguration>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransitEncryption_EncryptionKeyConfiguration_SecretsManager_RoleArn <String>
The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransitEncryption_EncryptionKeyConfiguration_SecretsManager_SecretArn <String>
The ARN of the AWS Secrets Manager secret used for transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransitEncryption_EncryptionKeyType <RouterInputTransitEncryptionKeyType>
Specifies the type of encryption key to use for transit encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.MediaConnect.Model.RouterInput or Amazon.MediaConnect.Model.CreateRouterInputResponse
This cmdlet returns an Amazon.MediaConnect.Model.RouterInput object. The service call response (type Amazon.MediaConnect.Model.CreateRouterInputResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z