create-image-recipe¶

Description¶

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Synopsis¶

  create-image-recipe
--name <value>
[--description <value>]
--semantic-version <value>
[--components <value>]
--parent-image <value>
[--block-device-mappings <value>]
[--tags <value>]
[--working-directory <value>]
[--additional-instance-configuration <value>]
[--ami-tags <value>]
[--ami-watermarks <value>]
[--client-token <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--name (string) [required]

The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

Constraints:

pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

--description (string)

The description of the image recipe.

Constraints:

min: 1

max: 1024

--semantic-version (string) [required]

The semantic version of the image recipe. This version follows the semantic version syntax.

Note
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Constraints:

pattern: ^(?:[0-9]+|x)\.(?:[0-9]+|x)\.(?:[0-9]+|x)$

--components (list)

The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.

Constraints:

min: 1

(structure)

Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.

componentArn -> (string) [required]

The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a component version ARN whose version segments can use x wildcards, for example 1.x.x .

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$

parameters -> (list)

A group of parameter settings that Image Builder uses to configure the component for a specific recipe. You must supply a value for every component parameter that has no default value, and you can only supply parameters that the component defines.

Constraints:

min: 1

(structure)

Contains a key/value pair that sets the named component parameter.

name -> (string) [required]

The name of the component parameter to set.

Constraints:

min: 1

max: 256

pattern: [^\x00]+

value -> (list) [required]

Sets the value for the named component parameter.

(string)

Constraints:

min: 0

pattern: [^\x00]*

JSON Syntax:

[
  {
    "componentArn": "string",
    "parameters": [
      {
        "name": "string",
        "value": ["string", ...]
      }
      ...
    ]
  }
  ...
]

--parent-image (string) [required]

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:

AMI ID

Image Builder image Amazon Resource Name (ARN)

Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN.

Amazon Web Services Marketplace product ID

If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI. The AMI must also be in the Region where you’re creating the recipe.

Constraints:

min: 1

max: 1024

--block-device-mappings (list)

The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image’s root volume or attach additional EBS volumes.

(structure)

Defines block device mappings for the instance used to configure your image.

deviceName -> (string)

The device to which these mappings apply.

Constraints:

min: 1

max: 1024

ebs -> (structure)

The Amazon EBS-specific configuration for this mapping.

encrypted -> (boolean)

Specifies whether to encrypt the device.

deleteOnTermination -> (boolean)

Specifies whether to delete the associated device on termination.

iops -> (integer)

The IOPS value for the device. Required only when volumeType is io1 or io2.

Constraints:

min: 100

max: 64000

kmsKeyId -> (string)

The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide .

Constraints:

min: 1

max: 1024

snapshotId -> (string)

The snapshot that defines the device contents.

Constraints:

min: 1

max: 1024

volumeSize -> (integer)

Overrides the volume size for the device.

Constraints:

min: 1

max: 16000

volumeType -> (string)

Overrides the volume type for the device.

Possible values:

standard

io1

io2

gp2

gp3

sc1

st1

throughput -> (integer)

For GP3 volumes only – The throughput in MiB/s that the volume supports.

Constraints:

min: 125

max: 1000

virtualName -> (string)

The virtual device name for instance ephemeral devices.

Constraints:

min: 1

max: 1024

noDevice -> (string)

Specifies a mapping to remove from the base image.

Constraints:

min: 0

max: 0

Shorthand Syntax:

deviceName=string,ebs={encrypted=boolean,deleteOnTermination=boolean,iops=integer,kmsKeyId=string,snapshotId=string,volumeSize=integer,volumeType=string,throughput=integer},virtualName=string,noDevice=string ...

JSON Syntax:

[
  {
    "deviceName": "string",
    "ebs": {
      "encrypted": true|false,
      "deleteOnTermination": true|false,
      "iops": integer,
      "kmsKeyId": "string",
      "snapshotId": "string",
      "volumeSize": integer,
      "volumeType": "standard"|"io1"|"io2"|"gp2"|"gp3"|"sc1"|"st1",
      "throughput": integer
    },
    "virtualName": "string",
    "noDevice": "string"
  }
  ...
]

--tags (map)

The tags of the image recipe.

Constraints:

min: 1

max: 50

key -> (string)

Constraints:

min: 1

max: 128

pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

value -> (string)

Constraints:

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--working-directory (string)

The working directory used during build and test workflows. If you don’t specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.

Constraints:

min: 1

max: 1024

--additional-instance-configuration (structure)

The additional settings and launch scripts for your build instances.

systemsManagerAgent -> (structure)

The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.

uninstallAfterBuild -> (boolean)

Specifies whether the Systems Manager agent is removed from your final build image before Image Builder creates the new AMI. If true , the agent is removed. If false , the agent is kept, so that it’s included in the AMI. If you don’t set this property, Image Builder removes the agent only if Image Builder installed the agent during the build. An agent that was pre-installed on the base image is kept.

userDataOverride -> (string)

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

Note
The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg== :

#!/bin/bash

mkdir -p /var/bb/

touch /var

Constraints:

min: 1

max: 21847

pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Shorthand Syntax:

systemsManagerAgent={uninstallAfterBuild=boolean},userDataOverride=string

JSON Syntax:

{
  "systemsManagerAgent": {
    "uninstallAfterBuild": true|false
  },
  "userDataOverride": "string"
}

--ami-tags (map)

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Constraints:

min: 1

max: 50

key -> (string)

Constraints:

min: 1

max: 128

pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

value -> (string)

Constraints:

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--ami-watermarks (list)

The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

Note
AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

Constraints:

min: 1

max: 5

(string)

The name of an AMI watermark. AMI watermarks are lineage markers that Image Builder attaches to output AMIs during the build process. AMI watermarks automatically propagate to derivative AMIs when the source AMI is copied or distributed.

Constraints:

min: 3

max: 128

pattern: ^[A-Za-z0-9()\[\]./'@_\-][A-Za-z0-9 ()\[\]./'@_\-]{1,126}[A-Za-z0-9()\[\]./'@_\-]$

Syntax:

"string" "string" ...

--client-token (string)

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference .

Constraints:

min: 1

max: 64

--dry-run | --no-dry-run (boolean)

Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a recipe

The following create-image-recipe example creates an image recipe using a JSON file. Components are installed in the order in which they are specified.

aws imagebuilder create-image-recipe \
    --cli-input-json file://create-image-recipe.json

Contents of create-image-recipe.json:

{
    "name": "MyBasicRecipe",
    "description": "This example image recipe creates a Windows 2016 image.",
    "semanticVersion": "2019.12.03",
    "components":
    [
        {
            "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
        },
        {
            "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
        }
    ],
    "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x"
}

Output:

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

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.

Constraints:

min: 1

max: 1024

clientToken -> (string)

The client token that uniquely identifies the request.

Constraints:

min: 1

max: 64

imageRecipeArn -> (string)

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

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/(?:[0-9]+|x)\.(?:[0-9]+|x)\.(?:[0-9]+|x)$

latestVersionReferences -> (structure)

A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.

latestVersionArn -> (string)

The latest version Amazon Resource Name (ARN) of the Image Builder resource.

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestMajorVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestMinorVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

latestPatchVersionArn -> (string)

The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Constraints:

pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?|third-party):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

Table of Contents

Feedback

User Guide

create-image-recipe¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Examples¶

Note

Output¶