Synopsis
Calls the Amazon Elastic Transcoder CreatePipeline API operation.
Syntax
New-ETSPipeline-Name <String>-InputBucket <String>-OutputBucket <String>-Role <String>-AwsKmsKeyArn <String>-ContentConfig_Bucket <String>-ThumbnailConfig_Bucket <String>-Notifications_Completed <String>-Notifications_Error <String>-ContentConfig_Permission <Permission[]>-ThumbnailConfig_Permission <Permission[]>-Notifications_Progressing <String>-ContentConfig_StorageClass <String>-ThumbnailConfig_StorageClass <String>-Notifications_Warning <String>-Force <SwitchParameter>
Description
The CreatePipeline operation creates a pipeline with settings that you specify.
Parameters
-AwsKmsKeyArn <String>
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.If you use either
s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContentConfig_Bucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
- You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
- You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
- You do not want to specify the permissions that Elastic Transcoder grants to the files.
- You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
ContentConfig and ThumbnailConfig instead. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContentConfig_Permission <Permission[]>
Optional. The
Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ContentConfig_Permissions |
-ContentConfig_StorageClass <String>
The Amazon S3 storage class,
Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-InputBucket <String>
The Amazon S3 bucket in which you saved the media files that you want to transcode.
| Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
-Name <String>
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.Constraints: Maximum 40 characters.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-Notifications_Completed <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Notifications_Error <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Notifications_Progressing <String>
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Notifications_Warning <String>
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputBucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)Specify this value when all of the following are true:
- You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
- You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
- You do not want to specify the permissions that Elastic Transcoder grants to the files.
When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified byRole. - You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
OutputBucket and specify values for ContentConfig and ThumbnailConfig instead. | Required? | False |
| Position? | 3 |
| Accept pipeline input? | False |
-Role <String>
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
| Required? | False |
| Position? | 4 |
| Accept pipeline input? | False |
-ThumbnailConfig_Bucket <String>
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
- You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
- You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
- You do not want to specify the permissions that Elastic Transcoder grants to the files.
- You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
ContentConfig and ThumbnailConfig instead. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ThumbnailConfig_Permission <Permission[]>
Optional. The
Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user. If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ThumbnailConfig_Permissions |
-ThumbnailConfig_StorageClass <String>
The Amazon S3 storage class,
Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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? | False |
| Aliases | AK |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
| Aliases | AWSProfilesLocation, 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? | False |
| Aliases | AWSProfileName, StoredCredentials |
-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? | False |
-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? | False |
| Aliases | SecretAccessKey, SK |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ST |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | RegionToCall |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the Name parameter.
Outputs
This cmdlet returns a Amazon.ElasticTranscoder.Model.Pipeline object.
The service call response (type Amazon.ElasticTranscoder.Model.CreatePipelineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: Warnings (type List<Amazon.ElasticTranscoder.Model.Warning>)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
