Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lambda-microvms ]

update-microvm-image¶

Description¶

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.

Synopsis¶

  update-microvm-image
--base-image-arn <value>
[--base-image-version <value>]
--build-role-arn <value>
[--description <value>]
--code-artifact <value>
[--logging <value>]
[--egress-network-connectors <value>]
[--cpu-configurations <value>]
[--resources <value>]
[--additional-os-capabilities <value>]
[--hooks <value>]
[--environment-variables <value>]
--image-identifier <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--base-image-arn (string)

The ARN of the base MicroVM image.

--base-image-version (string)

The specific version of the base MicroVM image to use.

--build-role-arn (string)

The ARN of the IAM build role.

--description (string)

The description of the MicroVM image.

--code-artifact (tagged union structure)

The code artifact containing the application code and metadata for the MicroVM image.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: uri.

uri -> (string)

The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.

Shorthand Syntax:

uri=string

JSON Syntax:

{
  "uri": "string"
}

--logging (tagged union structure)

The logging configuration for build-time and runtime logs. Specify {“cloudWatch”: {“logGroup”: “…”}} to stream logs to a custom CloudWatch log group, or {“disabled”: {}} to turn off logging.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: disabled, cloudWatch.

disabled -> (structure)

Specifies that logging is disabled.

cloudWatch -> (structure)

Configuration for sending logs to Amazon CloudWatch Logs.

logGroup -> (string)

The name of the CloudWatch Logs log group to send logs to.

logStream -> (string)

The name of the CloudWatch Logs log stream within the log group.

Shorthand Syntax:

disabled={},cloudWatch={logGroup=string,logStream=string}

JSON Syntax:

{
  "disabled": {

  },
  "cloudWatch": {
    "logGroup": "string",
    "logStream": "string"
  }
}

--egress-network-connectors (list)

The list of egress network connectors available to the MicroVM at runtime.

(string)

Syntax:

"string" "string" ...

--cpu-configurations (list)

The list of supported CPU configurations for the MicroVM.

(structure)

Configuration for the CPU architecture of a MicroVM.

architecture -> (string)

The CPU architecture.

Shorthand Syntax:

architecture=string ...

JSON Syntax:

[
  {
    "architecture": "ARM_64"
  }
  ...
]

--resources (list)

The resource requirements for the MicroVM.

(structure)

Resource requirements for a MicroVM.

minimumMemoryInMiB -> (integer)

The minimum amount of memory in MiB to allocate to the MicroVM.

Shorthand Syntax:

minimumMemoryInMiB=integer ...

JSON Syntax:

[
  {
    "minimumMemoryInMiB": integer
  }
  ...
]

--additional-os-capabilities (list)

Additional OS capabilities granted to the MicroVM runtime environment.

(string)

Capability granted to the application when booted

Syntax:

"string" "string" ...

Where valid values are:
  ALL

--hooks (structure)

Lifecycle hook configuration for MicroVMs and MicroVM images.

port -> (integer)

The port number on which the hooks listener runs.

microvmHooks -> (structure)

The lifecycle hooks for MicroVM events.

run -> (string)

The path of the hook invoked when the MicroVM starts running.

runTimeoutInSeconds -> (integer)

The maximum time in seconds for the run hook to complete.

resume -> (string)

The path of the hook invoked when the MicroVM resumes from a suspended state.

resumeTimeoutInSeconds -> (integer)

The maximum time in seconds for the resume hook to complete.

suspend -> (string)

The path of the hook invoked when the MicroVM is suspended.

suspendTimeoutInSeconds -> (integer)

The maximum time in seconds for the suspend hook to complete.

terminate -> (string)

The path of the hook invoked when the MicroVM is terminated.

terminateTimeoutInSeconds -> (integer)

The maximum time in seconds for the terminate hook to complete.

microvmImageHooks -> (structure)

The hooks for MicroVM image build events.

ready -> (string)

The path of the hook invoked when the MicroVM image build is ready.

readyTimeoutInSeconds -> (integer)

The maximum time in seconds for the ready hook to complete.

validate -> (string)

The path of the hook invoked to validate the MicroVM image build.

validateTimeoutInSeconds -> (integer)

The maximum time in seconds for the validate hook to complete.

Shorthand Syntax:

port=integer,microvmHooks={run=string,runTimeoutInSeconds=integer,resume=string,resumeTimeoutInSeconds=integer,suspend=string,suspendTimeoutInSeconds=integer,terminate=string,terminateTimeoutInSeconds=integer},microvmImageHooks={ready=string,readyTimeoutInSeconds=integer,validate=string,validateTimeoutInSeconds=integer}

JSON Syntax:

