AWS CLI Command Reference

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 ]

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.

See also: AWS API Documentation

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

--ingress-network-connectors (list)

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

(string)

Syntax:

"string" "string" ...

--egress-network-connectors (list)

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

(string)

Syntax:

"string" "string" ...

--image-identifier (string)

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

--image-version (string)

The version of the MicroVM image to run.

--execution-role-arn (string)

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

--idle-policy (structure)

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

maxIdleDurationSeconds -> (integer)

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

suspendedDurationSeconds -> (integer)

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

autoResumeEnabled -> (boolean)

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.

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"
  }
}

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

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

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

microvmId -> (string)

The unique identifier of the MicroVM.

state -> (string)

The current lifecycle state of the MicroVM.

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.

imageArn -> (string)

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

imageVersion -> (string)

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

executionRoleArn -> (string)

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

idlePolicy -> (structure)

The idle policy configuration of the MicroVM.

maxIdleDurationSeconds -> (integer)

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

suspendedDurationSeconds -> (integer)

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

autoResumeEnabled -> (boolean)

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.

ingressNetworkConnectors -> (list)

The list of ingress network connectors configured for the MicroVM.

(string)

egressNetworkConnectors -> (list)

The list of egress network connectors configured for the MicroVM.

(string)