pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/RegionDisk

RegionDisk

class RegionDisk : KotlinCustomResource

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 RegionDisk, see:

API documentation
How-to Guides

Adding or Resizing Regional Persistent Disks

Example Usage

Region Disk Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const disk = new gcp.compute.Disk("disk", {
    name: "my-disk",
    image: "debian-cloud/debian-11",
    size: 50,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const snapdisk = new gcp.compute.Snapshot("snapdisk", {
    name: "my-snapshot",
    sourceDisk: disk.name,
    zone: "us-central1-a",
});
const regiondisk = new gcp.compute.RegionDisk("regiondisk", {
    name: "my-region-disk",
    snapshot: snapdisk.id,
    type: "pd-ssd",
    region: "us-central1",
    physicalBlockSizeBytes: 4096,
    replicaZones: [
        "us-central1-a",
        "us-central1-f",
    ],
});

import pulumi
import pulumi_gcp as gcp
disk = gcp.compute.Disk("disk",
    name="my-disk",
    image="debian-cloud/debian-11",
    size=50,
    type="pd-ssd",
    zone="us-central1-a")
snapdisk = gcp.compute.Snapshot("snapdisk",
    name="my-snapshot",
    source_disk=disk.name,
    zone="us-central1-a")
regiondisk = gcp.compute.RegionDisk("regiondisk",
    name="my-region-disk",
    snapshot=snapdisk.id,
    type="pd-ssd",
    region="us-central1",
    physical_block_size_bytes=4096,
    replica_zones=[
        "us-central1-a",
        "us-central1-f",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var disk = new Gcp.Compute.Disk("disk", new()
    {
        Name = "my-disk",
        Image = "debian-cloud/debian-11",
        Size = 50,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var snapdisk = new Gcp.Compute.Snapshot("snapdisk", new()
    {
        Name = "my-snapshot",
        SourceDisk = disk.Name,
        Zone = "us-central1-a",
    });
    var regiondisk = new Gcp.Compute.RegionDisk("regiondisk", new()
    {
        Name = "my-region-disk",
        Snapshot = snapdisk.Id,
        Type = "pd-ssd",
        Region = "us-central1",
        PhysicalBlockSizeBytes = 4096,
        ReplicaZones = new[]
        {
            "us-central1-a",
            "us-central1-f",
        },
    });
});

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 {
		disk, err := compute.NewDisk(ctx, "disk", &compute.DiskArgs{
			Name:  pulumi.String("my-disk"),
			Image: pulumi.String("debian-cloud/debian-11"),
			Size:  pulumi.Int(50),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		snapdisk, err := compute.NewSnapshot(ctx, "snapdisk", &compute.SnapshotArgs{
			Name:       pulumi.String("my-snapshot"),
			SourceDisk: disk.Name,
			Zone:       pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionDisk(ctx, "regiondisk", &compute.RegionDiskArgs{
			Name:                   pulumi.String("my-region-disk"),
			Snapshot:               snapdisk.ID(),
			Type:                   pulumi.String("pd-ssd"),
			Region:                 pulumi.String("us-central1"),
			PhysicalBlockSizeBytes: pulumi.Int(4096),
			ReplicaZones: pulumi.StringArray{
				pulumi.String("us-central1-a"),
				pulumi.String("us-central1-f"),
			},
		})
		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.Snapshot;
import com.pulumi.gcp.compute.SnapshotArgs;
import com.pulumi.gcp.compute.RegionDisk;
import com.pulumi.gcp.compute.RegionDiskArgs;
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 disk = new Disk("disk", DiskArgs.builder()
            .name("my-disk")
            .image("debian-cloud/debian-11")
            .size(50)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var snapdisk = new Snapshot("snapdisk", SnapshotArgs.builder()
            .name("my-snapshot")
            .sourceDisk(disk.name())
            .zone("us-central1-a")
            .build());
        var regiondisk = new RegionDisk("regiondisk", RegionDiskArgs.builder()
            .name("my-region-disk")
            .snapshot(snapdisk.id())
            .type("pd-ssd")
            .region("us-central1")
            .physicalBlockSizeBytes(4096)
            .replicaZones(
                "us-central1-a",
                "us-central1-f")
            .build());
    }
}

resources:
  regiondisk:
    type: gcp:compute:RegionDisk
    properties:
      name: my-region-disk
      snapshot: ${snapdisk.id}
      type: pd-ssd
      region: us-central1
      physicalBlockSizeBytes: 4096
      replicaZones:
        - us-central1-a
        - us-central1-f
  disk:
    type: gcp:compute:Disk
    properties:
      name: my-disk
      image: debian-cloud/debian-11
      size: 50
      type: pd-ssd
      zone: us-central1-a
  snapdisk:
    type: gcp:compute:Snapshot
    properties:
      name: my-snapshot
      sourceDisk: ${disk.name}
      zone: us-central1-a

Region Disk Async

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const primary = new gcp.compute.RegionDisk("primary", {
    name: "primary-region-disk",
    type: "pd-ssd",
    region: "us-central1",
    physicalBlockSizeBytes: 4096,
    replicaZones: [
        "us-central1-a",
        "us-central1-f",
    ],
});
const secondary = new gcp.compute.RegionDisk("secondary", {
    name: "secondary-region-disk",
    type: "pd-ssd",
    region: "us-east1",
    physicalBlockSizeBytes: 4096,
    asyncPrimaryDisk: {
        disk: primary.id,
    },
    replicaZones: [
        "us-east1-b",
        "us-east1-c",
    ],
});

import pulumi
import pulumi_gcp as gcp
primary = gcp.compute.RegionDisk("primary",
    name="primary-region-disk",
    type="pd-ssd",
    region="us-central1",
    physical_block_size_bytes=4096,
    replica_zones=[
        "us-central1-a",
        "us-central1-f",
    ])
secondary = gcp.compute.RegionDisk("secondary",
    name="secondary-region-disk",
    type="pd-ssd",
    region="us-east1",
    physical_block_size_bytes=4096,
    async_primary_disk={
        "disk": primary.id,
    },
    replica_zones=[
        "us-east1-b",
        "us-east1-c",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var primary = new Gcp.Compute.RegionDisk("primary", new()
    {
        Name = "primary-region-disk",
        Type = "pd-ssd",
        Region = "us-central1",
        PhysicalBlockSizeBytes = 4096,
        ReplicaZones = new[]
        {
            "us-central1-a",
            "us-central1-f",
        },
    });
    var secondary = new Gcp.Compute.RegionDisk("secondary", new()
    {
        Name = "secondary-region-disk",
        Type = "pd-ssd",
        Region = "us-east1",
        PhysicalBlockSizeBytes = 4096,
        AsyncPrimaryDisk = new Gcp.Compute.Inputs.RegionDiskAsyncPrimaryDiskArgs
        {
            Disk = primary.Id,
        },
        ReplicaZones = new[]
        {
            "us-east1-b",
            "us-east1-c",
        },
    });
});

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 {
		primary, err := compute.NewRegionDisk(ctx, "primary", &compute.RegionDiskArgs{
			Name:                   pulumi.String("primary-region-disk"),
			Type:                   pulumi.String("pd-ssd"),
			Region:                 pulumi.String("us-central1"),
			PhysicalBlockSizeBytes: pulumi.Int(4096),
			ReplicaZones: pulumi.StringArray{
				pulumi.String("us-central1-a"),
				pulumi.String("us-central1-f"),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionDisk(ctx, "secondary", &compute.RegionDiskArgs{
			Name:                   pulumi.String("secondary-region-disk"),
			Type:                   pulumi.String("pd-ssd"),
			Region:                 pulumi.String("us-east1"),
			PhysicalBlockSizeBytes: pulumi.Int(4096),
			AsyncPrimaryDisk: &compute.RegionDiskAsyncPrimaryDiskArgs{
				Disk: primary.ID(),
			},
			ReplicaZones: pulumi.StringArray{
				pulumi.String("us-east1-b"),
				pulumi.String("us-east1-c"),
			},
		})
		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.RegionDisk;
import com.pulumi.gcp.compute.RegionDiskArgs;
import com.pulumi.gcp.compute.inputs.RegionDiskAsyncPrimaryDiskArgs;
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 RegionDisk("primary", RegionDiskArgs.builder()
            .name("primary-region-disk")
            .type("pd-ssd")
            .region("us-central1")
            .physicalBlockSizeBytes(4096)
            .replicaZones(
                "us-central1-a",
                "us-central1-f")
            .build());
        var secondary = new RegionDisk("secondary", RegionDiskArgs.builder()
            .name("secondary-region-disk")
            .type("pd-ssd")
            .region("us-east1")
            .physicalBlockSizeBytes(4096)
            .asyncPrimaryDisk(RegionDiskAsyncPrimaryDiskArgs.builder()
                .disk(primary.id())
                .build())
            .replicaZones(
                "us-east1-b",
                "us-east1-c")
            .build());
    }
}

resources:
  primary:
    type: gcp:compute:RegionDisk
    properties:
      name: primary-region-disk
      type: pd-ssd
      region: us-central1
      physicalBlockSizeBytes: 4096
      replicaZones:
        - us-central1-a
        - us-central1-f
  secondary:
    type: gcp:compute:RegionDisk
    properties:
      name: secondary-region-disk
      type: pd-ssd
      region: us-east1
      physicalBlockSizeBytes: 4096
      asyncPrimaryDisk:
        disk: ${primary.id}
      replicaZones:
        - us-east1-b
        - us-east1-c

Region Disk Features

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const regiondisk = new gcp.compute.RegionDisk("regiondisk", {
    name: "my-region-features-disk",
    type: "pd-ssd",
    region: "us-central1",
    physicalBlockSizeBytes: 4096,
    guestOsFeatures: [
        {
            type: "SECURE_BOOT",
        },
        {
            type: "MULTI_IP_SUBNET",
        },
        {
            type: "WINDOWS",
        },
    ],
    licenses: ["https://www&#46;googleapis&#46;com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"],
    replicaZones: [
        "us-central1-a",
        "us-central1-f",
    ],
});

import pulumi
import pulumi_gcp as gcp
regiondisk = gcp.compute.RegionDisk("regiondisk",
    name="my-region-features-disk",
    type="pd-ssd",
    region="us-central1",
    physical_block_size_bytes=4096,
    guest_os_features=[
        {
            "type": "SECURE_BOOT",
        },
        {
            "type": "MULTI_IP_SUBNET",
        },
        {
            "type": "WINDOWS",
        },
    ],
    licenses=["https://www&#46;googleapis&#46;com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"],
    replica_zones=[
        "us-central1-a",
        "us-central1-f",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var regiondisk = new Gcp.Compute.RegionDisk("regiondisk", new()
    {
        Name = "my-region-features-disk",
        Type = "pd-ssd",
        Region = "us-central1",
        PhysicalBlockSizeBytes = 4096,
        GuestOsFeatures = new[]
        {
            new Gcp.Compute.Inputs.RegionDiskGuestOsFeatureArgs
            {
                Type = "SECURE_BOOT",
            },
            new Gcp.Compute.Inputs.RegionDiskGuestOsFeatureArgs
            {
                Type = "MULTI_IP_SUBNET",
            },
            new Gcp.Compute.Inputs.RegionDiskGuestOsFeatureArgs
            {
                Type = "WINDOWS",
            },
        },
        Licenses = new[]
        {
            "https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core",
        },
        ReplicaZones = new[]
        {
            "us-central1-a",
            "us-central1-f",
        },
    });
});

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 {
		_, err := compute.NewRegionDisk(ctx, "regiondisk", &compute.RegionDiskArgs{
			Name:                   pulumi.String("my-region-features-disk"),
			Type:                   pulumi.String("pd-ssd"),
			Region:                 pulumi.String("us-central1"),
			PhysicalBlockSizeBytes: pulumi.Int(4096),
			GuestOsFeatures: compute.RegionDiskGuestOsFeatureArray{
				&compute.RegionDiskGuestOsFeatureArgs{
					Type: pulumi.String("SECURE_BOOT"),
				},
				&compute.RegionDiskGuestOsFeatureArgs{
					Type: pulumi.String("MULTI_IP_SUBNET"),
				},
				&compute.RegionDiskGuestOsFeatureArgs{
					Type: pulumi.String("WINDOWS"),
				},
			},
			Licenses: pulumi.StringArray{
				pulumi.String("https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"),
			},
			ReplicaZones: pulumi.StringArray{
				pulumi.String("us-central1-a"),
				pulumi.String("us-central1-f"),
			},
		})
		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.RegionDisk;
import com.pulumi.gcp.compute.RegionDiskArgs;
import com.pulumi.gcp.compute.inputs.RegionDiskGuestOsFeatureArgs;
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 regiondisk = new RegionDisk("regiondisk", RegionDiskArgs.builder()
            .name("my-region-features-disk")
            .type("pd-ssd")
            .region("us-central1")
            .physicalBlockSizeBytes(4096)
            .guestOsFeatures(
                RegionDiskGuestOsFeatureArgs.builder()
                    .type("SECURE_BOOT")
                    .build(),
                RegionDiskGuestOsFeatureArgs.builder()
                    .type("MULTI_IP_SUBNET")
                    .build(),
                RegionDiskGuestOsFeatureArgs.builder()
                    .type("WINDOWS")
                    .build())
            .licenses("https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core")
            .replicaZones(
                "us-central1-a",
                "us-central1-f")
            .build());
    }
}

resources:
  regiondisk:
    type: gcp:compute:RegionDisk
    properties:
      name: my-region-features-disk
      type: pd-ssd
      region: us-central1
      physicalBlockSizeBytes: 4096
      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
      replicaZones:
        - us-central1-a
        - us-central1-f

Import

RegionDisk can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/disks/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}} When using the pulumi import command, RegionDisk can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/regionDisk:RegionDisk default projects/{{project}}/regions/{{region}}/disks/{{name}}

$ pulumi import gcp:compute/regionDisk:RegionDisk default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:compute/regionDisk:RegionDisk default {{region}}/{{name}}

$ pulumi import gcp:compute/regionDisk:RegionDisk default {{name}}

Properties

asyncPrimaryDisk

val asyncPrimaryDisk: Output<RegionDiskAsyncPrimaryDisk>?

A nested object resource Structure is documented below.

creationTimestamp

val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

description

val description: Output<String>?

An optional description of this resource. Provide this property when you create the resource.

diskEncryptionKey

val diskEncryptionKey: Output<RegionDiskDiskEncryptionKey>?

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.

effectiveLabels

val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

guestOsFeatures

val guestOsFeatures: Output<List<RegionDiskGuestOsFeature>>

A list of features to enable on the guest operating system. Applicable only for bootable disks. Structure is documented below.

val id: Output<String>

interface

val ~~interface~~: Output<String>?

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

labelFingerprint

val labelFingerprint: Output<String>

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels

val labels: Output<Map<String, String>>?

Labels to apply to this disk. A list of key->value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

lastAttachTimestamp

val lastAttachTimestamp: Output<String>

Last attach timestamp in RFC3339 text format.

lastDetachTimestamp

val lastDetachTimestamp: Output<String>

Last detach timestamp in RFC3339 text format.

licenses

val licenses: Output<List<String>>

Any applicable license URI.

name

val name: Output<String>

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.

physicalBlockSizeBytes

val physicalBlockSizeBytes: Output<Int>

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.

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels

val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

region

val region: Output<String>

A reference to the region where the disk resides.

replicaZones

val replicaZones: Output<List<String>>

URLs of the zones where the disk should be replicated to.

selfLink

val selfLink: Output<String>

The URI of the created resource.

size

val size: Output<Int>

Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.

snapshot

val snapshot: Output<String>?

The source 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:

sourceDisk

val sourceDisk: Output<String>?

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:

sourceDiskId

val sourceDiskId: Output<String>

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.

sourceSnapshotEncryptionKey

val sourceSnapshotEncryptionKey: Output<RegionDiskSourceSnapshotEncryptionKey>?

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.

sourceSnapshotId

val sourceSnapshotId: Output<String>

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.

type

val type: Output<String>?

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.

urn

val urn: Output<String>

users

val users: Output<List<String>>

Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance