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 EC2 Image Builder CreateImagePipeline API operation.

Syntax

New-EC2IBImagePipeline
-Name <String>
-ContainerRecipeArn <String>
-Description <String>
-DistributionConfigurationArn <String>
-EnhancedImageMetadataEnabled <Boolean>
-ImageRecipeArn <String>
-ImageTestsConfiguration_ImageTestsEnabled <Boolean>
-InfrastructureConfigurationArn <String>
-Schedule_PipelineExecutionStartCondition <PipelineExecutionStartCondition>
-Schedule_ScheduleExpression <String>
-Status <PipelineStatus>
-Tag <Hashtable>
-ImageTestsConfiguration_TimeoutMinute <Int32>
-Schedule_Timezone <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Parameters

-ClientToken <String>
The idempotency token used to make this request idempotent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerRecipeArn <String>
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the image pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DistributionConfigurationArn <String>
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnhancedImageMetadataEnabled <Boolean>
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-ImageRecipeArn <String>
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageTestsConfiguration_ImageTestsEnabled <Boolean>
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageTestsConfiguration_TimeoutMinute <Int32>
The maximum time in minutes that tests are permitted to run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImageTestsConfiguration_TimeoutMinutes
-InfrastructureConfigurationArn <String>
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the image pipeline.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule_PipelineExecutionStartCondition <PipelineExecutionStartCondition>
The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule_ScheduleExpression <String>
The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule_Timezone <String>
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ImagePipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateImagePipelineResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateImagePipelineResponse 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)
-Status <PipelineStatus>
The status of the image pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags of the image pipeline.
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

This cmdlet returns a System.String object. The service call response (type Amazon.Imagebuilder.Model.CreateImagePipelineResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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