run-microvm¶

Description¶

Runs a new MicroVM from the specified image. The MicroVM starts in PENDING state and transitions to RUNNING once provisioning completes. To connect, generate an authentication token using CreateMicrovmAuthToken.

Synopsis¶

  run-microvm
[--ingress-network-connectors <value>]
[--egress-network-connectors <value>]
--image-identifier <value>
[--image-version <value>]
[--execution-role-arn <value>]
[--idle-policy <value>]
[--logging <value>]
[--run-hook-payload <value>]
[--maximum-duration-in-seconds <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¶

--ingress-network-connectors (list)

The list of ingress network connectors to configure for the MicroVM.

Constraints:

min: 0

max: 10

(string)

Constraints:

min: 1

max: 2048

Syntax:

"string" "string" ...

--egress-network-connectors (list)

The list of egress network connectors to configure for the MicroVM.

Constraints:

min: 0

max: 10

(string)

Constraints:

min: 1

max: 2048

Syntax:

"string" "string" ...

--image-identifier (string) [required]

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

Constraints:

min: 1

max: 256

--image-version (string)

The version of the MicroVM image to run.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

--execution-role-arn (string)

The ARN of the IAM role to be assumed by the MicroVM during execution.

Constraints:

min: 20

max: 2048

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

--idle-policy (structure)

Configuration to control auto-suspend and auto-resume behavior.

maxIdleDurationSeconds -> (integer) [required]

The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.

Constraints:

min: 60

suspendedDurationSeconds -> (integer) [required]

The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.

Constraints:

min: 0

autoResumeEnabled -> (boolean) [required]

Indicates whether the MicroVM automatically resumes when it receives a request while suspended.

Shorthand Syntax:

maxIdleDurationSeconds=integer,suspendedDurationSeconds=integer,autoResumeEnabled=boolean

JSON Syntax:

{
  "maxIdleDurationSeconds": integer,
  "suspendedDurationSeconds": integer,
  "autoResumeEnabled": true|false
}

--logging (tagged union structure)

The logging configuration for this MicroVM instance. Specify {“cloudWatch”: {“logGroup”: “…”}} to stream application 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"
  }
}

--run-hook-payload (string)

Per-MicroVM initialization data delivered as the request body of the /run lifecycle hook. Use to pass tenant-specific configuration such as session IDs or secret references. Maximum: 16,384 bytes.

Constraints:

min: 0

max: 4096

--maximum-duration-in-seconds (integer)

The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).

Constraints:

min: 1

max: 28800

--client-token (string)

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

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¶

microvmId -> (string)

The unique identifier of the MicroVM.

Constraints:

min: 1

max: 256

state -> (string)

The current lifecycle state of the MicroVM.

Possible values:

PENDING

RUNNING

SUSPENDING

SUSPENDED

TERMINATING

TERMINATED

endpoint -> (string)

The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.

Constraints:

min: 1

max: 2048

imageArn -> (string)

The ARN of the MicroVM image used to run this MicroVM.

Constraints:

min: 20

max: 2048

imageVersion -> (string)

The version of the MicroVM image used to run this MicroVM.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

executionRoleArn -> (string)

The ARN of the IAM execution role assumed by the MicroVM.

Constraints:

min: 20

max: 2048

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

idlePolicy -> (structure)

The idle policy configuration of the MicroVM.

maxIdleDurationSeconds -> (integer) [required]

The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.

Constraints:

min: 60

suspendedDurationSeconds -> (integer) [required]

The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.

Constraints:

min: 0

autoResumeEnabled -> (boolean) [required]

Indicates whether the MicroVM automatically resumes when it receives a request while suspended.

maximumDurationInSeconds -> (integer)

The maximum duration in seconds that the MicroVM can exist.

startedAt -> (timestamp)

The timestamp when the MicroVM first started.

terminatedAt -> (timestamp)

The timestamp when the MicroVM terminated.

stateReason -> (string)

The reason for why the MicroVM is in the current state.

Constraints:

min: 1

max: 2048

pattern: [^\s]+

ingressNetworkConnectors -> (list)

The list of ingress network connectors configured for the MicroVM.

Constraints:

min: 0

max: 10

(string)

Constraints:

min: 1

max: 2048

egressNetworkConnectors -> (list)

The list of egress network connectors configured for the MicroVM.

Constraints:

min: 0

max: 10

(string)

Constraints:

min: 1

max: 2048

Table of Contents

Feedback

User Guide