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

Syntax

New-EMCNFlow
-Name <String>
-SourceMonitoringConfig_AudioMonitoringSetting <AudioMonitoringSetting[]>
-AvailabilityZone <String>
-SourceMonitoringConfig_ContentQualityAnalysisState <ContentQualityAnalysisState>
-EncodingConfig_EncodingProfile <EncodingProfile>
-Entitlement <GrantEntitlementRequest[]>
-SourceFailoverConfig_FailoverMode <FailoverMode>
-FlowSize <FlowSize>
-FlowTag <Hashtable>
-NdiConfig_MachineName <String>
-Maintenance_MaintenanceDay <MaintenanceDay>
-Maintenance_MaintenanceStartHour <String>
-MediaStream <AddMediaStreamRequest[]>
-NdiConfig_NdiDiscoveryServer <NdiDiscoveryServerConfig[]>
-NdiConfig_NdiState <NdiState>
-Output <AddOutputRequest[]>
-SourcePriority_PrimarySource <String>
-SourceFailoverConfig_RecoveryWindow <Int32>
-Source <SetSourceRequest[]>
-SourceFailoverConfig_State <State>
-SourceMonitoringConfig_ThumbnailState <ThumbnailState>
-EncodingConfig_VideoMaxBitrate <Int32>
-SourceMonitoringConfig_VideoMonitoringSetting <VideoMonitoringSetting[]>
-VpcInterface <VpcInterfaceRequest[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaConnectConfig>

Description

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

Parameters

-AvailabilityZone <String>
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
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)
-EncodingConfig_EncodingProfile <EncodingProfile>
The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncodingConfig_VideoMaxBitrate <Int32>
The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile's supported range. The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don't specify a value, MediaConnect uses the default value of 20,000,000 bps.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Entitlement <GrantEntitlementRequest[]>
The entitlements that you want to grant on a flow. 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)
AliasesEntitlements
-FlowSize <FlowSize>
Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI sources or outputs on the flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlowTag <Hashtable>
The key-value pairs that can be used to tag and organize the flow. 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)
AliasesFlowTags
-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)
-Maintenance_MaintenanceDay <MaintenanceDay>
A day of a week when the maintenance will happen.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Maintenance_MaintenanceStartHour <String>
UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaStream <AddMediaStreamRequest[]>
The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow. 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)
AliasesMediaStreams
-Name <String>
The name of the flow.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NdiConfig_MachineName <String>
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NdiConfig_NdiDiscoveryServer <NdiDiscoveryServerConfig[]>
A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly. 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)
AliasesNdiConfig_NdiDiscoveryServers
-NdiConfig_NdiState <NdiState>
A setting that controls whether NDI® sources or outputs can be used in the flow. The default value is DISABLED. This value must be set as ENABLED for your flow to support NDI sources or outputs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Output <AddOutputRequest[]>
The outputs that you want to add to this flow. 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)
AliasesOutputs
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Flow'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaConnect.Model.CreateFlowResponse). Specifying the name of a property of type Amazon.MediaConnect.Model.CreateFlowResponse 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)
-Source <SetSourceRequest[]>
The sources that are assigned to the flow. 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)
AliasesSources
-SourceFailoverConfig_FailoverMode <FailoverMode>
The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceFailoverConfig_RecoveryWindow <Int32>
Search window time to look for dash-7 packets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceFailoverConfig_State <State>
The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceMonitoringConfig_AudioMonitoringSetting <AudioMonitoringSetting[]>
Contains the settings for audio stream metrics monitoring. 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)
AliasesSourceMonitoringConfig_AudioMonitoringSettings
-SourceMonitoringConfig_ContentQualityAnalysisState <ContentQualityAnalysisState>
Indicates whether content quality analysis is enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceMonitoringConfig_ThumbnailState <ThumbnailState>
Indicates whether thumbnails are enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceMonitoringConfig_VideoMonitoringSetting <VideoMonitoringSetting[]>
Contains the settings for video stream metrics monitoring. 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)
AliasesSourceMonitoringConfig_VideoMonitoringSettings
-SourcePriority_PrimarySource <String>
The name of the source you choose as the primary source for this flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceFailoverConfig_SourcePriority_PrimarySource
-VpcInterface <VpcInterfaceRequest[]>
The VPC interfaces you want on the flow. 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)
AliasesVpcInterfaces

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