image
Gets an individual image
resource
Overview
Name | image |
Type | Resource |
Description | image |
Id | awscc.imagebuilder.image |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | The Amazon Resource Name (ARN) of the image. |
name | string | The name of the image. |
image_tests_configuration | object | The image tests configuration used when creating this image. |
image_recipe_arn | string | The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. |
container_recipe_arn | string | The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. |
distribution_configuration_arn | string | The Amazon Resource Name (ARN) of the distribution configuration. |
infrastructure_configuration_arn | string | The Amazon Resource Name (ARN) of the infrastructure configuration. |
workflows | array | Workflows to define the image build process |
image_id | string | The AMI ID of the EC2 AMI in current region. |
image_uri | string | URI for containers created in current Region with default ECR image tag |
enhanced_image_metadata_enabled | boolean | Collects additional information about the image being created, including the operating system (OS) version and package list. |
image_scanning_configuration | object | Contains settings for vulnerability scans. |
execution_role | string | The execution role name/ARN for the image build, if provided |
tags | object | The tags associated with the image. |
region | string | AWS 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