Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Lxd Provider
  3. API Docs
  4. InstanceFile
lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
terraform-lxd/terraform-provider-lxd

lxd.InstanceFile

Explore with Pulumi AI

lxd logo
lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
terraform-lxd/terraform-provider-lxd

    # lxd.InstanceFile

    Manages a file in an LXD instance.

    This resource is useful for managing files on an existing LXD instance. If you need to preload files in an instance before the instance first starts, use the file block in the lxd.Instance resource.

    Example

    import * as pulumi from "@pulumi/pulumi";
import * as lxd from "@pulumi/lxd";

const instance = new lxd.Instance("instance", {
    image: "ubuntu",
    ephemeral: false,
});
const file1 = new lxd.InstanceFile("file1", {
    instance: instance.name,
    sourcePath: "/path/to/local/file",
    targetPath: "/foo/bar.txt",
    createDirectories: true,
});

    import pulumi
import pulumi_lxd as lxd

instance = lxd.Instance("instance",
    image="ubuntu",
    ephemeral=False)
file1 = lxd.InstanceFile("file1",
    instance=instance.name,
    source_path="/path/to/local/file",
    target_path="/foo/bar.txt",
    create_directories=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lxd/v2/lxd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := lxd.NewInstance(ctx, "instance", &lxd.InstanceArgs{
			Image:     pulumi.String("ubuntu"),
			Ephemeral: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = lxd.NewInstanceFile(ctx, "file1", &lxd.InstanceFileArgs{
			Instance:          instance.Name,
			SourcePath:        pulumi.String("/path/to/local/file"),
			TargetPath:        pulumi.String("/foo/bar.txt"),
			CreateDirectories: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Lxd = Pulumi.Lxd;

return await Deployment.RunAsync(() => 
{
    var instance = new Lxd.Instance("instance", new()
    {
        Image = "ubuntu",
        Ephemeral = false,
    });

    var file1 = new Lxd.InstanceFile("file1", new()
    {
        Instance = instance.Name,
        SourcePath = "/path/to/local/file",
        TargetPath = "/foo/bar.txt",
        CreateDirectories = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.lxd.Instance;
import com.pulumi.lxd.InstanceArgs;
import com.pulumi.lxd.InstanceFile;
import com.pulumi.lxd.InstanceFileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instance = new Instance("instance", InstanceArgs.builder()
            .image("ubuntu")
            .ephemeral(false)
            .build());

        var file1 = new InstanceFile("file1", InstanceFileArgs.builder()
            .instance(instance.name())
            .sourcePath("/path/to/local/file")
            .targetPath("/foo/bar.txt")
            .createDirectories(true)
            .build());

    }
}

    resources:
  instance:
    type: lxd:Instance
    properties:
      image: ubuntu
      ephemeral: false
  file1:
    type: lxd:InstanceFile
    properties:
      instance: ${instance.name}
      sourcePath: /path/to/local/file
      targetPath: /foo/bar.txt
      createDirectories: true

    Create InstanceFile Resource

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

    Constructor syntax

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

@overload
def InstanceFile(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance: Optional[str] = None,
                 target_path: Optional[str] = None,
                 append: Optional[bool] = None,
                 content: Optional[str] = None,
                 create_directories: Optional[bool] = None,
                 gid: Optional[float] = None,
                 mode: Optional[str] = None,
                 project: Optional[str] = None,
                 remote: Optional[str] = None,
                 source_path: Optional[str] = None,
                 uid: Optional[float] = None)
    func NewInstanceFile(ctx *Context, name string, args InstanceFileArgs, opts ...ResourceOption) (*InstanceFile, error)
    public InstanceFile(string name, InstanceFileArgs args, CustomResourceOptions? opts = null)
    public InstanceFile(String name, InstanceFileArgs args)
public InstanceFile(String name, InstanceFileArgs args, CustomResourceOptions options)

    type: lxd:InstanceFile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceFileArgs
    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 InstanceFileInitArgs
    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 InstanceFileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceFileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceFileArgs
    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 instanceFileResource = new Lxd.InstanceFile("instanceFileResource", new()
{
    Instance = "string",
    TargetPath = "string",
    Append = false,
    Content = "string",
    CreateDirectories = false,
    Gid = 0,
    Mode = "string",
    Project = "string",
    Remote = "string",
    SourcePath = "string",
    Uid = 0,
});

    example, err := lxd.NewInstanceFile(ctx, "instanceFileResource", &lxd.InstanceFileArgs{
Instance: pulumi.String("string"),
TargetPath: pulumi.String("string"),
Append: pulumi.Bool(false),
Content: pulumi.String("string"),
CreateDirectories: pulumi.Bool(false),
Gid: pulumi.Float64(0),
Mode: pulumi.String("string"),
Project: pulumi.String("string"),
Remote: pulumi.String("string"),
SourcePath: pulumi.String("string"),
Uid: pulumi.Float64(0),
})

    var instanceFileResource = new InstanceFile("instanceFileResource", InstanceFileArgs.builder()
    .instance("string")
    .targetPath("string")
    .append(false)
    .content("string")
    .createDirectories(false)
    .gid(0)
    .mode("string")
    .project("string")
    .remote("string")
    .sourcePath("string")
    .uid(0)
    .build());

    instance_file_resource = lxd.InstanceFile("instanceFileResource",
    instance="string",
    target_path="string",
    append=False,
    content="string",
    create_directories=False,
    gid=0,
    mode="string",
    project="string",
    remote="string",
    source_path="string",
    uid=0)

    const instanceFileResource = new lxd.InstanceFile("instanceFileResource", {
    instance: "string",
    targetPath: "string",
    append: false,
    content: "string",
    createDirectories: false,
    gid: 0,
    mode: "string",
    project: "string",
    remote: "string",
    sourcePath: "string",
    uid: 0,
});

    type: lxd:InstanceFile
properties:
    append: false
    content: string
    createDirectories: false
    gid: 0
    instance: string
    mode: string
    project: string
    remote: string
    sourcePath: string
    targetPath: string
    uid: 0

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

    Instance string
    Required - Name of the instance.
    TargetPath string
    Required - The absolute path of the file on the instance, including the filename.
    Append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    Content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    CreateDirectories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    Gid double
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    Mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    Project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    SourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    Uid double
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    Instance string
    Required - Name of the instance.
    TargetPath string
    Required - The absolute path of the file on the instance, including the filename.
    Append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    Content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    CreateDirectories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    Gid float64
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    Mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    Project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    SourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    Uid float64
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    instance String
    Required - Name of the instance.
    targetPath String
    Required - The absolute path of the file on the instance, including the filename.
    append Boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content String
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories Boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid Double
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    mode String
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project String
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    sourcePath String
    Required unless content is used - The source path to a file to copy to the instance.
    uid Double
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    instance string
    Required - Name of the instance.
    targetPath string
    Required - The absolute path of the file on the instance, including the filename.
    append boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid number
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    sourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    uid number
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    instance str
    Required - Name of the instance.
    target_path str
    Required - The absolute path of the file on the instance, including the filename.
    append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content str
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    create_directories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid float
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    mode str
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project str
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    source_path str
    Required unless content is used - The source path to a file to copy to the instance.
    uid float
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    instance String
    Required - Name of the instance.
    targetPath String
    Required - The absolute path of the file on the instance, including the filename.
    append Boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content String
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories Boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid Number
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    mode String
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project String
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    sourcePath String
    Required unless content is used - The source path to a file to copy to the instance.
    uid Number
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.

    Outputs

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

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

    Look up Existing InstanceFile Resource

    Get an existing InstanceFile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceFileState, opts?: CustomResourceOptions): InstanceFile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append: Optional[bool] = None,
        content: Optional[str] = None,
        create_directories: Optional[bool] = None,
        gid: Optional[float] = None,
        instance: Optional[str] = None,
        mode: Optional[str] = None,
        project: Optional[str] = None,
        remote: Optional[str] = None,
        resource_id: Optional[str] = None,
        source_path: Optional[str] = None,
        target_path: Optional[str] = None,
        uid: Optional[float] = None) -> InstanceFile
    func GetInstanceFile(ctx *Context, name string, id IDInput, state *InstanceFileState, opts ...ResourceOption) (*InstanceFile, error)
    public static InstanceFile Get(string name, Input<string> id, InstanceFileState? state, CustomResourceOptions? opts = null)
    public static InstanceFile get(String name, Output<String> id, InstanceFileState state, CustomResourceOptions options)
    resources:  _:    type: lxd:InstanceFile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    Content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    CreateDirectories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    Gid double
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    Instance string
    Required - Name of the instance.
    Mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    Project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    ResourceId string
    SourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    TargetPath string
    Required - The absolute path of the file on the instance, including the filename.
    Uid double
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    Append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    Content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    CreateDirectories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    Gid float64
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    Instance string
    Required - Name of the instance.
    Mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    Project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    ResourceId string
    SourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    TargetPath string
    Required - The absolute path of the file on the instance, including the filename.
    Uid float64
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    append Boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content String
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories Boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid Double
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    instance String
    Required - Name of the instance.
    mode String
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project String
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    resourceId String
    sourcePath String
    Required unless content is used - The source path to a file to copy to the instance.
    targetPath String
    Required - The absolute path of the file on the instance, including the filename.
    uid Double
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    append boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content string
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid number
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    instance string
    Required - Name of the instance.
    mode string
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project string
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    resourceId string
    sourcePath string
    Required unless content is used - The source path to a file to copy to the instance.
    targetPath string
    Required - The absolute path of the file on the instance, including the filename.
    uid number
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    append bool
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content str
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    create_directories bool
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid float
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    instance str
    Required - Name of the instance.
    mode str
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project str
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    resource_id str
    source_path str
    Required unless content is used - The source path to a file to copy to the instance.
    target_path str
    Required - The absolute path of the file on the instance, including the filename.
    uid float
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.
    append Boolean
    Optional - Whether to append the content to the target file. Defaults to false, where target file will be overwritten.
    content String
    Required unless source_path is used - The contents of the file. Use the file() function to read in the content of a file from disk.
    createDirectories Boolean
    Optional - Whether to create the directories leading to the target if they do not exist.
    gid Number
    Optional - The GID of the file. Must be an unquoted integer. Defaults to 0.
    instance String
    Required - Name of the instance.
    mode String
    Optional - The octal permissions of the file, must be quoted. Defaults to 0755.
    project String
    Optional - Name of the project where the instance to which this file will be appended exist.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    resourceId String
    sourcePath String
    Required unless content is used - The source path to a file to copy to the instance.
    targetPath String
    Required - The absolute path of the file on the instance, including the filename.
    uid Number
    Optional - The UID of the file. Must be an unquoted integer. Defaults to 0.

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    lxd logo
    lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd
    terraform-lxd/terraform-provider-lxd