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 RegisterDestinationEndpoint API operation.

Syntax

Register-EMCNDestinationEndpoint
-Description <String>
-Configuration_Standard_ProtocolConfiguration_Rist_DestinationAddress <String>
-Configuration_Standard_ProtocolConfiguration_Rtp_DestinationAddress <String>
-Configuration_Standard_ProtocolConfiguration_SrtListener_DestinationAddress <String>
-Configuration_Standard_DestinationNetworkingConfiguration_Public_DestinationAllowRule <PublicDestinationEndpointNetworkingConfigurationAllowRule[]>
-Configuration_Standard_ProtocolConfiguration_Rist_DestinationIngestPort <Int32>
-Configuration_Standard_ProtocolConfiguration_Rtp_DestinationIngestPort <Int32>
-Configuration_Standard_ProtocolConfiguration_SrtListener_DestinationIngestPort <Int32>
-Configuration_Standard_DestinationNetworkingType <DestinationEndpointNetworkingType>
-Configuration_Standard_ProtocolConfiguration_Rtp_ForwardErrorCorrectionState <ForwardErrorCorrectionState>
-Configuration_Standard_ProtocolConfiguration_SrtCaller_MinimumLatencyMillisecond <Int64>
-Configuration_Standard_ProtocolConfiguration_SrtListener_MinimumLatencyMillisecond <Int64>
-Configuration_Standard_Name <String>
-Configuration_Standard_Protocol <DestinationEndpointProtocol>
-RegionName <String>
-Configuration_RouterInput_RouterInputArn <String>
-Configuration_Standard_ProtocolConfiguration_SrtCaller_EncryptionPassphrase_SecretArn <String>
-Configuration_Standard_ProtocolConfiguration_SrtListener_EncryptionPassphrase_SecretArn <String>
-Configuration_Standard_DestinationNetworkingConfiguration_Vpc_SecurityGroupId <String[]>
-Configuration_Standard_ProtocolConfiguration_SrtCaller_SourceListenerPort <Int32>
-Configuration_Standard_ProtocolConfiguration_SrtListener_StreamId <String>
-Configuration_Standard_DestinationNetworkingConfiguration_Vpc_SubnetId <String>
-Tag <Hashtable>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaConnectConfig>

Description

Registers a new destination endpoint in MediaConnect.

Parameters

-ClientConfig <AmazonMediaConnectConfig>
Amazon.PowerShell.Cmdlets.EMCN.AmazonMediaConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If this token matches a previous request, the service ignores the request, but does not return an error.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_RouterInput_RouterInputArn <String>
The Amazon Resource Name (ARN) of the router input that the destination endpoint represents.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_DestinationNetworkingConfiguration_Public_DestinationAllowRule <PublicDestinationEndpointNetworkingConfigurationAllowRule[]>
The rules that specify which CIDR blocks can connect to the destination endpoint. You can specify up to 10 rules. 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_Standard_DestinationNetworkingConfiguration_Public_DestinationAllowRules
-Configuration_Standard_DestinationNetworkingConfiguration_Vpc_SecurityGroupId <String[]>
The IDs of the security groups to associate with the destination endpoint. You can specify from 1 to 5 security groups. 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_Standard_DestinationNetworkingConfiguration_Vpc_SecurityGroupIds
-Configuration_Standard_DestinationNetworkingConfiguration_Vpc_SubnetId <String>
The ID of the subnet to use for the destination endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_DestinationNetworkingType <DestinationEndpointNetworkingType>
The networking type of the destination endpoint. Valid values include the following:
  • PUBLIC – The destination endpoint is publicly accessible.
  • VPC – The destination endpoint is in a virtual private cloud (VPC).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_Name <String>
The name of the destination endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_Protocol <DestinationEndpointProtocol>
The protocol used by the destination endpoint. Valid values include the following:
  • RTP – Real-time Transport Protocol.
  • RIST – Reliable Internet Stream Transport.
  • SRT_CALLER – Secure Reliable Transport (SRT) in caller mode.
  • SRT_LISTENER – Secure Reliable Transport (SRT) in listener mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_Rist_DestinationAddress <String>
The IP address on which the destination endpoint receives content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_Rist_DestinationIngestPort <Int32>
The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_Rtp_DestinationAddress <String>
The IP address on which the destination endpoint receives content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_Rtp_DestinationIngestPort <Int32>
The port on which the destination endpoint receives content. The valid range is 1024 to 65531.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_Rtp_ForwardErrorCorrectionState <ForwardErrorCorrectionState>
Indicates whether forward error correction (FEC) is enabled for the destination endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtCaller_EncryptionPassphrase_SecretArn <String>
The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtCaller_MinimumLatencyMillisecond <Int64>
The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtCaller_MinimumLatencyMilliseconds
-Configuration_Standard_ProtocolConfiguration_SrtCaller_SourceListenerPort <Int32>
The port on which the source listens for the connection. The valid range is 3000 to 30000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtListener_DestinationAddress <String>
The IP address on which the destination endpoint listens for incoming connections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtListener_DestinationIngestPort <Int32>
The port on which the destination endpoint listens for incoming connections. The valid range is 0 to 65531.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtListener_EncryptionPassphrase_SecretArn <String>
The ARN of the Secrets Manager secret that holds the key or passphrase. The secret must be encrypted with a customer managed Amazon Web Services KMS key that is enabled and symmetric; it cannot use the Amazon Web Services managed key aws/secretsmanager. The secret must be in the same Amazon Web Services account and Region as the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_Standard_ProtocolConfiguration_SrtListener_MinimumLatencyMillisecond <Int64>
The minimum latency, in milliseconds, for the SRT connection. The valid range is 10 to 10000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Standard_ProtocolConfiguration_SrtListener_MinimumLatencyMilliseconds
-Configuration_Standard_ProtocolConfiguration_SrtListener_StreamId <String>
The stream ID that identifies the content for the SRT connection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description to help you identify the destination endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-RegionName <String>
The name of the Amazon Web Services Region in which to register the destination endpoint. Defaults to the current region if not specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DestinationEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaConnect.Model.RegisterDestinationEndpointResponse). Specifying the name of a property of type Amazon.MediaConnect.Model.RegisterDestinationEndpointResponse 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)
-Tag <Hashtable>
The tags to apply to the destination endpoint. Each tag is a key-value pair. 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

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.DestinationEndpoint or Amazon.MediaConnect.Model.RegisterDestinationEndpointResponse
This cmdlet returns an Amazon.MediaConnect.Model.DestinationEndpoint object. The service call response (type Amazon.MediaConnect.Model.RegisterDestinationEndpointResponse) 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