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 MediaLive CreateChannel API operation.

Syntax

New-EMLChannel
-Name <String>
-ChannelClass <ChannelClass>
-AnywhereSettings_ChannelPlacementGroupId <String>
-AnywhereSettings_ClusterId <String>
-InputSpecification_Codec <InputCodec>
-Destination <OutputDestination[]>
-DryRun <Boolean>
-EncoderSetting <EncoderSettings>
-InputAttachment <InputAttachment[]>
-LogLevel <LogLevel>
-Maintenance_MaintenanceDay <MaintenanceDay>
-Maintenance_MaintenanceStartTime <String>
-InputSpecification_MaximumBitrate <InputMaximumBitrate>
-Vpc_PublicAddressAllocationId <String[]>
-RequestId <String>
-CdiInputSpecification_Resolution <CdiInputResolution>
-InputSpecification_Resolution <InputResolution>
-RoleArn <String>
-Vpc_SecurityGroupId <String[]>
-Vpc_SubnetId <String[]>
-Tag <Hashtable>
-ChannelEngineVersion_Version <String>
-Reserved <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMediaLiveConfig>

Description

Creates a new channel

Parameters

-AnywhereSettings_ChannelPlacementGroupId <String>
The ID of the channel placement group for the channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnywhereSettings_ClusterId <String>
The ID of the cluster for the channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CdiInputSpecification_Resolution <CdiInputResolution>
Maximum CDI input resolution
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ChannelClass <ChannelClass>
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ChannelEngineVersion_Version <String>
The build identifier of the engine version to use for this channel. Specify 'DEFAULT' to reset to the default version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMediaLiveConfig>
Amazon.PowerShell.Cmdlets.EML.AmazonMediaLiveClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Destination <OutputDestination[]>
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)
AliasesDestinations
-DryRun <Boolean>
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)
-EncoderSetting <EncoderSettings>
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)
AliasesEncoderSettings
-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)
-InputAttachment <InputAttachment[]>
List of input attachments for channel. 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)
AliasesInputAttachments
-InputSpecification_Codec <InputCodec>
Input codec
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputSpecification_MaximumBitrate <InputMaximumBitrate>
Maximum input bitrate, categorized coarsely
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputSpecification_Resolution <InputResolution>
Input resolution, categorized coarsely
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogLevel <LogLevel>
The log level to write to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Maintenance_MaintenanceDay <MaintenanceDay>
Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Maintenance_MaintenanceStartTime <String>
Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
Name of channel.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RequestId <String>
Unique request ID to be specified. This is needed to prevent retries fromcreating multiple resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Reserved <String>
Deprecated field that's only usable by whitelisted customers.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Channel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaLive.Model.CreateChannelResponse). Specifying the name of a property of type Amazon.MediaLive.Model.CreateChannelResponse 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>
A collection of key-value pairs. 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
-Vpc_PublicAddressAllocationId <String[]>
List of public address allocation ids to associate with ENIs that will be created in Output VPC.Must specify one for SINGLE_PIPELINE, two for STANDARD channels 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)
AliasesVpc_PublicAddressAllocationIds
-Vpc_SecurityGroupId <String[]>
A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.If none are specified then the VPC default security group will be used 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)
AliasesVpc_SecurityGroupIds
-Vpc_SubnetId <String[]>
A list of VPC subnet IDs from the same VPC.If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ). 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)
AliasesVpc_SubnetIds

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.MediaLive.Model.Channel or Amazon.MediaLive.Model.CreateChannelResponse
This cmdlet returns an Amazon.MediaLive.Model.Channel object. The service call response (type Amazon.MediaLive.Model.CreateChannelResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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