Skip to content

aws.imagebuilder.get_image

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_image
WHERE
"image_build_version_arn" = 'VALUE';

Description

Gets an image.

Table Definition

Column NameColumn Data Type
image_build_version_arn Required Input Column

The Amazon Resource Name (ARN) of the image that you want to get.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

image

The image object.

STRUCT(
"arn" VARCHAR,
"type" VARCHAR,
"name" VARCHAR,
"version" VARCHAR,
"platform" VARCHAR,
"enhanced_image_metadata_enabled" BOOLEAN,
"os_version" VARCHAR,
"state" STRUCT(
"status" VARCHAR,
"reason" VARCHAR
),
"image_recipe" STRUCT(
"arn" VARCHAR,
"type" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"platform" VARCHAR,
"owner" VARCHAR,
"version" VARCHAR,
"components" STRUCT(
"component_arn" VARCHAR,
"parameters" STRUCT(
"name" VARCHAR,
"value" VARCHAR[]
)[]
)[],
"parent_image" VARCHAR,
"block_device_mappings" STRUCT(
"device_name" VARCHAR,
"ebs" STRUCT(
"encrypted" BOOLEAN,
"delete_on_termination" BOOLEAN,
"iops" BIGINT,
"kms_key_id" VARCHAR,
"snapshot_id" VARCHAR,
"volume_size" BIGINT,
"volume_type" VARCHAR,
"throughput" BIGINT
),
"virtual_name" VARCHAR,
"no_device" VARCHAR
)[],
"date_created" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR),
"working_directory" VARCHAR,
"additional_instance_configuration" STRUCT(
"systems_manager_agent" STRUCT(
"uninstall_after_build" BOOLEAN
),
"user_data_override" VARCHAR
)
),
"container_recipe" STRUCT(
"arn" VARCHAR,
"container_type" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"platform" VARCHAR,
"owner" VARCHAR,
"version" VARCHAR,
"components" STRUCT(
"component_arn" VARCHAR,
"parameters" STRUCT(
"name" VARCHAR,
"value" VARCHAR[]
)[]
)[],
"instance_configuration" STRUCT(
"image" VARCHAR,
"block_device_mappings" STRUCT(
"device_name" VARCHAR,
"ebs" STRUCT(
"encrypted" BOOLEAN,
"delete_on_termination" BOOLEAN,
"iops" BIGINT,
"kms_key_id" VARCHAR,
"snapshot_id" VARCHAR,
"volume_size" BIGINT,
"volume_type" VARCHAR,
"throughput" BIGINT
),
"virtual_name" VARCHAR,
"no_device" VARCHAR
)[]
),
"dockerfile_template_data" VARCHAR,
"kms_key_id" VARCHAR,
"encrypted" BOOLEAN,
"parent_image" VARCHAR,
"date_created" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR),
"working_directory" VARCHAR,
"target_repository" STRUCT(
"service" VARCHAR,
"repository_name" VARCHAR
)
),
"source_pipeline_name" VARCHAR,
"source_pipeline_arn" VARCHAR,
"infrastructure_configuration" STRUCT(
"arn" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"instance_types" VARCHAR[],
"instance_profile_name" VARCHAR,
"security_group_ids" VARCHAR[],
"subnet_id" VARCHAR,
"logging" STRUCT(
"s3_logs" STRUCT(
"s3_bucket_name" VARCHAR,
"s3_key_prefix" VARCHAR
)
),
"key_pair" VARCHAR,
"terminate_instance_on_failure" BOOLEAN,
"sns_topic_arn" VARCHAR,
"date_created" VARCHAR,
"date_updated" VARCHAR,
"resource_tags" MAP(VARCHAR, VARCHAR),
"instance_metadata_options" STRUCT(
"http_tokens" VARCHAR,
"http_put_response_hop_limit" BIGINT
),
"tags" MAP(VARCHAR, VARCHAR)
),
"distribution_configuration" STRUCT(
"arn" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"distributions" STRUCT(
"region" VARCHAR,
"ami_distribution_configuration" STRUCT(
"name" VARCHAR,
"description" VARCHAR,
"target_account_ids" VARCHAR[],
"ami_tags" MAP(VARCHAR, VARCHAR),
"kms_key_id" VARCHAR,
"launch_permission" STRUCT(
"user_ids" VARCHAR[],
"user_groups" VARCHAR[],
"organization_arns" VARCHAR[],
"organizational_unit_arns" VARCHAR[]
)
),
"container_distribution_configuration" STRUCT(
"description" VARCHAR,
"container_tags" VARCHAR[],
"target_repository" STRUCT(
"service" VARCHAR,
"repository_name" VARCHAR
)
),
"license_configuration_arns" VARCHAR[],
"launch_template_configurations" STRUCT(
"launch_template_id" VARCHAR,
"account_id" VARCHAR,
"set_default_version" BOOLEAN
)[],
"s3_export_configuration" STRUCT(
"role_name" VARCHAR,
"disk_image_format" VARCHAR,
"s3_bucket" VARCHAR,
"s3_prefix" VARCHAR
),
"fast_launch_configurations" STRUCT(
"enabled" BOOLEAN,
"snapshot_configuration" STRUCT(
"target_resource_count" BIGINT
),
"max_parallel_launches" BIGINT,
"launch_template" STRUCT(
"launch_template_id" VARCHAR,
"launch_template_name" VARCHAR,
"launch_template_version" VARCHAR
),
"account_id" VARCHAR
)[]
)[],
"timeout_minutes" BIGINT,
"date_created" VARCHAR,
"date_updated" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR)
),
"image_tests_configuration" STRUCT(
"image_tests_enabled" BOOLEAN,
"timeout_minutes" BIGINT
),
"date_created" VARCHAR,
"output_resources" STRUCT(
"amis" STRUCT(
"region" VARCHAR,
"image" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"state" STRUCT(
"status" VARCHAR,
"reason" VARCHAR
),
"account_id" VARCHAR
)[],
"containers" STRUCT(
"region" VARCHAR,
"image_uris" VARCHAR[]
)[]
),
"tags" MAP(VARCHAR, VARCHAR),
"build_type" VARCHAR,
"image_source" VARCHAR,
"scan_state" STRUCT(
"status" VARCHAR,
"reason" VARCHAR
),
"image_scanning_configuration" STRUCT(
"image_scanning_enabled" BOOLEAN,
"ecr_configuration" STRUCT(
"repository_name" VARCHAR,
"container_tags" VARCHAR[]
)
),
"deprecation_time" TIMESTAMP_S,
"lifecycle_execution_id" VARCHAR,
"execution_role" VARCHAR,
"workflows" STRUCT(
"workflow_arn" VARCHAR,
"parameters" STRUCT(
"name" VARCHAR,
"value" VARCHAR[]
)[],
"parallel_group" VARCHAR,
"on_failure" VARCHAR
)[]
)
Show child fields
image.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:

  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.

