ImageVersion
¶
Source code in docs_src/capo_imagebuilder/types/image_version.py
arn
instance-attribute
¶
arn: NotRequired[ImageBuilderArn]
The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
-
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.
-
Version ARNs have only the first three nodes:
. . -
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
build_type
instance-attribute
¶
build_type: NotRequired[BuildType]
Indicates the type of build that created this image. The build can be initiated in the following ways:
-
USER_INITIATED – A manual pipeline build request.
-
SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
-
IMPORT – A VM import created the image to use as the base image for the recipe.
-
IMPORT_ISO – An ISO disk import created the image.
date_created
instance-attribute
¶
date_created: NotRequired[DateTime]
The date on which this specific version of the Image Builder image was created.
image_source
instance-attribute
¶
image_source: NotRequired[ImageSource]
The origin of the base image that Image Builder used to build this image.
name
instance-attribute
¶
name: NotRequired[ResourceName]
The name of this specific version of an Image Builder image.
os_version
instance-attribute
¶
os_version: NotRequired[OsVersion]
The operating system version of the image. For example, Amazon Linux 2023 or Microsoft Windows Server 2022.
platform
instance-attribute
¶
platform: NotRequired[Platform]
The operating system platform of the image version, for example "Windows" or "Linux".
type
instance-attribute
¶
type: NotRequired[ImageType]
Specifies whether this image produces an AMI or a container image.
version
instance-attribute
¶
version: NotRequired[VersionNumber]
The semantic version of the image. This version follows the semantic version syntax.
The semantic version has four nodes:
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.
Filtering: You can 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.