Documentation

An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.

See: newImage smart constructor.

Create a value of Image with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageRecipe:Image', image_imageRecipe - The image recipe used when creating the image.

$sel:state:Image', image_state - The state of the image.

$sel:platform:Image', image_platform - The platform of the image.

$sel:imageTestsConfiguration:Image', image_imageTestsConfiguration - The image tests configuration used when creating this image.

$sel:arn:Image', image_arn - The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

$sel:enhancedImageMetadataEnabled:Image', image_enhancedImageMetadataEnabled - 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.

$sel:dateCreated:Image', image_dateCreated - The date on which this image was created.

$sel:containerRecipe:Image', image_containerRecipe - The recipe that is used to create an Image Builder container image.

$sel:name:Image', image_name - The name of the image.

$sel:infrastructureConfiguration:Image', image_infrastructureConfiguration - The infrastructure used when creating this image.

$sel:version:Image', image_version - The semantic version of the image.

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, with an upper limit of 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

$sel:distributionConfiguration:Image', image_distributionConfiguration - The distribution configuration used when creating this image.

$sel:sourcePipelineArn:Image', image_sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this image.

$sel:type':Image', image_type - Specifies whether this is an AMI or container image.

$sel:sourcePipelineName:Image', image_sourcePipelineName - The name of the image pipeline that created this image.

$sel:outputResources:Image', image_outputResources - The output resources produced when creating this image.

$sel:osVersion:Image', image_osVersion - The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

$sel:tags:Image', image_tags - The tags of the image.

The image recipe used when creating the image.

The state of the image.

The platform of the image.

The image tests configuration used when creating this image.

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

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.

The date on which this image was created.

The recipe that is used to create an Image Builder container image.

The name of the image.

The infrastructure used when creating this image.

The semantic version of the image.

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, with an upper limit of 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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

The distribution configuration used when creating this image.

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Specifies whether this is an AMI or container image.

The name of the image pipeline that created this image.

The output resources produced when creating this image.

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

The tags of the image.