Skip to content

Microvm

A MicroVM as GetMicrovm last described it.

endpoint: string;

The proxy endpoint. Pair it with the agent token in Session.attach.


id: string;

optional idlePolicy?: IdlePolicy;

imageArn: string;

imageVersion: string;

optional maximumDurationSeconds?: number;

maximumDurationInSeconds. Suspended time counts toward it.


optional startedAt?: number;

When the VM first started, as Unix seconds.


state: string;

As the service spells it. Eventually consistent.


optional stateReason?: string;

Why the VM is in this state, when the service said.


optional terminatedAt?: number;

When the VM terminated, as Unix seconds, once it has.

This page is generated from bindings/microvms-js/index.d.ts by TypeDoc 0.28.20 and typedoc-plugin-markdown 4.13.1, run from site/scripts/gen-reference.mjs on every pnpm run sync, so an edit made here is overwritten by the next run.

To change the page, change the doc comment in the binding’s Rust source, then regenerate the declarations with mise run dts. mise run dts:check fails when the committed file no longer matches the source.