Image - EC2 Image Builder

Image

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.

Contents

arn

The Amazon Resource Name (ARN) of the image.

Note

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.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

Required: No

containerRecipe

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

Type: ContainerRecipe object

Required: No

dateCreated

The date on which this image was created.

Type: String

Required: No

distributionConfiguration

The distribution configuration used when creating this image.

Type: DistributionConfiguration object

Required: No

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.

Type: Boolean

Required: No

imageRecipe

The image recipe used when creating the image.

Type: ImageRecipe object

Required: No

imageTestsConfiguration

The image tests configuration used when creating this image.

Type: ImageTestsConfiguration object

Required: No

infrastructureConfiguration

The infrastructure used when creating this image.

Type: InfrastructureConfiguration object

Required: No

name

The name of the image.

Type: String

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

Required: No

osVersion

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

outputResources

The output resources produced when creating this image.

Type: OutputResources object

Required: No

platform

The platform of the image.

Type: String

Valid Values: Windows | Linux

Required: No

sourcePipelineArn

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

Type: String

Required: No

sourcePipelineName

The name of the image pipeline that created this image.

Type: String

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

Required: No

state

The state of the image.

Type: ImageState object

Required: No

tags

The tags of the image.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

type

Specifies whether this is an AMI or container image.

Type: String

Valid Values: AMI | DOCKER

Required: No

version

The semantic version of the image.

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, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number, and that is not open for updates.

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: When you retrieve or reference a resource with a semantic version, you can use wildcards (x) to filter your results. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards. For example, specifying "1.2.x", or "1.x.x" works to filter list results, but neither "1.x.2", nor "x.2.x" will work. You do not have to specify the build - Image Builder automatically uses a wildcard for that, if applicable.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: