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

Syntax

New-EC2IBImage
-ImageRecipeArn <String>
-ContainerRecipeArn <String>
-EcrConfiguration_ContainerTag <String[]>
-DistributionConfigurationArn <String>
-EnhancedImageMetadataEnabled <Boolean>
-ExecutionRole <String>
-ImageScanningConfiguration_ImageScanningEnabled <Boolean>
-ImageTestsConfiguration_ImageTestsEnabled <Boolean>
-InfrastructureConfigurationArn <String>
-EcrConfiguration_RepositoryName <String>
-Tag <Hashtable>
-ImageTestsConfiguration_TimeoutMinute <Int32>
-Workflow <WorkflowConfiguration[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonImagebuilderConfig>

Description

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Parameters

-ClientConfig <AmazonImagebuilderConfig>
Amazon.PowerShell.Cmdlets.EC2IB.AmazonImagebuilderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerRecipeArn <String>
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DistributionConfigurationArn <String>
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EcrConfiguration_ContainerTag <String[]>
Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImageScanningConfiguration_EcrConfiguration_ContainerTags
-EcrConfiguration_RepositoryName <String>
The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImageScanningConfiguration_EcrConfiguration_RepositoryName
-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)
-ExecutionRole <String>
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
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)
-ImageRecipeArn <String>
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ImageScanningConfiguration_ImageScanningEnabled <Boolean>
A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.
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.The timeoutMinutes attribute is not currently active. This value is ignored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImageTestsConfiguration_TimeoutMinutes
-InfrastructureConfigurationArn <String>
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ImageRecipeArn parameter. The -PassThru parameter is deprecated, use -Select '^ImageRecipeArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ImageBuildVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.CreateImageResponse). Specifying the name of a property of type Amazon.Imagebuilder.Model.CreateImageResponse 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 of the image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Workflow <WorkflowConfiguration[]>
Contains an array of workflow configuration objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkflows

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

System.String or Amazon.Imagebuilder.Model.CreateImageResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Imagebuilder.Model.CreateImageResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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