Docs Packages
  1. Packages
  2. Linode
  3. API Docs
  4. Volume
Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi
pulumi/pulumi-linode

linode.Volume

Explore with Pulumi AI

linode logo
Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi
pulumi/pulumi-linode

    Provides a Linode Volume resource. This can be used to create, modify, and delete Linodes Block Storage Volumes. Block Storage Volumes are removable storage disks that persist outside the life-cycle of Linode Instances. These volumes can be attached to and detached from Linode instances throughout a region.

    For more information, see How to Use Block Storage with Your Linode and the Linode APIv4 docs.

    Example Usage

    The following example shows how one might use this resource to configure a Block Storage Volume attached to a Linode Instance.

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

const foobaz = new linode.Instance("foobaz", {
    rootPass: "3X4mp13",
    type: "g6-nanode-1",
    region: "us-west",
    tags: ["foobaz"],
});
const foobar = new linode.Volume("foobar", {
    label: "foo-volume",
    region: foobaz.region,
    linodeId: foobaz.id,
});

    import pulumi
import pulumi_linode as linode

foobaz = linode.Instance("foobaz",
    root_pass="3X4mp13",
    type="g6-nanode-1",
    region="us-west",
    tags=["foobaz"])
foobar = linode.Volume("foobar",
    label="foo-volume",
    region=foobaz.region,
    linode_id=foobaz.id)

    package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foobaz, err := linode.NewInstance(ctx, "foobaz", &linode.InstanceArgs{
			RootPass: pulumi.String("3X4mp13"),
			Type:     pulumi.String("g6-nanode-1"),
			Region:   pulumi.String("us-west"),
			Tags: pulumi.StringArray{
				pulumi.String("foobaz"),
			},
		})
		if err != nil {
			return err
		}
		_, err = linode.NewVolume(ctx, "foobar", &linode.VolumeArgs{
			Label:    pulumi.String("foo-volume"),
			Region:   foobaz.Region,
			LinodeId: foobaz.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foobaz = new Linode.Instance("foobaz", new()
    {
        RootPass = "3X4mp13",
        Type = "g6-nanode-1",
        Region = "us-west",
        Tags = new[]
        {
            "foobaz",
        },
    });

    var foobar = new Linode.Volume("foobar", new()
    {
        Label = "foo-volume",
        Region = foobaz.Region,
        LinodeId = foobaz.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.Instance;
import com.pulumi.linode.InstanceArgs;
import com.pulumi.linode.Volume;
import com.pulumi.linode.VolumeArgs;
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 foobaz = new Instance("foobaz", InstanceArgs.builder()        
            .rootPass("3X4mp13")
            .type("g6-nanode-1")
            .region("us-west")
            .tags("foobaz")
            .build());

        var foobar = new Volume("foobar", VolumeArgs.builder()        
            .label("foo-volume")
            .region(foobaz.region())
            .linodeId(foobaz.id())
            .build());

    }
}

    resources:
  foobaz:
    type: linode:Instance
    properties:
      rootPass: 3X4mp13
      type: g6-nanode-1
      region: us-west
      tags:
        - foobaz
  foobar:
    type: linode:Volume
    properties:
      label: foo-volume
      region: ${foobaz.region}
      linodeId: ${foobaz.id}

    Volumes can also be attached using the Linode Instance config device map.

    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,
           label: Optional[str] = None,
           linode_id: Optional[int] = None,
           region: Optional[str] = None,
           size: Optional[int] = None,
           source_volume_id: Optional[int] = None,
           tags: Optional[Sequence[str]] = None,
           timeouts: Optional[VolumeTimeoutsArgs] = 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: linode: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.

    Example

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

    var volumeResource = new Linode.Volume("volumeResource", new()
{
    Label = "string",
    LinodeId = 0,
    Region = "string",
    Size = 0,
    SourceVolumeId = 0,
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Linode.Inputs.VolumeTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := linode.NewVolume(ctx, "volumeResource", &linode.VolumeArgs{
	Label:          pulumi.String("string"),
	LinodeId:       pulumi.Int(0),
	Region:         pulumi.String("string"),
	Size:           pulumi.Int(0),
	SourceVolumeId: pulumi.Int(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &linode.VolumeTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()        
    .label("string")
    .linodeId(0)
    .region("string")
    .size(0)
    .sourceVolumeId(0)
    .tags("string")
    .timeouts(VolumeTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    volume_resource = linode.Volume("volumeResource",
    label="string",
    linode_id=0,
    region="string",
    size=0,
    source_volume_id=0,
    tags=["string"],
    timeouts=linode.VolumeTimeoutsArgs(
        create="string",
        delete="string",
        update="string",
    ))

    const volumeResource = new linode.Volume("volumeResource", {
    label: "string",
    linodeId: 0,
    region: "string",
    size: 0,
    sourceVolumeId: 0,
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: linode:Volume
properties:
    label: string
    linodeId: 0
    region: string
    size: 0
    sourceVolumeId: 0
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: 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

    The Volume resource accepts the following input properties:

    Label string
    The label of the Linode Volume
    LinodeId int
    The ID of a Linode Instance where the Volume should be attached.
    Region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    Size int
    Size of the Volume in GB.
    SourceVolumeId int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    Tags List<string>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Timeouts VolumeTimeouts
    Label string
    The label of the Linode Volume
    LinodeId int
    The ID of a Linode Instance where the Volume should be attached.
    Region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    Size int
    Size of the Volume in GB.
    SourceVolumeId int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    Tags []string
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Timeouts VolumeTimeoutsArgs
    label String
    The label of the Linode Volume
    linodeId Integer
    The ID of a Linode Instance where the Volume should be attached.
    region String
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size Integer
    Size of the Volume in GB.
    sourceVolumeId Integer
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    tags List<String>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeouts
    label string
    The label of the Linode Volume
    linodeId number
    The ID of a Linode Instance where the Volume should be attached.
    region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size number
    Size of the Volume in GB.
    sourceVolumeId number
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    tags string[]
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeouts
    label str
    The label of the Linode Volume
    linode_id int
    The ID of a Linode Instance where the Volume should be attached.
    region str
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size int
    Size of the Volume in GB.
    source_volume_id int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    tags Sequence[str]
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeoutsArgs
    label String
    The label of the Linode Volume
    linodeId Number
    The ID of a Linode Instance where the Volume should be attached.
    region String
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size Number
    Size of the Volume in GB.
    sourceVolumeId Number
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    tags List<String>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts Property Map

    Outputs

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

    FilesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    FilesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    filesystemPath String
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    filesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    filesystem_path str
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    filesystemPath String
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Linode Volume. (creating, active, resizing, contact_support)

    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,
        filesystem_path: Optional[str] = None,
        label: Optional[str] = None,
        linode_id: Optional[int] = None,
        region: Optional[str] = None,
        size: Optional[int] = None,
        source_volume_id: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[VolumeTimeoutsArgs] = 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)
    Resource lookup is not supported in YAML
    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:
    FilesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    Label string
    The label of the Linode Volume
    LinodeId int
    The ID of a Linode Instance where the Volume should be attached.
    Region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    Size int
    Size of the Volume in GB.
    SourceVolumeId int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    Status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    Tags List<string>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Timeouts VolumeTimeouts
    FilesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    Label string
    The label of the Linode Volume
    LinodeId int
    The ID of a Linode Instance where the Volume should be attached.
    Region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    Size int
    Size of the Volume in GB.
    SourceVolumeId int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    Status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    Tags []string
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    Timeouts VolumeTimeoutsArgs
    filesystemPath String
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    label String
    The label of the Linode Volume
    linodeId Integer
    The ID of a Linode Instance where the Volume should be attached.
    region String
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size Integer
    Size of the Volume in GB.
    sourceVolumeId Integer
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    status String
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    tags List<String>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeouts
    filesystemPath string
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    label string
    The label of the Linode Volume
    linodeId number
    The ID of a Linode Instance where the Volume should be attached.
    region string
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size number
    Size of the Volume in GB.
    sourceVolumeId number
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    status string
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    tags string[]
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeouts
    filesystem_path str
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    label str
    The label of the Linode Volume
    linode_id int
    The ID of a Linode Instance where the Volume should be attached.
    region str
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size int
    Size of the Volume in GB.
    source_volume_id int
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    status str
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    tags Sequence[str]
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts VolumeTimeoutsArgs
    filesystemPath String
    The full filesystem path for the Volume based on the Volume's label. The path is "/dev/disk/by-id/scsi-0Linode_Volume_" + the Volume label
    label String
    The label of the Linode Volume
    linodeId Number
    The ID of a Linode Instance where the Volume should be attached.
    region String
    The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. See all regions here. This field is optional for cloned volumes. Changing region forces the creation of a new Linode Volume..

    size Number
    Size of the Volume in GB.
    sourceVolumeId Number
    The ID of a Linode Volume to clone. NOTE: Cloned volumes must be in the same region as the source volume.
    status String
    The status of the Linode Volume. (creating, active, resizing, contact_support)
    tags List<String>
    A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
    timeouts Property Map

    Supporting Types

    VolumeTimeouts, VolumeTimeoutsArgs

    Create string
    Used when creating the volume (until the volume is reaches the initial active state)
    Delete string
    Used when deleting the volume
    Update string
    Used when updating the volume when necessary during update - e.g. when resizing the volume
    Create string
    Used when creating the volume (until the volume is reaches the initial active state)
    Delete string
    Used when deleting the volume
    Update string
    Used when updating the volume when necessary during update - e.g. when resizing the volume
    create String
    Used when creating the volume (until the volume is reaches the initial active state)
    delete String
    Used when deleting the volume
    update String
    Used when updating the volume when necessary during update - e.g. when resizing the volume
    create string
    Used when creating the volume (until the volume is reaches the initial active state)
    delete string
    Used when deleting the volume
    update string
    Used when updating the volume when necessary during update - e.g. when resizing the volume
    create str
    Used when creating the volume (until the volume is reaches the initial active state)
    delete str
    Used when deleting the volume
    update str
    Used when updating the volume when necessary during update - e.g. when resizing the volume
    create String
    Used when creating the volume (until the volume is reaches the initial active state)
    delete String
    Used when deleting the volume
    update String
    Used when updating the volume when necessary during update - e.g. when resizing the volume

    Import

    Linodes Volumes can be imported using the Linode Volume id, e.g.

    $ pulumi import linode:index/volume:Volume myvolume 1234567

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.18.0 published on Wednesday, Apr 10, 2024 by Pulumi
    pulumi/pulumi-linode