microvm_image_versions

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

Overview

Name	microvm_image_versions
Type	Resource
Id	aws.lambda_microvms.microvm_image_versions

Fields

The following fields are returned by SELECT queries:

get_microvm_image_version

Name	Datatype	Description
additional_os_capabilities	array	List of capabilities granted to the application when booted
base_image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
base_image_version	string	The specific version of the base MicroVM image. (pattern: <code>[^\s]+</code>)
build_role_arn	string	The ARN of an IAM role that the service assumes to perform actions on behalf of the caller. (pattern: <code>arn:aws[a-z-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
code_artifact	object	Contains the location of the code artifact for a MicroVM image.
cpu_configurations	array	List of CPU architectures
created_at	string (date-time)	The timestamp when the version was created.
description	string	The description of the version.
egress_network_connectors	array	The list of egress network connectors available to the MicroVM at runtime.
environment_variables	object	Environment variables set in the MicroVM runtime environment.
hooks	object	Lifecycle hook configuration for MicroVMs and MicroVM images.
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>)
logging	object	Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging.
resources	array	List of resources
state	string	The current state of the version. (PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, DELETING, DELETED, DELETE_FAILED)
state_reason	string	The reason for the current state. For example, one or more builds failed.
status	string	The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs). (ACTIVE, INACTIVE)
tags	object	Key-value pairs associated with the version.
updated_at	string (date-time)	The timestamp when the version was last updated.

list_microvm_image_versions

Name	Datatype	Description
additional_os_capabilities	array	List of capabilities granted to the application when booted
base_image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
base_image_version	string	The specific version of the base MicroVM image. (pattern: <code>[^\s]+</code>)
build_role_arn	string	The ARN of an IAM role that the service assumes to perform actions on behalf of the caller. (pattern: <code>arn:aws[a-z-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
code_artifact	object	Contains the location of the code artifact for a MicroVM image.
cpu_configurations	array	List of CPU architectures
created_at	string (date-time)	The timestamp when the version was created.
description	string	The description of the version.
egress_network_connectors	array	The list of egress network connectors available to the MicroVM at runtime.
environment_variables	object	Environment variables set in the MicroVM runtime environment.
hooks	object	Lifecycle hook configuration for MicroVMs and MicroVM images.
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>)
logging	object	Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging.
resources	array	List of resources
state	string	The current state of the version. (PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, DELETING, DELETED, DELETE_FAILED)
state_reason	string	The reason for the current state. For example, one or more builds failed.
status	string	The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs). (ACTIVE, INACTIVE)
tags	object	Key-value pairs associated with the version.
updated_at	string (date-time)	The timestamp when the version was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_microvm_image_version	select	image_identifier, image_version, region		Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.
list_microvm_image_versions	select	image_identifier, region	maxResults, nextToken	Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
update_microvm_image_version	update	image_identifier, image_version, region, status		Updates the status of a specific MicroVM image version.
delete_microvm_image_version	delete	image_identifier, image_version, region		Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.

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
image_identifier	string	The unique identifier (ARN or ID) of the MicroVM image.
image_version	string	The version of the MicroVM image to delete.
region	string	AWS region (default: us-east-1)
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_version

Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.

SELECT
additional_os_capabilities,
base_image_arn,
base_image_version,
build_role_arn,
code_artifact,
cpu_configurations,
created_at,
description,
egress_network_connectors,
environment_variables,
hooks,
image_arn,
image_version,
logging,
resources,
state,
state_reason,
status,
tags,
updated_at
FROM aws.lambda_microvms.microvm_image_versions
WHERE image_identifier = '{{ image_identifier }}' -- required
AND image_version = '{{ image_version }}' -- required
AND region = '{{ region }}' -- required
;

list_microvm_image_versions

Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
additional_os_capabilities,
base_image_arn,
base_image_version,
build_role_arn,
code_artifact,
cpu_configurations,
created_at,
description,
egress_network_connectors,
environment_variables,
hooks,
image_arn,
image_version,
logging,
resources,
state,
state_reason,
status,
tags,
updated_at
FROM aws.lambda_microvms.microvm_image_versions
WHERE image_identifier = '{{ image_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_microvm_image_version

Updates the status of a specific MicroVM image version.

UPDATE aws.lambda_microvms.microvm_image_versions
SET 
status = '{{ status }}'
WHERE 
image_identifier = '{{ image_identifier }}' --required
AND image_version = '{{ image_version }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required
RETURNING
additional_os_capabilities,
base_image_arn,
base_image_version,
build_role_arn,
code_artifact,
cpu_configurations,
created_at,
description,
egress_network_connectors,
environment_variables,
hooks,
image_arn,
image_version,
logging,
resources,
state,
state_reason,
status,
tags,
updated_at;

DELETE examples

delete_microvm_image_version

Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.

DELETE FROM aws.lambda_microvms.microvm_image_versions
WHERE image_identifier = '{{ image_identifier }}' --required
AND image_version = '{{ image_version }}' --required
AND region = '{{ region }}' --required
;