image.build_type

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.

image.container_recipe

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.

Show child fields
image.container_recipe.arn

The Amazon Resource Name (ARN) of the container recipe.

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.

image.container_recipe.components[]
Show child fields
image.container_recipe.components[].component_arn

The Amazon Resource Name (ARN) of the component.

image.container_recipe.components[].parameters[]
Show child fields
image.container_recipe.components[].parameters[].name

The name of the component parameter to set.

image.container_recipe.components[].parameters[].value[]
image.container_recipe.container_type

Specifies the type of container, such as Docker.

image.container_recipe.date_created

The date when this container recipe was created.

image.container_recipe.description

The description of the container recipe.

image.container_recipe.dockerfile_template_data

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

image.container_recipe.encrypted

A flag that indicates if the target container is encrypted.

image.container_recipe.instance_configuration

A group of options that can be used to configure an instance for building and testing container images.

Show child fields
image.container_recipe.instance_configuration.block_device_mappings[]
Show child fields
image.container_recipe.instance_configuration.block_device_mappings[].device_name

The device to which these mappings apply.

image.container_recipe.instance_configuration.block_device_mappings[].ebs

Use to manage Amazon EBS-specific configuration for this mapping.

Show child fields
image.container_recipe.instance_configuration.block_device_mappings[].ebs.delete_on_termination

Use to configure delete on termination of the associated device.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.encrypted

Use to configure device encryption.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.iops

Use to configure device IOPS.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.kms_key_id

Use to configure the KMS key to use when encrypting the device.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.snapshot_id

The snapshot that defines the device contents.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.throughput

For GP3 volumes only – The throughput in MiB/s that the volume supports.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.volume_size

Use to override the device's volume size.

image.container_recipe.instance_configuration.block_device_mappings[].ebs.volume_type

Use to override the device's volume type.

image.container_recipe.instance_configuration.block_device_mappings[].no_device

Use to remove a mapping from the base image.

image.container_recipe.instance_configuration.block_device_mappings[].virtual_name

Use to manage instance ephemeral devices.

image.container_recipe.instance_configuration.image

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

image.container_recipe.kms_key_id

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

image.container_recipe.name

The name of the container recipe.

image.container_recipe.owner

The owner of the container recipe.

image.container_recipe.parent_image

The base image for the container recipe.

image.container_recipe.platform

The system platform for the container, such as Windows or Linux.

image.container_recipe.tags

Tags that are attached to the container recipe.

image.container_recipe.target_repository

The destination repository for the container image.

Show child fields
image.container_recipe.target_repository.repository_name

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

image.container_recipe.target_repository.service

Specifies the service in which this image was registered.

image.container_recipe.version

The semantic version of the container recipe.

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 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.

image.container_recipe.working_directory

The working directory for use during build and test workflows.

image.date_created

The date on which Image Builder created this image.

image.deprecation_time

The time when deprecation occurs for an image resource. This can be a past or future date.

image.distribution_configuration

The distribution configuration that Image Builder used to create this image.

Show child fields
image.distribution_configuration.arn

The Amazon Resource Name (ARN) of the distribution configuration.

image.distribution_configuration.date_created

The date on which this distribution configuration was created.

image.distribution_configuration.date_updated

The date on which this distribution configuration was last updated.

image.distribution_configuration.description

The description of the distribution configuration.

image.distribution_configuration.distributions[]
Show child fields
image.distribution_configuration.distributions[].ami_distribution_configuration

The specific AMI settings; for example, launch permissions or AMI tags.

Show child fields
image.distribution_configuration.distributions[].ami_distribution_configuration.ami_tags

The tags to apply to AMIs distributed to this Region.

image.distribution_configuration.distributions[].ami_distribution_configuration.description

The description of the AMI distribution configuration. Minimum and maximum length are in characters.

image.distribution_configuration.distributions[].ami_distribution_configuration.kms_key_id

The KMS key identifier used to encrypt the distributed image.

image.distribution_configuration.distributions[].ami_distribution_configuration.launch_permission

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

Show child fields
image.distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.organization_arns[]
image.distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.organizational_unit_arns[]
image.distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.user_groups[]
image.distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.user_ids[]
image.distribution_configuration.distributions[].ami_distribution_configuration.name

The name of the output AMI.

image.distribution_configuration.distributions[].ami_distribution_configuration.target_account_ids[]
image.distribution_configuration.distributions[].container_distribution_configuration

Container distribution settings for encryption, licensing, and sharing in a specific Region.

Show child fields
image.distribution_configuration.distributions[].container_distribution_configuration.container_tags[]
image.distribution_configuration.distributions[].container_distribution_configuration.description

The description of the container distribution configuration.

image.distribution_configuration.distributions[].container_distribution_configuration.target_repository

The destination repository for the container distribution configuration.

Show child fields
image.distribution_configuration.distributions[].container_distribution_configuration.target_repository.repository_name

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

image.distribution_configuration.distributions[].container_distribution_configuration.target_repository.service

Specifies the service in which this image was registered.

image.distribution_configuration.distributions[].fast_launch_configurations[]
Show child fields
image.distribution_configuration.distributions[].fast_launch_configurations[].account_id

The owner account ID for the fast-launch enabled Windows AMI.

image.distribution_configuration.distributions[].fast_launch_configurations[].enabled

A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

image.distribution_configuration.distributions[].fast_launch_configurations[].launch_template

The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

Show child fields
image.distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_id

The ID of the launch template to use for faster launching for a Windows AMI.

image.distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_name

The name of the launch template to use for faster launching for a Windows AMI.

image.distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_version

The version of the launch template to use for faster launching for a Windows AMI.

image.distribution_configuration.distributions[].fast_launch_configurations[].max_parallel_launches

The maximum number of parallel instances that are launched for creating resources.

image.distribution_configuration.distributions[].fast_launch_configurations[].snapshot_configuration

Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

Show child fields
image.distribution_configuration.distributions[].fast_launch_configurations[].snapshot_configuration.target_resource_count

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

image.distribution_configuration.distributions[].launch_template_configurations[]
Show child fields
image.distribution_configuration.distributions[].launch_template_configurations[].account_id

The account ID that this configuration applies to.

image.distribution_configuration.distributions[].launch_template_configurations[].launch_template_id

Identifies the Amazon EC2 launch template to use.

image.distribution_configuration.distributions[].launch_template_configurations[].set_default_version

