Skip to content

RunMicrovmRequest

Source code in docs_src/capo_lambda_microvms/types/run_microvm_request.py
class RunMicrovmRequest(TypedDict, closed=True):
    ingress_network_connectors: NotRequired[
        "capo_lambda_microvms.types.network_connector_list.NetworkConnectorList"
    ]
    """<p>The list of ingress network connectors to configure for the MicroVM.</p>"""
    egress_network_connectors: NotRequired[
        "capo_lambda_microvms.types.network_connector_list.NetworkConnectorList"
    ]
    """<p>The list of egress network connectors to configure for the MicroVM.</p>"""
    image_identifier: (
        "capo_lambda_microvms.types.microvm_image_identifier.MicrovmImageIdentifier"
    )
    """<p>The identifier (ARN or ID) of the MicroVM image to run.</p>"""
    image_version: NotRequired["capo_lambda_microvms.types.version.Version"]
    """<p>The version of the MicroVM image to run.</p>"""
    execution_role_arn: NotRequired["capo_lambda_microvms.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM role to be assumed by the MicroVM during execution.</p>"""
    idle_policy: NotRequired["capo_lambda_microvms.types.idle_policy.IdlePolicy"]
    """<p>Configuration to control auto-suspend and auto-resume behavior.</p>"""
    logging: NotRequired["capo_lambda_microvms.types.logging.Logging"]
    """<p>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.</p>"""
    run_hook_payload: NotRequired[
        "capo_lambda_microvms.types.run_hook_payload.RunHookPayload"
    ]
    """<p>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.</p>"""
    maximum_duration_in_seconds: NotRequired["int"]
    """<p>The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).</p>"""
    client_token: NotRequired["str"]
    """<p>A unique, case-sensitive identifier you provide to ensure the idempotency of the request.</p>"""

client_token instance-attribute

client_token: NotRequired[str]

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

egress_network_connectors instance-attribute

egress_network_connectors: NotRequired[NetworkConnectorList]

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

execution_role_arn instance-attribute

execution_role_arn: NotRequired[RoleArn]

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

idle_policy instance-attribute

idle_policy: NotRequired[IdlePolicy]

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

image_identifier instance-attribute

image_identifier: MicrovmImageIdentifier

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

image_version instance-attribute

image_version: NotRequired[Version]

The version of the MicroVM image to run.

ingress_network_connectors instance-attribute

ingress_network_connectors: NotRequired[NetworkConnectorList]

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

logging instance-attribute

logging: NotRequired[Logging]

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.

maximum_duration_in_seconds instance-attribute

maximum_duration_in_seconds: NotRequired[int]

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

run_hook_payload instance-attribute

run_hook_payload: NotRequired[RunHookPayload]

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.