microvm_images

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

Overview

Name	microvm_images
Type	Resource
Id	aws.lambda_microvms.microvm_images

Fields

The following fields are returned by SELECT queries:

get_microvm_image

Name	Datatype	Description
name	string	Name of a MicroVM image. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_at	string (date-time)	The timestamp when the MicroVM image was created.
image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
latest_active_image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
latest_failed_image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
state	string	The current state of the MicroVM image. (CREATING, CREATED, CREATE_FAILED, UPDATING, UPDATED, UPDATE_FAILED, DELETING, DELETE_FAILED, DELETED)
tags	object	A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.
updated_at	string (date-time)	The timestamp when the MicroVM image was last updated.

list_microvm_images

Name	Datatype	Description
name	string	Name of a MicroVM image. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_at	string (date-time)	The timestamp when the MicroVM image was created.
image_arn	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
latest_active_image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
latest_failed_image_version	string	A string which is not empty or blank (only whitespace). (pattern: <code>[^\s]+</code>)
state	string	The current state of the MicroVM image. (CREATING, CREATED, CREATE_FAILED, UPDATING, UPDATED, UPDATE_FAILED, DELETING, DELETE_FAILED, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_microvm_image	select	image_identifier, region		Retrieves the details of a MicroVM image, including its state, versions, and configuration.
list_microvm_images	select	region	maxResults, nextToken, nameFilter	Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.
create_microvm_image	insert	region, baseImageArn, buildRoleArn, codeArtifact, name		Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.
update_microvm_image	update	image_identifier, region, baseImageArn, buildRoleArn, codeArtifact		Updates the configuration of a MicroVM image and triggers a new version build. This operation uses PUT semantics — all required fields (codeArtifact, baseImageArn, buildRoleArn) must be provided with every request.
delete_microvm_image	delete	image_identifier, region		Deletes a MicroVM image. This operation is idempotent; deleting an image 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 to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in a single call.
nameFilter	string	Filters images whose name contains the specified string.
nextToken	string	The pagination token from a previous call. Use this token to retrieve the next page of results.

SELECT examples

get_microvm_image

Retrieves the details of a MicroVM image, including its state, versions, and configuration.

SELECT
name,
created_at,
image_arn,
latest_active_image_version,
latest_failed_image_version,
state,
tags,
updated_at
FROM aws.lambda_microvms.microvm_images
WHERE image_identifier = '{{ image_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_microvm_images

Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.

SELECT
name,
created_at,
image_arn,
latest_active_image_version,
latest_failed_image_version,
state
FROM aws.lambda_microvms.microvm_images
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND nameFilter = '{{ nameFilter }}'
;

INSERT examples

create_microvm_image

Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.

INSERT INTO aws.lambda_microvms.microvm_images (
baseImageArn,
baseImageVersion,
buildRoleArn,
description,
codeArtifact,
logging,
egressNetworkConnectors,
cpuConfigurations,
resources,
additionalOsCapabilities,
hooks,
environmentVariables,
name,
tags,
clientToken,
region
)
SELECT 
'{{ baseImageArn }}' /* required */,
'{{ baseImageVersion }}',
'{{ buildRoleArn }}' /* required */,
'{{ description }}',
'{{ codeArtifact }}' /* required */,
'{{ logging }}',
'{{ egressNetworkConnectors }}',
'{{ cpuConfigurations }}',
'{{ resources }}',
'{{ additionalOsCapabilities }}',
'{{ hooks }}',
'{{ environmentVariables }}',
'{{ name }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
name,
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,
latest_active_image_version,
latest_failed_image_version,
logging,
resources,
state,
tags,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: microvm_images
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the microvm_images resource.
  - name: baseImageArn
    value: "{{ baseImageArn }}"
    description: |
      A string which is not empty or blank (only whitespace).
  - name: baseImageVersion
    value: "{{ baseImageVersion }}"
  - name: buildRoleArn
    value: "{{ buildRoleArn }}"
    description: |
      The ARN of an IAM role that the service assumes to perform actions on behalf of the caller.
  - name: description
    value: "{{ description }}"
  - name: codeArtifact
    description: |
      Contains the location of the code artifact for a MicroVM image.
    value:
      uri: "{{ uri }}"
  - name: logging
    description: |
      Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging.
    value:
      disabled: "{{ disabled }}"
      cloudWatch:
        logGroup: "{{ logGroup }}"
        logStream: "{{ logStream }}"
  - name: egressNetworkConnectors
    value:
      - "{{ egressNetworkConnectors }}"
  - name: cpuConfigurations
    description: |
      List of CPU architectures
    value:
      - architecture: "{{ architecture }}"
  - name: resources
    description: |
      List of resources
    value:
      - minimumMemoryInMiB: {{ minimumMemoryInMiB }}
  - name: additionalOsCapabilities
    value:
      - "{{ additionalOsCapabilities }}"
    description: |
      List of capabilities granted to the application when booted
  - name: hooks
    description: |
      Lifecycle hook configuration for MicroVMs and MicroVM images.
    value:
      port: {{ port }}
      microvmHooks:
        run: "{{ run }}"
        runTimeoutInSeconds: {{ runTimeoutInSeconds }}
        resume: "{{ resume }}"
        resumeTimeoutInSeconds: {{ resumeTimeoutInSeconds }}
        suspend: "{{ suspend }}"
        suspendTimeoutInSeconds: {{ suspendTimeoutInSeconds }}
        terminate: "{{ terminate }}"
        terminateTimeoutInSeconds: {{ terminateTimeoutInSeconds }}
      microvmImageHooks:
        ready: "{{ ready }}"
        readyTimeoutInSeconds: {{ readyTimeoutInSeconds }}
        validate: "{{ validate }}"
        validateTimeoutInSeconds: {{ validateTimeoutInSeconds }}
  - name: environmentVariables
    value: "{{ environmentVariables }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of a MicroVM image.
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_microvm_image

Updates the configuration of a MicroVM image and triggers a new version build. This operation uses PUT semantics — all required fields (codeArtifact, baseImageArn, buildRoleArn) must be provided with every request.

UPDATE aws.lambda_microvms.microvm_images
SET 
baseImageArn = '{{ baseImageArn }}',
baseImageVersion = '{{ baseImageVersion }}',
buildRoleArn = '{{ buildRoleArn }}',
description = '{{ description }}',
codeArtifact = '{{ codeArtifact }}',
logging = '{{ logging }}',
egressNetworkConnectors = '{{ egressNetworkConnectors }}',
cpuConfigurations = '{{ cpuConfigurations }}',
resources = '{{ resources }}',
additionalOsCapabilities = '{{ additionalOsCapabilities }}',
hooks = '{{ hooks }}',
environmentVariables = '{{ environmentVariables }}',
clientToken = '{{ clientToken }}'
WHERE 
image_identifier = '{{ image_identifier }}' --required
AND region = '{{ region }}' --required
AND baseImageArn = '{{ baseImageArn }}' --required
AND buildRoleArn = '{{ buildRoleArn }}' --required
AND codeArtifact = '{{ codeArtifact }}' --required
RETURNING
name,
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,
latest_active_image_version,
latest_failed_image_version,
logging,
resources,
state,
updated_at;

DELETE examples

delete_microvm_image

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

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