/AWS1/CL_IMGIMAGE¶
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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_arn TYPE /AWS1/IMGIMAGEBUILDERARN /AWS1/IMGIMAGEBUILDERARN¶
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:
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.
iv_type TYPE /AWS1/IMGIMAGETYPE /AWS1/IMGIMAGETYPE¶
Specifies whether this image produces an AMI or a container image.
iv_name TYPE /AWS1/IMGRESOURCENAME /AWS1/IMGRESOURCENAME¶
The name of the image.
iv_version TYPE /AWS1/IMGVERSIONNUMBER /AWS1/IMGVERSIONNUMBER¶
The semantic version of the image.
The semantic version has four nodes:
. . / . 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.
iv_platform TYPE /AWS1/IMGPLATFORM /AWS1/IMGPLATFORM¶
The image operating system platform, such as Linux or Windows.
iv_enhancedimagemetenabled TYPE /AWS1/IMGNULLABLEBOOLEAN /AWS1/IMGNULLABLEBOOLEAN¶
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
iv_osversion TYPE /AWS1/IMGOSVERSION /AWS1/IMGOSVERSION¶
The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
io_state TYPE REF TO /AWS1/CL_IMGIMAGESTATE /AWS1/CL_IMGIMAGESTATE¶
The state of the image.
io_imagerecipe TYPE REF TO /AWS1/CL_IMGIMAGERECIPE /AWS1/CL_IMGIMAGERECIPE¶
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
io_containerrecipe TYPE REF TO /AWS1/CL_IMGCONTAINERRECIPE /AWS1/CL_IMGCONTAINERRECIPE¶
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
iv_sourcepipelinename TYPE /AWS1/IMGRESOURCENAME /AWS1/IMGRESOURCENAME¶
The name of the image pipeline that created this image.
iv_sourcepipelinearn TYPE /AWS1/IMGARN /AWS1/IMGARN¶
The Amazon Resource Name (ARN) of the image pipeline that created this image.
io_infrastructureconf TYPE REF TO /AWS1/CL_IMGINFRASTRUCTURECONF /AWS1/CL_IMGINFRASTRUCTURECONF¶
The infrastructure that Image Builder used to create this image.
io_distributionconfiguration TYPE REF TO /AWS1/CL_IMGDISTRIBUTIONCONF /AWS1/CL_IMGDISTRIBUTIONCONF¶
The distribution configuration that Image Builder used to create this image.
io_imagetestsconfiguration TYPE REF TO /AWS1/CL_IMGIMAGETESTSCONF /AWS1/CL_IMGIMAGETESTSCONF¶
The image tests that ran when that Image Builder created this image.
iv_datecreated TYPE /AWS1/IMGDATETIME /AWS1/IMGDATETIME¶
The date on which Image Builder created this image.
io_outputresources TYPE REF TO /AWS1/CL_IMGOUTPUTRESOURCES /AWS1/CL_IMGOUTPUTRESOURCES¶
The output resources that Image Builder produces for this image.
it_tags TYPE /AWS1/CL_IMGTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
The tags that apply to this image.
iv_buildtype TYPE /AWS1/IMGBUILDTYPE /AWS1/IMGBUILDTYPE¶
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.
iv_imagesource TYPE /AWS1/IMGIMAGESOURCE /AWS1/IMGIMAGESOURCE¶
The origin of the base image that Image Builder used to build this image.
io_scanstate TYPE REF TO /AWS1/CL_IMGIMAGESCANSTATE /AWS1/CL_IMGIMAGESCANSTATE¶
Contains information about the current state of scans for this image.
io_imagescanningconf TYPE REF TO /AWS1/CL_IMGIMAGESCANNINGCONF /AWS1/CL_IMGIMAGESCANNINGCONF¶
Contains settings for vulnerability scans.
iv_deprecationtime TYPE /AWS1/IMGDATETIMETIMESTAMP /AWS1/IMGDATETIMETIMESTAMP¶
The time when deprecation occurs for an image resource. This can be a past or future date.
iv_lifecycleexecutionid TYPE /AWS1/IMGLIFECYCLEEXECUTIONID /AWS1/IMGLIFECYCLEEXECUTIONID¶
Identifies the last runtime instance of the lifecycle policy to take action on the image.
iv_executionrole TYPE /AWS1/IMGROLENAMEORARN /AWS1/IMGROLENAMEORARN¶
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
it_workflows TYPE /AWS1/CL_IMGWORKFLOWCONF=>TT_WORKFLOWCONFIGURATIONLIST TT_WORKFLOWCONFIGURATIONLIST¶
Contains the build and test workflows that are associated with the image.
Queryable Attributes¶
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:
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
type¶
Specifies whether this image produces an AMI or a container image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
name¶
The name of the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
version¶
The semantic version of the image.
The semantic version has four nodes:
. . / . 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |
platform¶
The image operating system platform, such as Linux or Windows.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLATFORM() |
Getter for PLATFORM, with configurable default |
ASK_PLATFORM() |
Getter for PLATFORM w/ exceptions if field has no value |
HAS_PLATFORM() |
Determine if PLATFORM has a value |
enhancedImageMetadataEnabled¶
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENHANCEDIMAGEMETENABLED() |
Getter for ENHANCEDIMAGEMETADATAENABLED, with configurable d |
ASK_ENHANCEDIMAGEMETENABLED() |
Getter for ENHANCEDIMAGEMETADATAENABLED w/ exceptions if fie |
HAS_ENHANCEDIMAGEMETENABLED() |
Determine if ENHANCEDIMAGEMETADATAENABLED has a value |
osVersion¶
The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OSVERSION() |
Getter for OSVERSION, with configurable default |
ASK_OSVERSION() |
Getter for OSVERSION w/ exceptions if field has no value |
HAS_OSVERSION() |
Determine if OSVERSION has a value |
state¶
The state of the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE |
imageRecipe¶
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGERECIPE() |
Getter for IMAGERECIPE |
containerRecipe¶
For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTAINERRECIPE() |
Getter for CONTAINERRECIPE |
sourcePipelineName¶
The name of the image pipeline that created this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEPIPELINENAME() |
Getter for SOURCEPIPELINENAME, with configurable default |
ASK_SOURCEPIPELINENAME() |
Getter for SOURCEPIPELINENAME w/ exceptions if field has no |
HAS_SOURCEPIPELINENAME() |
Determine if SOURCEPIPELINENAME has a value |
sourcePipelineArn¶
The Amazon Resource Name (ARN) of the image pipeline that created this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEPIPELINEARN() |
Getter for SOURCEPIPELINEARN, with configurable default |
ASK_SOURCEPIPELINEARN() |
Getter for SOURCEPIPELINEARN w/ exceptions if field has no v |
HAS_SOURCEPIPELINEARN() |
Determine if SOURCEPIPELINEARN has a value |
infrastructureConfiguration¶
The infrastructure that Image Builder used to create this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INFRASTRUCTURECONF() |
Getter for INFRASTRUCTURECONFIGURATION |
distributionConfiguration¶
The distribution configuration that Image Builder used to create this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISTRIBUTIONCONF() |
Getter for DISTRIBUTIONCONFIGURATION |
imageTestsConfiguration¶
The image tests that ran when that Image Builder created this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGETESTSCONFIGURATION() |
Getter for IMAGETESTSCONFIGURATION |
dateCreated¶
The date on which Image Builder created this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATECREATED() |
Getter for DATECREATED, with configurable default |
ASK_DATECREATED() |
Getter for DATECREATED w/ exceptions if field has no value |
HAS_DATECREATED() |
Determine if DATECREATED has a value |
outputResources¶
The output resources that Image Builder produces for this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPUTRESOURCES() |
Getter for OUTPUTRESOURCES |
tags¶
The tags that apply to this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUILDTYPE() |
Getter for BUILDTYPE, with configurable default |
ASK_BUILDTYPE() |
Getter for BUILDTYPE w/ exceptions if field has no value |
HAS_BUILDTYPE() |
Determine if BUILDTYPE has a value |
imageSource¶
The origin of the base image that Image Builder used to build this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGESOURCE() |
Getter for IMAGESOURCE, with configurable default |
ASK_IMAGESOURCE() |
Getter for IMAGESOURCE w/ exceptions if field has no value |
HAS_IMAGESOURCE() |
Determine if IMAGESOURCE has a value |
scanState¶
Contains information about the current state of scans for this image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCANSTATE() |
Getter for SCANSTATE |
imageScanningConfiguration¶
Contains settings for vulnerability scans.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGESCANNINGCONF() |
Getter for IMAGESCANNINGCONFIGURATION |
deprecationTime¶
The time when deprecation occurs for an image resource. This can be a past or future date.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPRECATIONTIME() |
Getter for DEPRECATIONTIME, with configurable default |
ASK_DEPRECATIONTIME() |
Getter for DEPRECATIONTIME w/ exceptions if field has no val |
HAS_DEPRECATIONTIME() |
Determine if DEPRECATIONTIME has a value |
lifecycleExecutionId¶
Identifies the last runtime instance of the lifecycle policy to take action on the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LIFECYCLEEXECUTIONID() |
Getter for LIFECYCLEEXECUTIONID, with configurable default |
ASK_LIFECYCLEEXECUTIONID() |
Getter for LIFECYCLEEXECUTIONID w/ exceptions if field has n |
HAS_LIFECYCLEEXECUTIONID() |
Determine if LIFECYCLEEXECUTIONID has a value |
executionRole¶
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLE() |
Getter for EXECUTIONROLE, with configurable default |
ASK_EXECUTIONROLE() |
Getter for EXECUTIONROLE w/ exceptions if field has no value |
HAS_EXECUTIONROLE() |
Determine if EXECUTIONROLE has a value |
workflows¶
Contains the build and test workflows that are associated with the image.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKFLOWS() |
Getter for WORKFLOWS, with configurable default |
ASK_WORKFLOWS() |
Getter for WORKFLOWS w/ exceptions if field has no value |
HAS_WORKFLOWS() |
Determine if WORKFLOWS has a value |