1. Docs
  2. Reference
  3. API
  4. Hetzner Cloud
  5. VolumeAttachment

VolumeAttachment

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

using Pulumi;
using HCloud = Pulumi.HCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var node1 = new HCloud.Server("node1", new HCloud.ServerArgs
        {
            Image = "debian-9",
            ServerType = "cx11",
            Datacenter = "nbg1-dc3",
        });
        var master = new HCloud.Volume("master", new HCloud.VolumeArgs
        {
            Location = "nbg1",
            Size = 10,
        });
        var main = new HCloud.VolumeAttachment("main", new HCloud.VolumeAttachmentArgs
        {
            VolumeId = master.Id,
            ServerId = 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{
			Image:      pulumi.String("debian-9"),
			ServerType: pulumi.String("cx11"),
			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
	})
}

import pulumi
import pulumi_hcloud as hcloud

node1 = hcloud.Server("node1",
    image="debian-9",
    server_type="cx11",
    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)

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

const node1 = new hcloud.Server("node1", {
    image: "debian-9",
    serverType: "cx11",
    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,
});

Create a VolumeAttachment Resource

new VolumeAttachment(name: string, args: VolumeAttachmentArgs, opts?: CustomResourceOptions);
@overload
def VolumeAttachment(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     automount: Optional[bool] = None,
                     server_id: Optional[int] = None,
                     volume_id: Optional[int] = None)
@overload
def VolumeAttachment(resource_name: str,
                     args: VolumeAttachmentArgs,
                     opts: Optional[ResourceOptions] = None)
func NewVolumeAttachment(ctx *Context, name string, args VolumeAttachmentArgs, opts ...ResourceOption) (*VolumeAttachment, error)
public VolumeAttachment(string name, VolumeAttachmentArgs args, CustomResourceOptions? opts = null)
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.

VolumeAttachment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

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 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.

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 str
The provider-assigned unique ID for this managed resource.

Look up an 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)
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.

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 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.

Import

Volume Attachments can be imported using the volume_id

 $ pulumi import hcloud:index/volumeAttachment:VolumeAttachment myvolumeattachment <volume_id>

Package Details

Repository
https://github.com/pulumi/pulumi-hcloud
License
Apache-2.0
Notes
This Pulumi package is based on the hcloud Terraform Provider.
Register Now For PulumiUP