Set the specified Amazon EC2 launch template as the default launch template for the specified account.

image.distribution_configuration.distributions[].license_configuration_arns[]
image.distribution_configuration.distributions[].region

The target Region.

image.distribution_configuration.distributions[].s3_export_configuration

Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

Show child fields
image.distribution_configuration.distributions[].s3_export_configuration.disk_image_format

Export the updated image to one of the following supported disk image formats:

  • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

  • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

  • Raw – Raw format.

image.distribution_configuration.distributions[].s3_export_configuration.role_name

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

image.distribution_configuration.distributions[].s3_export_configuration.s3_bucket

The S3 bucket in which to store the output disk images for your VM.

image.distribution_configuration.distributions[].s3_export_configuration.s3_prefix

The Amazon S3 path for the bucket where the output disk images for your VM are stored.

image.distribution_configuration.name

The name of the distribution configuration.

image.distribution_configuration.tags

The tags of the distribution configuration.

image.distribution_configuration.timeout_minutes

The maximum duration in minutes for this distribution configuration.

image.enhanced_image_metadata_enabled

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

image.execution_role

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

image.image_recipe

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.

Show child fields
image.image_recipe.additional_instance_configuration

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

Show child fields
image.image_recipe.additional_instance_configuration.systems_manager_agent

Contains settings for the Systems Manager agent on your build instance.

Show child fields
image.image_recipe.additional_instance_configuration.systems_manager_agent.uninstall_after_build

Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

image.image_recipe.additional_instance_configuration.user_data_override

Use this property to provide commands or a command script to run when you launch your build instance.

The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:

#!/bin/bash

mkdir -p /var/bb/

touch /var

image.image_recipe.arn

The Amazon Resource Name (ARN) of the image recipe.

image.image_recipe.block_device_mappings[]
Show child fields
image.image_recipe.block_device_mappings[].device_name

The device to which these mappings apply.

image.image_recipe.block_device_mappings[].ebs

Use to manage Amazon EBS-specific configuration for this mapping.

Show child fields
image.image_recipe.block_device_mappings[].ebs.delete_on_termination

Use to configure delete on termination of the associated device.

image.image_recipe.block_device_mappings[].ebs.encrypted

Use to configure device encryption.

image.image_recipe.block_device_mappings[].ebs.iops

Use to configure device IOPS.

image.image_recipe.block_device_mappings[].ebs.kms_key_id

Use to configure the KMS key to use when encrypting the device.

image.image_recipe.block_device_mappings[].ebs.snapshot_id

The snapshot that defines the device contents.

image.image_recipe.block_device_mappings[].ebs.throughput

For GP3 volumes only – The throughput in MiB/s that the volume supports.

image.image_recipe.block_device_mappings[].ebs.volume_size

Use to override the device's volume size.

image.image_recipe.block_device_mappings[].ebs.volume_type

Use to override the device's volume type.

image.image_recipe.block_device_mappings[].no_device

Use to remove a mapping from the base image.

image.image_recipe.block_device_mappings[].virtual_name

Use to manage instance ephemeral devices.

image.image_recipe.components[]
Show child fields
image.image_recipe.components[].component_arn

The Amazon Resource Name (ARN) of the component.

image.image_recipe.components[].parameters[]
Show child fields
image.image_recipe.components[].parameters[].name

The name of the component parameter to set.

image.image_recipe.components[].parameters[].value[]
image.image_recipe.date_created

The date on which this image recipe was created.

image.image_recipe.description

The description of the image recipe.

image.image_recipe.name

The name of the image recipe.

image.image_recipe.owner

The owner of the image recipe.

image.image_recipe.parent_image

The base image of the image recipe.

image.image_recipe.platform

The platform of the image recipe.

image.image_recipe.tags

The tags of the image recipe.

image.image_recipe.type

Specifies which type of image is created by the recipe - an AMI or a container image.

image.image_recipe.version

The version of the image recipe.

image.image_recipe.working_directory

The working directory to be used during build and test workflows.

image.image_scanning_configuration

Contains settings for vulnerability scans.

Show child fields
image.image_scanning_configuration.ecr_configuration

Contains Amazon ECR settings for vulnerability scans.

Show child fields
image.image_scanning_configuration.ecr_configuration.container_tags[]
image.image_scanning_configuration.ecr_configuration.repository_name

The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

image.image_scanning_configuration.image_scanning_enabled

A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

image.image_source

