Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hcloud Provider
  3. API Docs
  4. VolumeAttachment
Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi
pulumi/pulumi-hcloud

hcloud.VolumeAttachment

Explore with Pulumi AI

hcloud logo
Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi
pulumi/pulumi-hcloud

    Provides a Hetzner Cloud Volume attachment to attach a Volume to a Hetzner Cloud Server. Deleting a Volume Attachment will detach the Volume from the Server.

    Example Usage

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

const node1 = new hcloud.Server("node1", {
    name: "node1",
    image: "debian-11",
    serverType: "cx22",
    datacenter: "nbg1-dc3",
});
const master = new hcloud.Volume("master", {
    location: "nbg1",
    size: 10,
});
const main = new hcloud.VolumeAttachment("main", {
    volumeId: master.id,
    serverId: node1.id,
    automount: true,
});

    import pulumi
import pulumi_hcloud as hcloud

node1 = hcloud.Server("node1",
    name="node1",
    image="debian-11",
    server_type="cx22",
    datacenter="nbg1-dc3")
master = hcloud.Volume("master",
    location="nbg1",
    size=10)
main = hcloud.VolumeAttachment("main",
    volume_id=master.id,
    server_id=node1.id,
    automount=True)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		node1, err := hcloud.NewServer(ctx, "node1", &hcloud.ServerArgs{
			Name:       pulumi.String("node1"),
			Image:      pulumi.String("debian-11"),
			ServerType: pulumi.String("cx22"),
			Datacenter: pulumi.String("nbg1-dc3"),
		})
		if err != nil {
			return err
		}
		master, err := hcloud.NewVolume(ctx, "master", &hcloud.VolumeArgs{
			Location: pulumi.String("nbg1"),
			Size:     pulumi.Int(10),
		})
		if err != nil {
			return err
		}
		_, err = hcloud.NewVolumeAttachment(ctx, "main", &hcloud.VolumeAttachmentArgs{
			VolumeId:  master.ID(),
			ServerId:  node1.ID(),
			Automount: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var node1 = new HCloud.Server("node1", new()
    {
        Name = "node1",
        Image = "debian-11",
        ServerType = "cx22",
        Datacenter = "nbg1-dc3",
    });

    var master = new HCloud.Volume("master", new()
    {
        Location = "nbg1",
        Size = 10,
    });

    var main = new HCloud.VolumeAttachment("main", new()
    {
        VolumeId = master.Id,
        ServerId = node1.Id,
        Automount = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hcloud.Server;
import com.pulumi.hcloud.ServerArgs;
import com.pulumi.hcloud.Volume;
import com.pulumi.hcloud.VolumeArgs;
import com.pulumi.hcloud.VolumeAttachment;
import com.pulumi.hcloud.VolumeAttachmentArgs;
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 node1 = new Server("node1", ServerArgs.builder()
            .name("node1")
            .image("debian-11")
            .serverType("cx22")
            .datacenter("nbg1-dc3")
            .build());

        var master = new Volume("master", VolumeArgs.builder()
            .location("nbg1")
            .size(10)
            .build());

        var main = new VolumeAttachment("main", VolumeAttachmentArgs.builder()
            .volumeId(master.id())
            .serverId(node1.id())
            .automount(true)
            .build());

    }
}

    resources:
  main:
    type: hcloud:VolumeAttachment
    properties:
      volumeId: ${master.id}
      serverId: ${node1.id}
      automount: true
  node1:
    type: hcloud:Server
    properties:
      name: node1
      image: debian-11
      serverType: cx22
      datacenter: nbg1-dc3
  master:
    type: hcloud:Volume
    properties:
      location: nbg1
      size: 10

    Create VolumeAttachment Resource

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

    Constructor syntax

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

@overload
def VolumeAttachment(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     server_id: Optional[int] = None,
                     volume_id: Optional[int] = None,
                     automount: Optional[bool] = None)
    func NewVolumeAttachment(ctx *Context, name string, args VolumeAttachmentArgs, opts ...ResourceOption) (*VolumeAttachment, error)
    public VolumeAttachment(string name, VolumeAttachmentArgs args, CustomResourceOptions? opts = null)
    public VolumeAttachment(String name, VolumeAttachmentArgs args)
public VolumeAttachment(String name, VolumeAttachmentArgs args, CustomResourceOptions options)

    type: hcloud:VolumeAttachment
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 VolumeAttachmentArgs
    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 VolumeAttachmentArgs
    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 VolumeAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeAttachmentArgs
    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 volumeAttachmentResource = new HCloud.VolumeAttachment("volumeAttachmentResource", new()
{
    ServerId = 0,
    VolumeId = 0,
    Automount = false,
});

    example, err := hcloud.NewVolumeAttachment(ctx, "volumeAttachmentResource", &hcloud.VolumeAttachmentArgs{
	ServerId:  pulumi.Int(0),
	VolumeId:  pulumi.Int(0),
	Automount: pulumi.Bool(false),
})

    var volumeAttachmentResource = new VolumeAttachment("volumeAttachmentResource", VolumeAttachmentArgs.builder()
    .serverId(0)
    .volumeId(0)
    .automount(false)
    .build());

    volume_attachment_resource = hcloud.VolumeAttachment("volumeAttachmentResource",
    server_id=0,
    volume_id=0,
    automount=False)

    const volumeAttachmentResource = new hcloud.VolumeAttachment("volumeAttachmentResource", {
    serverId: 0,
    volumeId: 0,
    automount: false,
});

    type: hcloud:VolumeAttachment
properties:
    automount: false
    serverId: 0
    volumeId: 0

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

    ServerId int
    Server to attach the Volume to.
    VolumeId int
    ID of the Volume.
    Automount bool
    Automount the volume upon attaching it.
    ServerId int
    Server to attach the Volume to.
    VolumeId int
    ID of the Volume.
    Automount bool
    Automount the volume upon attaching it.
    serverId Integer
    Server to attach the Volume to.
    volumeId Integer
    ID of the Volume.
    automount Boolean
    Automount the volume upon attaching it.
    serverId number
    Server to attach the Volume to.
    volumeId number
    ID of the Volume.
    automount boolean
    Automount the volume upon attaching it.
    server_id int
    Server to attach the Volume to.
    volume_id int
    ID of the Volume.
    automount bool
    Automount the volume upon attaching it.
    serverId Number
    Server to attach the Volume to.
    volumeId Number
    ID of the Volume.
    automount Boolean
    Automount the volume upon attaching it.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VolumeAttachment 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VolumeAttachment Resource

    Get an existing VolumeAttachment 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?: VolumeAttachmentState, opts?: CustomResourceOptions): VolumeAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automount: Optional[bool] = None,
        server_id: Optional[int] = None,
        volume_id: Optional[int] = None) -> VolumeAttachment
    func GetVolumeAttachment(ctx *Context, name string, id IDInput, state *VolumeAttachmentState, opts ...ResourceOption) (*VolumeAttachment, error)
    public static VolumeAttachment Get(string name, Input<string> id, VolumeAttachmentState? state, CustomResourceOptions? opts = null)
    public static VolumeAttachment get(String name, Output<String> id, VolumeAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: hcloud:VolumeAttachment    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:
    Automount bool
    Automount the volume upon attaching it.
    ServerId int
    Server to attach the Volume to.
    VolumeId int
    ID of the Volume.
    Automount bool
    Automount the volume upon attaching it.
    ServerId int
    Server to attach the Volume to.
    VolumeId int
    ID of the Volume.
    automount Boolean
    Automount the volume upon attaching it.
    serverId Integer
    Server to attach the Volume to.
    volumeId Integer
    ID of the Volume.
    automount boolean
    Automount the volume upon attaching it.
    serverId number
    Server to attach the Volume to.
    volumeId number
    ID of the Volume.
    automount bool
    Automount the volume upon attaching it.
    server_id int
    Server to attach the Volume to.
    volume_id int
    ID of the Volume.
    automount Boolean
    Automount the volume upon attaching it.
    serverId Number
    Server to attach the Volume to.
    volumeId Number
    ID of the Volume.

    Import

    Volume Attachments can be imported using the volume_id:

    $ pulumi import hcloud:index/volumeAttachment:VolumeAttachment example "$VOLUME_ID"

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

    Package Details

    Repository
    Hetzner Cloud pulumi/pulumi-hcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcloud Terraform Provider.
    hcloud logo
    Hetzner Cloud v1.22.0 published on Wednesday, Feb 26, 2025 by Pulumi
    pulumi/pulumi-hcloud