lxd 2.5.0, Mar 13 25

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

lxd.Volume

Explore with Pulumi AI

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

Create Volume Resource

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

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);

@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           pool: Optional[str] = None,
           config: Optional[Mapping[str, str]] = None,
           content_type: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = None,
           remote: Optional[str] = None,
           target: Optional[str] = None,
           type: Optional[str] = None)

func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)

public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)

public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

type: lxd:Volume
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 VolumeArgs: 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 VolumeArgs: 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 VolumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VolumeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VolumeArgs: 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 volumeResource = new Lxd.Volume("volumeResource", new()
{
    Pool = "string",
    Config = 
    {
        { "string", "string" },
    },
    ContentType = "string",
    Description = "string",
    Name = "string",
    Project = "string",
    Remote = "string",
    Target = "string",
    Type = "string",
});

example, err := lxd.NewVolume(ctx, "volumeResource", &lxd.VolumeArgs{
Pool: pulumi.String("string"),
Config: pulumi.StringMap{
"string": pulumi.String("string"),
},
ContentType: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
Remote: pulumi.String("string"),
Target: pulumi.String("string"),
Type: pulumi.String("string"),
})

var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .pool("string")
    .config(Map.of("string", "string"))
    .contentType("string")
    .description("string")
    .name("string")
    .project("string")
    .remote("string")
    .target("string")
    .type("string")
    .build());

volume_resource = lxd.Volume("volumeResource",
    pool="string",
    config={
        "string": "string",
    },
    content_type="string",
    description="string",
    name="string",
    project="string",
    remote="string",
    target="string",
    type="string")

const volumeResource = new lxd.Volume("volumeResource", {
    pool: "string",
    config: {
        string: "string",
    },
    contentType: "string",
    description: "string",
    name: "string",
    project: "string",
    remote: "string",
    target: "string",
    type: "string",
});

type: lxd:Volume
properties:
    config:
        string: string
    contentType: string
    description: string
    name: string
    pool: string
    project: string
    remote: string
    target: string
    type: string

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

Pool string: Required - Name of storage pool to host the volume.
Config Dictionary<string, string>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
ContentType string: Optional - Volume content type (filesystem or block)
Description string: Optional - Description of the volume.
Name string: Required - Name of the storage volume.
Project string: Optional - Name of the project where the volume will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Target string: Optional - Specify a target node in a cluster.
Type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

Pool string: Required - Name of storage pool to host the volume.
Config map[string]string: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
ContentType string: Optional - Volume content type (filesystem or block)
Description string: Optional - Description of the volume.
Name string: Required - Name of the storage volume.
Project string: Optional - Name of the project where the volume will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Target string: Optional - Specify a target node in a cluster.
Type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

pool String: Required - Name of storage pool to host the volume.
config Map<String,String>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType String: Optional - Volume content type (filesystem or block)
description String: Optional - Description of the volume.
name String: Required - Name of the storage volume.
project String: Optional - Name of the project where the volume will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target String: Optional - Specify a target node in a cluster.
type String: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

pool string: Required - Name of storage pool to host the volume.
config {[key: string]: string}: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType string: Optional - Volume content type (filesystem or block)
description string: Optional - Description of the volume.
name string: Required - Name of the storage volume.
project string: Optional - Name of the project where the volume will be stored.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target string: Optional - Specify a target node in a cluster.
type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

pool str: Required - Name of storage pool to host the volume.
config Mapping[str, str]: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
content_type str: Optional - Volume content type (filesystem or block)
description str: Optional - Description of the volume.
name str: Required - Name of the storage volume.
project str: Optional - Name of the project where the volume will be stored.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target str: Optional - Specify a target node in a cluster.
type str: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

pool String: Required - Name of storage pool to host the volume.
config Map<String>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType String: Optional - Volume content type (filesystem or block)
description String: Optional - Description of the volume.
name String: Required - Name of the storage volume.
project String: Optional - Name of the project where the volume will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target String: Optional - Specify a target node in a cluster.
type String: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.

