create-microvm-image¶

Description¶

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.

Synopsis¶

  create-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>]
--name <value>
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--base-image-arn (string) [required]

The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

--base-image-version (string)

The specific version of the base MicroVM image to use.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

--build-role-arn (string) [required]

The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.

Constraints:

min: 20

max: 2048

pattern: arn:aws[a-z\-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

--description (string)

A description of the MicroVM image.

--code-artifact (tagged union structure) [required]

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.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

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.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9_\-/.#]+

logStream -> (string)

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

Constraints:

min: 1

max: 512

pattern: [^:*]*

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.

Constraints:

min: 0

max: 1

(string)

Constraints:

min: 1

max: 2048

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) [required]

The CPU architecture.

Possible values:

ARM_64

Shorthand Syntax:

architecture=string ...

JSON Syntax:

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

--resources (list)

The resource requirements for the MicroVM.

Constraints:

min: 0

max: 1

(structure)

Resource requirements for a MicroVM.

minimumMemoryInMiB -> (integer) [required]

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

Possible values:

ALL

Syntax:

"string" "string" ...

--hooks (structure)

Lifecycle hook configuration for MicroVMs and MicroVM images.

port -> (integer)

The port number on which the hooks listener runs.

Constraints:

min: 1

max: 65535

microvmHooks -> (structure)

The lifecycle hooks for MicroVM events.

run -> (string)

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

Possible values:

DISABLED

ENABLED

runTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

resume -> (string)

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

Possible values:

DISABLED

ENABLED

resumeTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

suspend -> (string)

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

Possible values:

DISABLED

ENABLED

suspendTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

terminate -> (string)

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

Possible values:

DISABLED

ENABLED

terminateTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

microvmImageHooks -> (structure)

The hooks for MicroVM image build events.

ready -> (string)

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

Possible values:

DISABLED

ENABLED

readyTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 3600

validate -> (string)

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

Possible values:

DISABLED

ENABLED

validateTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 3600

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.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 256

pattern: [^\s]+

value -> (string)

Constraints:

min: 0

max: 4096

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--name (string) [required]

The name of the MicroVM image. Must be unique within the AWS account.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-_]+

--tags (map)

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.

key -> (string)

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--client-token (string)

A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.

Constraints:

min: 1

max: 128

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

imageArn -> (string)

The ARN of the created MicroVM image.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

name -> (string)

The name of the MicroVM image.

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-_]+

state -> (string)

The current state of the MicroVM image.

Possible values:

CREATING

CREATED

CREATE_FAILED

UPDATING

UPDATED

UPDATE_FAILED

DELETING

DELETE_FAILED

DELETED

latestActiveImageVersion -> (string)

The latest active version of the MicroVM image.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

latestFailedImageVersion -> (string)

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

Constraints:

min: 1

max: 2048

pattern: [^\s]+

createdAt -> (timestamp)

The timestamp when the MicroVM image was created.

baseImageArn -> (string)

The ARN of the base MicroVM image.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

baseImageVersion -> (string)

The specific version of the base MicroVM image.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

buildRoleArn -> (string)

The ARN of the IAM build role.

Constraints:

min: 20

max: 2048

pattern: arn:aws[a-z\-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

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.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

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.

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9_\-/.#]+

logStream -> (string)

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

Constraints:

min: 1

max: 512

pattern: [^:*]*

egressNetworkConnectors -> (list)

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

Constraints:

min: 0

max: 1

(string)

Constraints:

min: 1

max: 2048

cpuConfigurations -> (list)

The list of supported CPU configurations for the MicroVM.

(structure)

Configuration for the CPU architecture of a MicroVM.

architecture -> (string) [required]

The CPU architecture.

Possible values:

ARM_64

resources -> (list)

The resource requirements for the MicroVM.

Constraints:

min: 0

max: 1

(structure)

Resource requirements for a MicroVM.

minimumMemoryInMiB -> (integer) [required]

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

Possible values:

ALL

hooks -> (structure)

Lifecycle hook configuration for MicroVMs and MicroVM images.

port -> (integer)

The port number on which the hooks listener runs.

Constraints:

min: 1

max: 65535

microvmHooks -> (structure)

The lifecycle hooks for MicroVM events.

run -> (string)

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

Possible values:

DISABLED

ENABLED

runTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

resume -> (string)

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

Possible values:

DISABLED

ENABLED

resumeTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

suspend -> (string)

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

Possible values:

DISABLED

ENABLED

suspendTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

terminate -> (string)

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

Possible values:

DISABLED

ENABLED

terminateTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 60

microvmImageHooks -> (structure)

The hooks for MicroVM image build events.

ready -> (string)

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

Possible values:

DISABLED

ENABLED

readyTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 3600

validate -> (string)

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

Possible values:

DISABLED

ENABLED

validateTimeoutInSeconds -> (integer)

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

Constraints:

min: 1

max: 3600

environmentVariables -> (map)

Environment variables set in the MicroVM runtime environment.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 256

pattern: [^\s]+

value -> (string)

Constraints:

min: 0

max: 4096

tags -> (map)

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.

key -> (string)

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

updatedAt -> (timestamp)

The timestamp when the MicroVM image was last updated.

imageVersion -> (string)

The version of the MicroVM image.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

Table of Contents

Feedback

User Guide

create-microvm-image¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶

Note

Note