Skip to content

CreateMicrovmImageRequest

Source code in docs_src/capo_lambda_microvms/types/create_microvm_image_request.py
class CreateMicrovmImageRequest(TypedDict, closed=True):
    base_image_arn: "capo_lambda_microvms.types.non_blank_string.NonBlankString"
    """<p>The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.</p>"""
    base_image_version: NotRequired["capo_lambda_microvms.types.version.Version"]
    """<p>The specific version of the base MicroVM image to use.</p>"""
    build_role_arn: "capo_lambda_microvms.types.role_arn.RoleArn"
    """<p>The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.</p>"""
    description: NotRequired["str"]
    """<p>A description of the MicroVM image.</p>"""
    code_artifact: "capo_lambda_microvms.types.code_artifact.CodeArtifact"
    """<p>The code artifact containing the application code and metadata for the MicroVM image.</p>"""
    logging: NotRequired["capo_lambda_microvms.types.logging.Logging"]
    """<p>The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.</p>"""
    egress_network_connectors: NotRequired[
        "capo_lambda_microvms.types.network_connector_list.NetworkConnectorList"
    ]
    """<p>The list of egress network connectors available to the MicroVM at runtime.</p>"""
    cpu_configurations: NotRequired[
        "capo_lambda_microvms.types.cpu_configuration_list.CpuConfigurationList"
    ]
    """<p>The list of supported CPU configurations for the MicroVM.</p>"""
    resources: NotRequired["capo_lambda_microvms.types.resources_list.ResourcesList"]
    """<p>The resource requirements for the MicroVM.</p>"""
    additional_os_capabilities: NotRequired[
        "capo_lambda_microvms.types.capability_list.CapabilityList"
    ]
    """<p>Additional OS capabilities granted to the MicroVM runtime environment.</p>"""
    hooks: NotRequired["capo_lambda_microvms.types.hooks.Hooks"]
    environment_variables: NotRequired[
        "capo_lambda_microvms.types.environment_variable_map.EnvironmentVariableMap"
    ]
    """<p>Environment variables set in the MicroVM runtime environment.</p>"""
    name: "capo_lambda_microvms.types.image_name.ImageName"
    """<p>The name of the MicroVM image. Must be unique within the AWS account.</p>"""
    tags: NotRequired["capo_lambda_microvms.types.tags.Tags"]
    """<p>A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.</p>"""
    client_token: NotRequired["str"]
    """<p>A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.</p>"""

additional_os_capabilities instance-attribute

additional_os_capabilities: NotRequired[CapabilityList]

Additional OS capabilities granted to the MicroVM runtime environment.

base_image_arn instance-attribute

base_image_arn: NonBlankString

The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.

base_image_version instance-attribute

base_image_version: NotRequired[Version]

The specific version of the base MicroVM image to use.

build_role_arn instance-attribute

build_role_arn: RoleArn

The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.

client_token instance-attribute

client_token: NotRequired[str]

A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.

code_artifact instance-attribute

code_artifact: CodeArtifact

The code artifact containing the application code and metadata for the MicroVM image.

cpu_configurations instance-attribute

cpu_configurations: NotRequired[CpuConfigurationList]

The list of supported CPU configurations for the MicroVM.

description instance-attribute

description: NotRequired[str]

A description of the MicroVM image.

egress_network_connectors instance-attribute

egress_network_connectors: NotRequired[NetworkConnectorList]

The list of egress network connectors available to the MicroVM at runtime.

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariableMap]

Environment variables set in the MicroVM runtime environment.

hooks instance-attribute

hooks: NotRequired[Hooks]

logging instance-attribute

logging: NotRequired[Logging]

The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

name instance-attribute

name: ImageName

The name of the MicroVM image. Must be unique within the AWS account.

resources instance-attribute

resources: NotRequired[ResourcesList]

The resource requirements for the MicroVM.

tags instance-attribute

tags: NotRequired[Tags]

A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.