{
  "port": integer,
  "microvmHooks": {
    "run": "DISABLED"|"ENABLED",
    "runTimeoutInSeconds": integer,
    "resume": "DISABLED"|"ENABLED",
    "resumeTimeoutInSeconds": integer,
    "suspend": "DISABLED"|"ENABLED",
    "suspendTimeoutInSeconds": integer,
    "terminate": "DISABLED"|"ENABLED",
    "terminateTimeoutInSeconds": integer
  },
  "microvmImageHooks": {
    "ready": "DISABLED"|"ENABLED",
    "readyTimeoutInSeconds": integer,
    "validate": "DISABLED"|"ENABLED",
    "validateTimeoutInSeconds": integer
  }
}

--environment-variables (map)

Environment variables set in the MicroVM runtime environment.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--image-identifier (string)

The unique identifier (ARN or ID) of the MicroVM image to update.

--client-token (string)

A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

imageArn -> (string)

The ARN of the MicroVM image.

name -> (string)

The name of the MicroVM image.

state -> (string)

The current state of the MicroVM image.

latestActiveImageVersion -> (string)

The latest active version of the MicroVM image.

latestFailedImageVersion -> (string)

The latest failed version of the MicroVM image, if any.

createdAt -> (timestamp)

The timestamp when the MicroVM image was created.

baseImageArn -> (string)

The ARN of the base MicroVM image.

baseImageVersion -> (string)

The specific version of the base MicroVM image.

buildRoleArn -> (string)

The ARN of the IAM build role.

description -> (string)

The description of the MicroVM image.

codeArtifact -> (tagged union structure)

The code artifact containing the application code and metadata for the MicroVM image.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: uri.

uri -> (string)

The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.

logging -> (tagged union structure)

The logging configuration for build-time and runtime logs. Specify {“cloudWatch”: {“logGroup”: “…”}} to stream logs to a custom CloudWatch log group, or {“disabled”: {}} to turn off logging.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: disabled, cloudWatch.

disabled -> (structure)

Specifies that logging is disabled.

cloudWatch -> (structure)

Configuration for sending logs to Amazon CloudWatch Logs.

logGroup -> (string)

The name of the CloudWatch Logs log group to send logs to.

logStream -> (string)

The name of the CloudWatch Logs log stream within the log group.

egressNetworkConnectors -> (list)

The list of egress network connectors available to the MicroVM at runtime.

(string)

cpuConfigurations -> (list)

The list of supported CPU configurations for the MicroVM.

(structure)

Configuration for the CPU architecture of a MicroVM.

architecture -> (string)

The CPU architecture.

resources -> (list)

The resource requirements for the MicroVM.

(structure)

Resource requirements for a MicroVM.

minimumMemoryInMiB -> (integer)

The minimum amount of memory in MiB to allocate to the MicroVM.

additionalOsCapabilities -> (list)

Additional OS capabilities granted to the MicroVM runtime environment.

(string)

Capability granted to the application when booted

hooks -> (structure)

Lifecycle hook configuration for MicroVMs and MicroVM images.

port -> (integer)

The port number on which the hooks listener runs.

microvmHooks -> (structure)

The lifecycle hooks for MicroVM events.

run -> (string)

The path of the hook invoked when the MicroVM starts running.

runTimeoutInSeconds -> (integer)

The maximum time in seconds for the run hook to complete.

resume -> (string)

The path of the hook invoked when the MicroVM resumes from a suspended state.

resumeTimeoutInSeconds -> (integer)

The maximum time in seconds for the resume hook to complete.

suspend -> (string)

The path of the hook invoked when the MicroVM is suspended.

suspendTimeoutInSeconds -> (integer)

The maximum time in seconds for the suspend hook to complete.

terminate -> (string)

The path of the hook invoked when the MicroVM is terminated.

terminateTimeoutInSeconds -> (integer)

The maximum time in seconds for the terminate hook to complete.

microvmImageHooks -> (structure)

The hooks for MicroVM image build events.

ready -> (string)

The path of the hook invoked when the MicroVM image build is ready.

readyTimeoutInSeconds -> (integer)

The maximum time in seconds for the ready hook to complete.

validate -> (string)

The path of the hook invoked to validate the MicroVM image build.

validateTimeoutInSeconds -> (integer)

The maximum time in seconds for the validate hook to complete.

environmentVariables -> (map)

Environment variables set in the MicroVM runtime environment.

key -> (string)

value -> (string)

updatedAt -> (timestamp)

The timestamp when the MicroVM image was last updated.

imageVersion -> (string)

The version of the MicroVM image.

Table of Contents

Feedback

User Guide

Note:

update-microvm-image¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶

Note

Note