The origin of the base image that Image Builder used to build this image.

image.image_tests_configuration

The image tests that ran when that Image Builder created this image.

Show child fields
image.image_tests_configuration.image_tests_enabled

Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

image.image_tests_configuration.timeout_minutes

The maximum time in minutes that tests are permitted to run.

The timeoutMinutes attribute is not currently active. This value is ignored.

image.infrastructure_configuration

The infrastructure that Image Builder used to create this image.

Show child fields
image.infrastructure_configuration.arn

The Amazon Resource Name (ARN) of the infrastructure configuration.

image.infrastructure_configuration.date_created

The date on which the infrastructure configuration was created.

image.infrastructure_configuration.date_updated

The date on which the infrastructure configuration was last updated.

image.infrastructure_configuration.description

The description of the infrastructure configuration.

image.infrastructure_configuration.instance_metadata_options

The instance metadata option settings for the infrastructure configuration.

Show child fields
image.infrastructure_configuration.instance_metadata_options.http_put_response_hop_limit

Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

image.infrastructure_configuration.instance_metadata_options.http_tokens

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

  • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

  • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

image.infrastructure_configuration.instance_profile_name

The instance profile of the infrastructure configuration.

image.infrastructure_configuration.instance_types[]
image.infrastructure_configuration.key_pair

The Amazon EC2 key pair of the infrastructure configuration.

image.infrastructure_configuration.logging

The logging configuration of the infrastructure configuration.

Show child fields
image.infrastructure_configuration.logging.s3_logs

The Amazon S3 logging configuration.

Show child fields
image.infrastructure_configuration.logging.s3_logs.s3_bucket_name

The S3 bucket in which to store the logs.

image.infrastructure_configuration.logging.s3_logs.s3_key_prefix

The Amazon S3 path to the bucket where the logs are stored.

image.infrastructure_configuration.name

The name of the infrastructure configuration.

image.infrastructure_configuration.resource_tags

The tags attached to the resource created by Image Builder.

image.infrastructure_configuration.security_group_ids[]
image.infrastructure_configuration.sns_topic_arn

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

image.infrastructure_configuration.subnet_id

The subnet ID of the infrastructure configuration.

image.infrastructure_configuration.tags

The tags of the infrastructure configuration.

image.infrastructure_configuration.terminate_instance_on_failure

The terminate instance on failure configuration of the infrastructure configuration.

image.lifecycle_execution_id

Identifies the last runtime instance of the lifecycle policy to take action on the image.

image.name

The name of the image.

image.os_version

The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

image.output_resources

The output resources that Image Builder produces for this image.

Show child fields
image.output_resources.amis[]
Show child fields
image.output_resources.amis[].account_id

The account ID of the owner of the AMI.

image.output_resources.amis[].description

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

image.output_resources.amis[].image

The AMI ID of the Amazon EC2 AMI.

image.output_resources.amis[].name

The name of the Amazon EC2 AMI.

image.output_resources.amis[].region

The Amazon Web Services Region of the Amazon EC2 AMI.

image.output_resources.amis[].state

Image status and the reason for that status.

Show child fields
image.output_resources.amis[].state.reason

The reason for the status of the image.

image.output_resources.amis[].state.status

The status of the image.

image.output_resources.containers[]
Show child fields
image.output_resources.containers[].image_uris[]
image.output_resources.containers[].region

Containers and container images are Region-specific. This is the Region context for the container.

image.platform

The image operating system platform, such as Linux or Windows.

image.scan_state

Contains information about the current state of scans for this image.

Show child fields
image.scan_state.reason

The reason for the scan status for the image.

image.scan_state.status

The current state of vulnerability scans for the image.

image.source_pipeline_arn

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

image.source_pipeline_name

The name of the image pipeline that created this image.

image.state

The state of the image.

Show child fields
image.state.reason

The reason for the status of the image.

image.state.status

The status of the image.

image.tags

The tags that apply to this image.

image.type

Specifies whether this image produces an AMI or a container image.

image.version

The semantic version of the image.

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 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.

image.workflows[]
Show child fields
image.workflows[].on_failure

The action to take if the workflow fails.

image.workflows[].parallel_group

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

image.workflows[].parameters[]
Show child fields
image.workflows[].parameters[].name

The name of the workflow parameter to set.

image.workflows[].parameters[].value[]
image.workflows[].workflow_arn

The Amazon Resource Name (ARN) of the workflow resource.

request_id

The request ID that uniquely identifies this request.

VARCHAR