Everything a launch takes beyond what the layer fixes (egress on, the image).
Properties
Section titled “Properties”agentToken?
Section titled “agentToken?”optional agentToken?: string;Persist this secret privately before launch when recovery is needed.
autoResume?
Section titled “autoResume?”optional autoResume?: boolean;clientToken?
Section titled “clientToken?”optional clientToken?: string;Persist once per intended launch and reuse with the identical request.
disableLogging?
Section titled “disableLogging?”optional disableLogging?: boolean;Turns per-VM logging off. Cannot be combined with logGroup or logStream.
egressNetworkConnectors?
Section titled “egressNetworkConnectors?”optional egressNetworkConnectors?: string[];Customer-managed VPC egress connector ARNs. When given they replace the managed internet connector, and the VPC must route to Bedrock.
executionRoleArn?
Section titled “executionRoleArn?”optional executionRoleArn?: string;The execution role. Optional in the model; every real launch needs one.
imageIdentifier
Section titled “imageIdentifier”imageIdentifier: string;The image ARN from findImage or buildImage, or a bare image name, which the core
resolves with one ListMicrovmImages read.
imageVersion?
Section titled “imageVersion?”optional imageVersion?: string;Pins the launch to one image version rather than the latest active one.
launchEnv?
Section titled “launchEnv?”optional launchEnv?: Record<string, string>;The base environment for every exec in the VM. See RunOptions.launchEnv.
logGroup?
Section titled “logGroup?”optional logGroup?: string;Per-VM CloudWatch log group. Omitted keeps the service’s default destination.
logStream?
Section titled “logStream?”optional logStream?: string;An exact log stream inside logGroup.
maxDurationSec?
Section titled “maxDurationSec?”optional maxDurationSec?: number;maxIdleSec?
Section titled “maxIdleSec?”optional maxIdleSec?: number;readyTimeout?
Section titled “readyTimeout?”optional readyTimeout?: number;How long to wait for RUNNING. The wait for the daemon after it is the core’s
defaultReadyTimeoutSeconds.
shell?
Section titled “shell?”optional shell?: boolean;Launch shell-capable. See RunOptions.shell.
suspendedSec?
Section titled “suspendedSec?”optional suspendedSec?: number;Provenance
Section titled “Provenance”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.