Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . imagebuilder ]

create-image

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-image
--image-recipe-arn <value>
[--distribution-configuration-arn <value>]
--infrastructure-configuration-arn <value>
[--image-tests-configuration <value>]
[--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled]
[--tags <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--image-recipe-arn (string)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

--distribution-configuration-arn (string)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

--infrastructure-configuration-arn (string)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

--image-tests-configuration (structure)

The image tests configuration of the image.

Shorthand Syntax:

imageTestsEnabled=boolean,timeoutMinutes=integer

JSON Syntax:

{
  "imageTestsEnabled": true|false,
  "timeoutMinutes": integer
}

--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled (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.

--tags (map)

The tags of the image.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

The idempotency token used to make this request idempotent.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an image

The following create-image example creates an image.

aws imagebuilder create-image \
    --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure

Output:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}

For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.

Output

requestId -> (string)

The request ID that uniquely identifies this request.

clientToken -> (string)

The idempotency token used to make this request idempotent.

imageBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the image that was created by this request.