Skip to main content

image

Gets an individual image resource

Overview

Nameimage
TypeResource
Descriptionimage
Idawscc.imagebuilder.image

Fields

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the image.
namestringThe name of the image.
image_tests_configurationobjectThe image tests configuration used when creating this image.
image_recipe_arnstringThe Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arnstringThe Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arnstringThe Amazon Resource Name (ARN) of the distribution configuration.
infrastructure_configuration_arnstringThe Amazon Resource Name (ARN) of the infrastructure configuration.
workflowsarrayWorkflows to define the image build process
image_idstringThe AMI ID of the EC2 AMI in current region.
image_uristringURI for containers created in current Region with default ECR image tag
enhanced_image_metadata_enabledbooleanCollects additional information about the image being created, including the operating system (OS) version and package list.
image_scanning_configurationobjectContains settings for vulnerability scans.
execution_rolestringThe execution role name/ARN for the image build, if provided
tagsobjectThe tags associated with the image.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
name,
image_tests_configuration,
image_recipe_arn,
container_recipe_arn,
distribution_configuration_arn,
infrastructure_configuration_arn,
workflows,
image_id,
image_uri,
enhanced_image_metadata_enabled,
image_scanning_configuration,
execution_role,
tags
FROM awscc.imagebuilder.image
WHERE data__Identifier = '<Arn>';

Permissions

To operate on the image resource, the following permissions are required:

Read

imagebuilder:GetImage

Delete

imagebuilder:GetImage,
imagebuilder:DeleteImage,
imagebuilder:UnTagResource,
imagebuilder:CancelImageCreation