Id string: The provider-assigned unique ID for this managed resource.
Location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.

id String: The provider-assigned unique ID for this managed resource.
location String: Name of the node where volume was created. It could be useful with LXD in cluster mode.

id string: The provider-assigned unique ID for this managed resource.
location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.

id str: The provider-assigned unique ID for this managed resource.
location str: Name of the node where volume was created. It could be useful with LXD in cluster mode.

id String: The provider-assigned unique ID for this managed resource.
location String: Name of the node where volume was created. It could be useful with LXD in cluster mode.

Look up Existing Volume Resource

Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        content_type: Optional[str] = None,
        description: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        pool: Optional[str] = None,
        project: Optional[str] = None,
        remote: Optional[str] = None,
        target: Optional[str] = None,
        type: Optional[str] = None) -> Volume

func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)

public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)

public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)

resources:  _:    type: lxd:Volume    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:

Config Dictionary<string, string>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
ContentType string: Optional - Volume content type (filesystem or block)
Description string: Optional - Description of the volume.
Location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.
Name string: Required - Name of the storage volume.
Pool string: Required - Name of storage pool to host the volume.
Project string: Optional - Name of the project where the volume will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Target string: Optional - Specify a target node in a cluster.
Type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

Config map[string]string: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
ContentType string: Optional - Volume content type (filesystem or block)
Description string: Optional - Description of the volume.
Location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.
Name string: Required - Name of the storage volume.
Pool string: Required - Name of storage pool to host the volume.
Project string: Optional - Name of the project where the volume will be stored.
Remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Target string: Optional - Specify a target node in a cluster.
Type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

config Map<String,String>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType String: Optional - Volume content type (filesystem or block)
description String: Optional - Description of the volume.
location String: Name of the node where volume was created. It could be useful with LXD in cluster mode.
name String: Required - Name of the storage volume.
pool String: Required - Name of storage pool to host the volume.
project String: Optional - Name of the project where the volume will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target String: Optional - Specify a target node in a cluster.
type String: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

config {[key: string]: string}: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType string: Optional - Volume content type (filesystem or block)
description string: Optional - Description of the volume.
location string: Name of the node where volume was created. It could be useful with LXD in cluster mode.
name string: Required - Name of the storage volume.
pool string: Required - Name of storage pool to host the volume.
project string: Optional - Name of the project where the volume will be stored.
remote string: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target string: Optional - Specify a target node in a cluster.
type string: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

config Mapping[str, str]: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
content_type str: Optional - Volume content type (filesystem or block)
description str: Optional - Description of the volume.
location str: Name of the node where volume was created. It could be useful with LXD in cluster mode.
name str: Required - Name of the storage volume.
pool str: Required - Name of storage pool to host the volume.
project str: Optional - Name of the project where the volume will be stored.
remote str: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target str: Optional - Specify a target node in a cluster.
type str: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

config Map<String>: Optional - Map of key/value pairs of volume config settings. Config settings vary depending on the Storage Pool used.
contentType String: Optional - Volume content type (filesystem or block)
description String: Optional - Description of the volume.
location String: Name of the node where volume was created. It could be useful with LXD in cluster mode.
name String: Required - Name of the storage volume.
pool String: Required - Name of storage pool to host the volume.
project String: Optional - Name of the project where the volume will be stored.
remote String: Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
target String: Optional - Specify a target node in a cluster.
type String: Optional - The "type" of volume. The default value is custom, which is the type to use for storage volumes attached to instances.

Package Details

Repository: lxd terraform-lxd/terraform-provider-lxd
License
Notes: This Pulumi package is based on the lxd Terraform Provider.

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

terraform-lxd/terraform-provider-lxd

lxd.Volume

On this page

On this page

Create Volume Resource

Constructor syntax

Parameters

Constructor example

Volume Resource Properties

Inputs

Outputs

Look up Existing Volume Resource

Package Details

On this page

On this page