Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Multipass Provider
  4. API Docs
  5. resources
  6. Instance
Viewing docs for Multipass v0.3.2
published on Tuesday, Sep 15, 2026 by incsteps
Schema (JSON)
incsteps/pulumi-provider-multipass

multipass.resources.Instance

Viewing docs for Multipass v0.3.2
published on Tuesday, Sep 15, 2026 by incsteps
Schema (JSON)
incsteps/pulumi-provider-multipass

    A Multipass virtual machine instance.

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             cloudinit: Optional[str] = None,
             cpus: Optional[int] = None,
             disk: Optional[str] = None,
             image: Optional[str] = None,
             memory: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: multipass:resources:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "multipass_resources_instance" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var instanceResource = new Multipass.Resources.Instance("instanceResource", new()
{
    Name = "string",
    Cloudinit = "string",
    Cpus = 0,
    Disk = "string",
    Image = "string",
    Memory = "string",
});

    example, err := resources.NewInstance(ctx, "instanceResource", &resources.InstanceArgs{
	Name:      pulumi.String("string"),
	Cloudinit: pulumi.String("string"),
	Cpus:      pulumi.Int(0),
	Disk:      pulumi.String("string"),
	Image:     pulumi.String("string"),
	Memory:    pulumi.String("string"),
})

    resource "multipass_resources_instance" "instanceResource" {
  lifecycle {
    create_before_destroy = true
  }
  name      = "string"
  cloudinit = "string"
  cpus      = 0
  disk      = "string"
  image     = "string"
  memory    = "string"
}

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .name("string")
    .cloudinit("string")
    .cpus(0)
    .disk("string")
    .image("string")
    .memory("string")
    .build());

    instance_resource = multipass.resources.Instance("instanceResource",
    name="string",
    cloudinit="string",
    cpus=0,
    disk="string",
    image="string",
    memory="string")

    const instanceResource = new multipass.resources.Instance("instanceResource", {
    name: "string",
    cloudinit: "string",
    cpus: 0,
    disk: "string",
    image: "string",
    memory: "string",
});

    type: multipass:resources:Instance
properties:
    cloudinit: string
    cpus: 0
    disk: string
    image: string
    memory: string
    name: string

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    Name string
    The unique name of the Multipass virtual machine instance.
    Cloudinit string
    Path to a cloud-init user-data file or inline cloud-init configuration.
    Cpus int
    The number of CPUs to allocate to the instance. Defaults to 1.
    Disk string
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    Image string
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    Memory string
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    Name string
    The unique name of the Multipass virtual machine instance.
    Cloudinit string
    Path to a cloud-init user-data file or inline cloud-init configuration.
    Cpus int
    The number of CPUs to allocate to the instance. Defaults to 1.
    Disk string
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    Image string
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    Memory string
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    name string
    The unique name of the Multipass virtual machine instance.
    cloudinit string
    Path to a cloud-init user-data file or inline cloud-init configuration.
    cpus number
    The number of CPUs to allocate to the instance. Defaults to 1.
    disk string
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    image string
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    memory string
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    name String
    The unique name of the Multipass virtual machine instance.
    cloudinit String
    Path to a cloud-init user-data file or inline cloud-init configuration.
    cpus Integer
    The number of CPUs to allocate to the instance. Defaults to 1.
    disk String
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    image String
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    memory String
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    name string
    The unique name of the Multipass virtual machine instance.
    cloudinit string
    Path to a cloud-init user-data file or inline cloud-init configuration.
    cpus number
    The number of CPUs to allocate to the instance. Defaults to 1.
    disk string
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    image string
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    memory string
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    name str
    The unique name of the Multipass virtual machine instance.
    cloudinit str
    Path to a cloud-init user-data file or inline cloud-init configuration.
    cpus int
    The number of CPUs to allocate to the instance. Defaults to 1.
    disk str
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    image str
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    memory str
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.
    name String
    The unique name of the Multipass virtual machine instance.
    cloudinit String
    Path to a cloud-init user-data file or inline cloud-init configuration.
    cpus Number
    The number of CPUs to allocate to the instance. Defaults to 1.
    disk String
    The disk size to allocate (e.g., '5G', '10G'). Defaults to '5G'.
    image String
    The OS image to launch (e.g., '24.04', 'daily:24.04'). Defaults to '24.04'.
    memory String
    The amount of RAM to allocate (e.g., '1G', '2048M'). Defaults to '1G'.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    AllIpv4 List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageHash string
    ImageRelease string
    Ipv4 string
    State string
    AllIpv4 []string
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageHash string
    ImageRelease string
    Ipv4 string
    State string
    all_ipv4 list(string)
    id string
    The provider-assigned unique ID for this managed resource.
    image_hash string
    image_release string
    ipv4 string
    state string
    allIpv4 List<String>
    id String
    The provider-assigned unique ID for this managed resource.
    imageHash String
    imageRelease String
    ipv4 String
    state String
    allIpv4 string[]
    id string
    The provider-assigned unique ID for this managed resource.
    imageHash string
    imageRelease string
    ipv4 string
    state string
    all_ipv4 Sequence[str]
    id str
    The provider-assigned unique ID for this managed resource.
    image_hash str
    image_release str
    ipv4 str
    state str
    allIpv4 List<String>
    id String
    The provider-assigned unique ID for this managed resource.
    imageHash String
    imageRelease String
    ipv4 String
    state String

    Package Details

    Repository
    multipass incsteps/pulumi-provider-multipass
    License
    Apache-2.0
    Viewing docs for Multipass v0.3.2
    published on Tuesday, Sep 15, 2026 by incsteps
    Schema (JSON)
    incsteps/pulumi-provider-multipass

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial