1. Registry
  2. Packages
  3. Multipass Provider
  4. API Docs
  5. resources
  6. Mount
Viewing docs for Multipass v0.3.2
published on Tuesday, Sep 15, 2026 by incsteps
Viewing docs for Multipass v0.3.2
published on Tuesday, Sep 15, 2026 by incsteps

    A host directory mount into a Multipass virtual machine instance.

    Create Mount Resource

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

    Constructor syntax

    new Mount(name: string, args: MountArgs, opts?: CustomResourceOptions);
    @overload
    def Mount(resource_name: str,
              args: MountArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Mount(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              instance_name: Optional[str] = None,
              source_path: Optional[str] = None,
              target_path: Optional[str] = None,
              mount_type: Optional[str] = None)
    func NewMount(ctx *Context, name string, args MountArgs, opts ...ResourceOption) (*Mount, error)
    public Mount(string name, MountArgs args, CustomResourceOptions? opts = null)
    public Mount(String name, MountArgs args)
    public Mount(String name, MountArgs args, CustomResourceOptions options)
    
    type: multipass:resources:Mount
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "multipass_resources_mount" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MountArgs
    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 MountArgs
    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 MountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MountArgs
    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 mountResource = new Multipass.Resources.Mount("mountResource", new()
    {
        InstanceName = "string",
        SourcePath = "string",
        TargetPath = "string",
        MountType = "string",
    });
    
    example, err := resources.NewMount(ctx, "mountResource", &resources.MountArgs{
    	InstanceName: pulumi.String("string"),
    	SourcePath:   pulumi.String("string"),
    	TargetPath:   pulumi.String("string"),
    	MountType:    pulumi.String("string"),
    })
    
    resource "multipass_resources_mount" "mountResource" {
      lifecycle {
        create_before_destroy = true
      }
      instance_name = "string"
      source_path   = "string"
      target_path   = "string"
      mount_type    = "string"
    }
    
    var mountResource = new Mount("mountResource", MountArgs.builder()
        .instanceName("string")
        .sourcePath("string")
        .targetPath("string")
        .mountType("string")
        .build());
    
    mount_resource = multipass.resources.Mount("mountResource",
        instance_name="string",
        source_path="string",
        target_path="string",
        mount_type="string")
    
    const mountResource = new multipass.resources.Mount("mountResource", {
        instanceName: "string",
        sourcePath: "string",
        targetPath: "string",
        mountType: "string",
    });
    
    type: multipass:resources:Mount
    properties:
        instanceName: string
        mountType: string
        sourcePath: string
        targetPath: string
    

    Mount 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 Mount resource accepts the following input properties:

    InstanceName string
    The name of the Multipass VM instance.
    SourcePath string
    The host directory path to mount into the VM.
    TargetPath string
    The target directory path inside the VM instance.
    MountType string
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    InstanceName string
    The name of the Multipass VM instance.
    SourcePath string
    The host directory path to mount into the VM.
    TargetPath string
    The target directory path inside the VM instance.
    MountType string
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    instance_name string
    The name of the Multipass VM instance.
    source_path string
    The host directory path to mount into the VM.
    target_path string
    The target directory path inside the VM instance.
    mount_type string
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    instanceName String
    The name of the Multipass VM instance.
    sourcePath String
    The host directory path to mount into the VM.
    targetPath String
    The target directory path inside the VM instance.
    mountType String
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    instanceName string
    The name of the Multipass VM instance.
    sourcePath string
    The host directory path to mount into the VM.
    targetPath string
    The target directory path inside the VM instance.
    mountType string
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    instance_name str
    The name of the Multipass VM instance.
    source_path str
    The host directory path to mount into the VM.
    target_path str
    The target directory path inside the VM instance.
    mount_type str
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.
    instanceName String
    The name of the Multipass VM instance.
    sourcePath String
    The host directory path to mount into the VM.
    targetPath String
    The target directory path inside the VM instance.
    mountType String
    The mount strategy to use (e.g., 'native' or 'classic'). Defaults to 'native'.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial