Attached Disk
Persistent disks can be attached to a compute instance using the attached_disk
section within the compute instance configuration. However there may be situations where managing the attached disks via the compute instance config isn't preferable or possible, such as attaching dynamic numbers of disks using the count
variable. To get more information about attaching disks, see:
How-to Guides
Adding a persistent disk Note: When using
gcp.compute.AttachedDisk
you must uselifecycle.ignore_changes = ["attached_disk"]
on thegcp.compute.Instance
resource that has the disks attached. Otherwise the two resources will fight for control of the attached disk block.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const defaultInstance = new gcp.compute.Instance("default", {
name: "attached-disk-instance",
machineType: "e2-medium",
zone: "us-west1-a",
bootDisk: {
initializeParams: {
image: "debian-cloud/debian-11",
},
},
networkInterfaces: [{
network: "default",
}],
});
const _default = new gcp.compute.AttachedDisk("default", {
disk: defaultGoogleComputeDisk.id,
instance: defaultInstance.id,
});
import pulumi
import pulumi_gcp as gcp
default_instance = gcp.compute.Instance("default",
name="attached-disk-instance",
machine_type="e2-medium",
zone="us-west1-a",
boot_disk={
"initialize_params": {
"image": "debian-cloud/debian-11",
},
},
network_interfaces=[{
"network": "default",
}])
default = gcp.compute.AttachedDisk("default",
disk=default_google_compute_disk["id"],
instance=default_instance.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var defaultInstance = new Gcp.Compute.Instance("default", new()
{
Name = "attached-disk-instance",
MachineType = "e2-medium",
Zone = "us-west1-a",
BootDisk = new Gcp.Compute.Inputs.InstanceBootDiskArgs
{
InitializeParams = new Gcp.Compute.Inputs.InstanceBootDiskInitializeParamsArgs
{
Image = "debian-cloud/debian-11",
},
},
NetworkInterfaces = new[]
{
new Gcp.Compute.Inputs.InstanceNetworkInterfaceArgs
{
Network = "default",
},
},
});
var @default = new Gcp.Compute.AttachedDisk("default", new()
{
Disk = defaultGoogleComputeDisk.Id,
Instance = defaultInstance.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultInstance, err := compute.NewInstance(ctx, "default", &compute.InstanceArgs{
Name: pulumi.String("attached-disk-instance"),
MachineType: pulumi.String("e2-medium"),
Zone: pulumi.String("us-west1-a"),
BootDisk: &compute.InstanceBootDiskArgs{
InitializeParams: &compute.InstanceBootDiskInitializeParamsArgs{
Image: pulumi.String("debian-cloud/debian-11"),
},
},
NetworkInterfaces: compute.InstanceNetworkInterfaceArray{
&compute.InstanceNetworkInterfaceArgs{
Network: pulumi.String("default"),
},
},
})
if err != nil {
return err
}
_, err = compute.NewAttachedDisk(ctx, "default", &compute.AttachedDiskArgs{
Disk: pulumi.Any(defaultGoogleComputeDisk.Id),
Instance: defaultInstance.ID(),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Instance;
import com.pulumi.gcp.compute.InstanceArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskInitializeParamsArgs;
import com.pulumi.gcp.compute.inputs.InstanceNetworkInterfaceArgs;
import com.pulumi.gcp.compute.AttachedDisk;
import com.pulumi.gcp.compute.AttachedDiskArgs;
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 defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.name("attached-disk-instance")
.machineType("e2-medium")
.zone("us-west1-a")
.bootDisk(InstanceBootDiskArgs.builder()
.initializeParams(InstanceBootDiskInitializeParamsArgs.builder()
.image("debian-cloud/debian-11")
.build())
.build())
.networkInterfaces(InstanceNetworkInterfaceArgs.builder()
.network("default")
.build())
.build());
var default_ = new AttachedDisk("default", AttachedDiskArgs.builder()
.disk(defaultGoogleComputeDisk.id())
.instance(defaultInstance.id())
.build());
}
}
resources:
default:
type: gcp:compute:AttachedDisk
properties:
disk: ${defaultGoogleComputeDisk.id}
instance: ${defaultInstance.id}
defaultInstance:
type: gcp:compute:Instance
name: default
properties:
name: attached-disk-instance
machineType: e2-medium
zone: us-west1-a
bootDisk:
initializeParams:
image: debian-cloud/debian-11
networkInterfaces:
- network: default
Import
Attached Disk can be imported the following ways:
projects/{{project}}/zones/{{zone}}/instances/{{instance.name}}/{{disk.name}}
{{project}}/{{zone}}/{{instance.name}}/{{disk.name}}
When using thepulumi import
command, Attached Disk can be imported using one of the formats above. For example:
$ pulumi import gcp:compute/attachedDisk:AttachedDisk default projects/{{project}}/zones/{{zone}}/instances/{{instance.name}}/{{disk.name}}
$ pulumi import gcp:compute/attachedDisk:AttachedDisk default {{project}}/{{zone}}/{{instance.name}}/{{disk.name}}
Properties
Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine.