microvm_image_builds

Creates, updates, deletes, gets or lists a microvm_image_builds resource.

Overview

Name	microvm_image_builds
Type	Resource
Id	aws.lambda_microvms.microvm_image_builds

Fields

The following fields are returned by SELECT queries:

get_microvm_image_build

Name	Datatype	Description
architecture	string	The target CPU architecture for the build. Supported value: ARM_64. (ARM_64)
build_id	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
build_state	string	The current state of the build. (PENDING, IN_PROGRESS, SUCCESSFUL, FAILED)
chipset	string	The target chipset for the build. (GRAVITON)
chipset_generation	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
created_at	string (date-time)	The timestamp when the build was created.
image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
snapshot_build	object	The snapshot build details, including memory and disk snapshot sizes.
state_reason	string	The reason for the build state, if applicable.

list_microvm_image_builds

Name	Datatype	Description
architecture	string	The target CPU architecture for the build. Supported value: ARM_64. (ARM_64)
build_id	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
build_state	string	The current state of the build. (PENDING, IN_PROGRESS, SUCCESSFUL, FAILED)
chipset	string	The target chipset for the build. (GRAVITON)
chipset_generation	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
created_at	string (date-time)	The timestamp when the build was created.
image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
state_reason	string	The reason for the build state, if applicable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_microvm_image_build	select	image_identifier, image_version, build_id, region		Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.
list_microvm_image_builds	select	image_identifier, image_version, region	maxResults, nextToken, architecture, chipset, chipsetGeneration	Lists builds for a MicroVM image version with optional filtering by architecture and chipset. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
build_id	string	The unique identifier of the build to retrieve.
image_identifier	string	The unique identifier (ARN or ID) of the MicroVM image.
image_version	string	The version of the MicroVM image to list builds for.
region	string	AWS region (default: us-east-1)
architecture	string	Filters builds by target CPU architecture.
chipset	string	Filters builds by target chipset.
chipsetGeneration	string	Filters builds by target chipset generation.
maxResults	integer	The maximum number of results to return in a single call.
nextToken	string	The pagination token from a previous call. Use this token to retrieve the next page of results.

SELECT examples

get_microvm_image_build

Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.

SELECT
architecture,
build_id,
build_state,
chipset,
chipset_generation,
created_at,
image_arn,
image_version,
snapshot_build,
state_reason
FROM aws.lambda_microvms.microvm_image_builds
WHERE image_identifier = '{{ image_identifier }}' -- required
AND image_version = '{{ image_version }}' -- required
AND build_id = '{{ build_id }}' -- required
AND region = '{{ region }}' -- required
;

list_microvm_image_builds

Lists builds for a MicroVM image version with optional filtering by architecture and chipset. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
architecture,
build_id,
build_state,
chipset,
chipset_generation,
created_at,
image_arn,
image_version,
state_reason
FROM aws.lambda_microvms.microvm_image_builds
WHERE image_identifier = '{{ image_identifier }}' -- required
AND image_version = '{{ image_version }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND architecture = '{{ architecture }}'
AND chipset = '{{ chipset }}'
AND chipsetGeneration = '{{ chipsetGeneration }}'
;