RegionDiskArgs

data class RegionDiskArgs(val asyncPrimaryDisk: Output<RegionDiskAsyncPrimaryDiskArgs>? = null, val createSnapshotBeforeDestroy: Output<Boolean>? = null, val createSnapshotBeforeDestroyPrefix: Output<String>? = null, val description: Output<String>? = null, val diskEncryptionKey: Output<RegionDiskDiskEncryptionKeyArgs>? = null, val guestOsFeatures: Output<List<RegionDiskGuestOsFeatureArgs>>? = null, val interface: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val licenses: Output<List<String>>? = null, val name: Output<String>? = null, val physicalBlockSizeBytes: Output<Int>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val replicaZones: Output<List<String>>? = null, val size: Output<Int>? = null, val snapshot: Output<String>? = null, val sourceDisk: Output<String>? = null, val sourceSnapshotEncryptionKey: Output<RegionDiskSourceSnapshotEncryptionKeyArgs>? = null, val type: Output<String>? = null) : ConvertibleToJava<RegionDiskArgs>

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:

Warning: All arguments including the following potentially sensitive values will be stored in the raw state as plain text: disk_encryption_key.raw_key, disk_encryption_key.rsa_encrypted_key.

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/v8/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/v8/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/v8/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}}

Constructors

Link copied to clipboard
constructor(asyncPrimaryDisk: Output<RegionDiskAsyncPrimaryDiskArgs>? = null, createSnapshotBeforeDestroy: Output<Boolean>? = null, createSnapshotBeforeDestroyPrefix: Output<String>? = null, description: Output<String>? = null, diskEncryptionKey: Output<RegionDiskDiskEncryptionKeyArgs>? = null, guestOsFeatures: Output<List<RegionDiskGuestOsFeatureArgs>>? = null, interface: Output<String>? = null, labels: Output<Map<String, String>>? = null, licenses: Output<List<String>>? = null, name: Output<String>? = null, physicalBlockSizeBytes: Output<Int>? = null, project: Output<String>? = null, region: Output<String>? = null, replicaZones: Output<List<String>>? = null, size: Output<Int>? = null, snapshot: Output<String>? = null, sourceDisk: Output<String>? = null, sourceSnapshotEncryptionKey: Output<RegionDiskSourceSnapshotEncryptionKeyArgs>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard

A nested object resource. Structure is documented below.

Link copied to clipboard

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

Link copied to clipboard

This will set a custom name prefix for the snapshot that's created when the disk is deleted.

Link copied to clipboard
val description: Output<String>? = null

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val interface: Output<String>? = null

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

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val licenses: Output<List<String>>? = null

Any applicable license URI.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val physicalBlockSizeBytes: Output<Int>? = null

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.

Link copied to clipboard
val project: Output<String>? = null

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

Link copied to clipboard
val region: Output<String>? = null

A reference to the region where the disk resides.

Link copied to clipboard
val replicaZones: Output<List<String>>? = null

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

Link copied to clipboard
val size: Output<Int>? = null

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.

Link copied to clipboard
val snapshot: Output<String>? = null

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:

Link copied to clipboard
val sourceDisk: Output<String>? = null

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:

Link copied to clipboard

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.

Link copied to clipboard
val type: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): RegionDiskArgs