Disk
Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD). Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements. Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics. To get more information about Disk, see:
How-to Guides
Example Usage
Disk Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.Disk("default", {
name: "test-disk",
type: "pd-ssd",
zone: "us-central1-a",
image: "debian-11-bullseye-v20220719",
labels: {
environment: "dev",
},
physicalBlockSizeBytes: 4096,
});import pulumi
import pulumi_gcp as gcp
default = gcp.compute.Disk("default",
name="test-disk",
type="pd-ssd",
zone="us-central1-a",
image="debian-11-bullseye-v20220719",
labels={
"environment": "dev",
},
physical_block_size_bytes=4096)using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Compute.Disk("default", new()
{
Name = "test-disk",
Type = "pd-ssd",
Zone = "us-central1-a",
Image = "debian-11-bullseye-v20220719",
Labels =
{
{ "environment", "dev" },
},
PhysicalBlockSizeBytes = 4096,
});
});package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewDisk(ctx, "default", &compute.DiskArgs{
Name: pulumi.String("test-disk"),
Type: pulumi.String("pd-ssd"),
Zone: pulumi.String("us-central1-a"),
Image: pulumi.String("debian-11-bullseye-v20220719"),
Labels: pulumi.StringMap{
"environment": pulumi.String("dev"),
},
PhysicalBlockSizeBytes: pulumi.Int(4096),
})
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.Disk;
import com.pulumi.gcp.compute.DiskArgs;
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 default_ = new Disk("default", DiskArgs.builder()
.name("test-disk")
.type("pd-ssd")
.zone("us-central1-a")
.image("debian-11-bullseye-v20220719")
.labels(Map.of("environment", "dev"))
.physicalBlockSizeBytes(4096)
.build());
}
}resources:
default:
type: gcp:compute:Disk
properties:
name: test-disk
type: pd-ssd
zone: us-central1-a
image: debian-11-bullseye-v20220719
labels:
environment: dev
physicalBlockSizeBytes: 4096Disk Async
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const primary = new gcp.compute.Disk("primary", {
name: "async-test-disk",
type: "pd-ssd",
zone: "us-central1-a",
physicalBlockSizeBytes: 4096,
});
const secondary = new gcp.compute.Disk("secondary", {
name: "async-secondary-test-disk",
type: "pd-ssd",
zone: "us-east1-c",
asyncPrimaryDisk: {
disk: primary.id,
},
physicalBlockSizeBytes: 4096,
});import pulumi
import pulumi_gcp as gcp
primary = gcp.compute.Disk("primary",
name="async-test-disk",
type="pd-ssd",
zone="us-central1-a",
physical_block_size_bytes=4096)
secondary = gcp.compute.Disk("secondary",
name="async-secondary-test-disk",
type="pd-ssd",
zone="us-east1-c",
async_primary_disk={
"disk": primary.id,
},
physical_block_size_bytes=4096)using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var primary = new Gcp.Compute.Disk("primary", new()
{
Name = "async-test-disk",
Type = "pd-ssd",
Zone = "us-central1-a",
PhysicalBlockSizeBytes = 4096,
});
var secondary = new Gcp.Compute.Disk("secondary", new()
{
Name = "async-secondary-test-disk",
Type = "pd-ssd",
Zone = "us-east1-c",
AsyncPrimaryDisk = new Gcp.Compute.Inputs.DiskAsyncPrimaryDiskArgs
{
Disk = primary.Id,
},
PhysicalBlockSizeBytes = 4096,
});
});package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
primary, err := compute.NewDisk(ctx, "primary", &compute.DiskArgs{
Name: pulumi.String("async-test-disk"),
Type: pulumi.String("pd-ssd"),
Zone: pulumi.String("us-central1-a"),
PhysicalBlockSizeBytes: pulumi.Int(4096),
})
if err != nil {
return err
}
_, err = compute.NewDisk(ctx, "secondary", &compute.DiskArgs{
Name: pulumi.String("async-secondary-test-disk"),
Type: pulumi.String("pd-ssd"),
Zone: pulumi.String("us-east1-c"),
AsyncPrimaryDisk: &compute.DiskAsyncPrimaryDiskArgs{
Disk: primary.ID(),
},
PhysicalBlockSizeBytes: pulumi.Int(4096),
})
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.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.inputs.DiskAsyncPrimaryDiskArgs;
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 primary = new Disk("primary", DiskArgs.builder()
.name("async-test-disk")
.type("pd-ssd")
.zone("us-central1-a")
.physicalBlockSizeBytes(4096)
.build());
var secondary = new Disk("secondary", DiskArgs.builder()
.name("async-secondary-test-disk")
.type("pd-ssd")
.zone("us-east1-c")
.asyncPrimaryDisk(DiskAsyncPrimaryDiskArgs.builder()
.disk(primary.id())
.build())
.physicalBlockSizeBytes(4096)
.build());
}
}resources:
primary:
type: gcp:compute:Disk
properties:
name: async-test-disk
type: pd-ssd
zone: us-central1-a
physicalBlockSizeBytes: 4096
secondary:
type: gcp:compute:Disk
properties:
name: async-secondary-test-disk
type: pd-ssd
zone: us-east1-c
asyncPrimaryDisk:
disk: ${primary.id}
physicalBlockSizeBytes: 4096Disk Features
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.compute.Disk("default", {
name: "test-disk-features",
type: "pd-ssd",
zone: "us-central1-a",
labels: {
environment: "dev",
},
guestOsFeatures: [
{
type: "SECURE_BOOT",
},
{
type: "MULTI_IP_SUBNET",
},
{
type: "WINDOWS",
},
],
licenses: ["https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"],
physicalBlockSizeBytes: 4096,
});import pulumi
import pulumi_gcp as gcp
default = gcp.compute.Disk("default",
name="test-disk-features",
type="pd-ssd",
zone="us-central1-a",
labels={
"environment": "dev",
},
guest_os_features=[
{
"type": "SECURE_BOOT",
},
{
"type": "MULTI_IP_SUBNET",
},
{
"type": "WINDOWS",
},
],
licenses=["https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"],
physical_block_size_bytes=4096)using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Compute.Disk("default", new()
{
Name = "test-disk-features",
Type = "pd-ssd",
Zone = "us-central1-a",
Labels =
{
{ "environment", "dev" },
},
GuestOsFeatures = new[]
{
new Gcp.Compute.Inputs.DiskGuestOsFeatureArgs
{
Type = "SECURE_BOOT",
},
new Gcp.Compute.Inputs.DiskGuestOsFeatureArgs
{
Type = "MULTI_IP_SUBNET",
},
new Gcp.Compute.Inputs.DiskGuestOsFeatureArgs
{
Type = "WINDOWS",
},
},
Licenses = new[]
{
"https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core",
},
PhysicalBlockSizeBytes = 4096,
});
});package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewDisk(ctx, "default", &compute.DiskArgs{
Name: pulumi.String("test-disk-features"),
Type: pulumi.String("pd-ssd"),
Zone: pulumi.String("us-central1-a"),
Labels: pulumi.StringMap{
"environment": pulumi.String("dev"),
},
GuestOsFeatures: compute.DiskGuestOsFeatureArray{
&compute.DiskGuestOsFeatureArgs{
Type: pulumi.String("SECURE_BOOT"),
},
&compute.DiskGuestOsFeatureArgs{
Type: pulumi.String("MULTI_IP_SUBNET"),
},
&compute.DiskGuestOsFeatureArgs{
Type: pulumi.String("WINDOWS"),
},
},
Licenses: pulumi.StringArray{
pulumi.String("https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"),
},
PhysicalBlockSizeBytes: pulumi.Int(4096),
})
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.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.inputs.DiskGuestOsFeatureArgs;
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 default_ = new Disk("default", DiskArgs.builder()
.name("test-disk-features")
.type("pd-ssd")
.zone("us-central1-a")
.labels(Map.of("environment", "dev"))
.guestOsFeatures(
DiskGuestOsFeatureArgs.builder()
.type("SECURE_BOOT")
.build(),
DiskGuestOsFeatureArgs.builder()
.type("MULTI_IP_SUBNET")
.build(),
DiskGuestOsFeatureArgs.builder()
.type("WINDOWS")
.build())
.licenses("https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core")
.physicalBlockSizeBytes(4096)
.build());
}
}resources:
default:
type: gcp:compute:Disk
properties:
name: test-disk-features
type: pd-ssd
zone: us-central1-a
labels:
environment: dev
guestOsFeatures:
- type: SECURE_BOOT
- type: MULTI_IP_SUBNET
- type: WINDOWS
licenses:
- https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core
physicalBlockSizeBytes: 4096Import
Disk can be imported using any of these accepted formats:
projects/{{project}}/zones/{{zone}}/disks/{{name}}{{project}}/{{zone}}/{{name}}{{zone}}/{{name}}{{name}}When using thepulumi importcommand, Disk can be imported using one of the formats above. For example:
$ pulumi import gcp:compute/disk:Disk default projects/{{project}}/zones/{{zone}}/disks/{{name}}$ pulumi import gcp:compute/disk:Disk default {{project}}/{{zone}}/{{name}}$ pulumi import gcp:compute/disk:Disk default {{zone}}/{{name}}$ pulumi import gcp:compute/disk:Disk default {{name}}Properties
The accessMode of the disk. For example:
(Optional)
A nested object resource. Structure is documented below.
If set to true, a snapshot of the disk will be created before it is destroyed. If your disk is encrypted with customer managed encryption keys these will be reused for the snapshot creation. The name of the snapshot by default will be {{disk-name}}-YYYYMMDD-HHmm
This will set a custom name prefix for the snapshot that's created when the disk is deleted.
Creation timestamp in RFC3339 text format.
An optional description of this resource. Provide this property when you create the resource.
Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Structure is documented below.
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Whether this disk is using confidential compute mode. Note: Only supported on hyperdisk skus, disk_encryption_key is required when setting to true
A list of features to enable on the guest operating system. Applicable only for bootable disks. Structure is documented below.
The image from which to initialize this disk. This can be one of: the image's self_link, projects/{project}/global/images/{image}, projects/{project}/global/images/family/{family}, global/images/{image}, global/images/family/{family}, family/{family}, {project}/{family}, {project}/{image}, {family}, or {image}. If referred by family, the images names must include the family name. If they don't, use the gcp.compute.Image data source. For instance, the image centos-6-v20180104 includes its family name centos-6. These images can be referred by family name here.
The fingerprint used for optimistic locking of this resource. Used internally during updates.
Last attach timestamp in RFC3339 text format.
Last detach timestamp in RFC3339 text format.
Indicates whether or not the disk can be read/write attached to more than one instance.
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
Indicates how many IOPS must be provisioned for the disk. Note: Updating currently is only supported by hyperdisk skus without the need to delete and recreate the disk, hyperdisk allows for an update of IOPS every 4 hours. To update your hyperdisk more frequently, you'll need to manually delete and recreate it
Indicates how much Throughput must be provisioned for the disk. Note: Updating currently is only supported by hyperdisk skus without the need to delete and recreate the disk, hyperdisk allows for an update of Throughput every 4 hours. To update your hyperdisk more frequently, you'll need to manually delete and recreate it
The combination of labels configured directly on the resource and default labels configured on the provider.
Resource policies applied to this disk for automatic snapshot creations. ~>NOTE This value does not support updating the resource policy, as resource policies can not be updated more than one at a time. Use gcp.compute.DiskResourcePolicyAttachment to allow for updating the resource policy attached to the disk.
Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the image or snapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with image or snapshot, the value must not be less than the size of the image or the size of the snapshot. ~>NOTE If you change the size, the provider updates the disk size if upsizing is detected but recreates the disk if downsizing is requested. You can add lifecycle.prevent_destroy in the config to prevent destroying and recreating.
The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Structure is documented below.
The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Structure is documented below.
The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
The URL or the name of the storage pool in which the new disk is created. For example: