1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. RegionDisk
Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi

gcp.compute.RegionDisk

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi

    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:

    Example Usage

    Region Disk Basic

    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()
        {
            Image = "debian-cloud/debian-11",
            Size = 50,
            Type = "pd-ssd",
            Zone = "us-central1-a",
        });
    
        var snapdisk = new Gcp.Compute.Snapshot("snapdisk", new()
        {
            SourceDisk = disk.Name,
            Zone = "us-central1-a",
        });
    
        var regiondisk = new Gcp.Compute.RegionDisk("regiondisk", new()
        {
            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{
    			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{
    			SourceDisk: disk.Name,
    			Zone:       pulumi.String("us-central1-a"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewRegionDisk(ctx, "regiondisk", &compute.RegionDiskArgs{
    			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()        
                .image("debian-cloud/debian-11")
                .size(50)
                .type("pd-ssd")
                .zone("us-central1-a")
                .build());
    
            var snapdisk = new Snapshot("snapdisk", SnapshotArgs.builder()        
                .sourceDisk(disk.name())
                .zone("us-central1-a")
                .build());
    
            var regiondisk = new RegionDisk("regiondisk", RegionDiskArgs.builder()        
                .snapshot(snapdisk.id())
                .type("pd-ssd")
                .region("us-central1")
                .physicalBlockSizeBytes(4096)
                .replicaZones(            
                    "us-central1-a",
                    "us-central1-f")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    disk = gcp.compute.Disk("disk",
        image="debian-cloud/debian-11",
        size=50,
        type="pd-ssd",
        zone="us-central1-a")
    snapdisk = gcp.compute.Snapshot("snapdisk",
        source_disk=disk.name,
        zone="us-central1-a")
    regiondisk = gcp.compute.RegionDisk("regiondisk",
        snapshot=snapdisk.id,
        type="pd-ssd",
        region="us-central1",
        physical_block_size_bytes=4096,
        replica_zones=[
            "us-central1-a",
            "us-central1-f",
        ])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const disk = new gcp.compute.Disk("disk", {
        image: "debian-cloud/debian-11",
        size: 50,
        type: "pd-ssd",
        zone: "us-central1-a",
    });
    const snapdisk = new gcp.compute.Snapshot("snapdisk", {
        sourceDisk: disk.name,
        zone: "us-central1-a",
    });
    const regiondisk = new gcp.compute.RegionDisk("regiondisk", {
        snapshot: snapdisk.id,
        type: "pd-ssd",
        region: "us-central1",
        physicalBlockSizeBytes: 4096,
        replicaZones: [
            "us-central1-a",
            "us-central1-f",
        ],
    });
    
    resources:
      regiondisk:
        type: gcp:compute:RegionDisk
        properties:
          snapshot: ${snapdisk.id}
          type: pd-ssd
          region: us-central1
          physicalBlockSizeBytes: 4096
          replicaZones:
            - us-central1-a
            - us-central1-f
      disk:
        type: gcp:compute:Disk
        properties:
          image: debian-cloud/debian-11
          size: 50
          type: pd-ssd
          zone: us-central1-a
      snapdisk:
        type: gcp:compute:Snapshot
        properties:
          sourceDisk: ${disk.name}
          zone: us-central1-a
    

    Region Disk Async

    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()
        {
            Type = "pd-ssd",
            Region = "us-central1",
            PhysicalBlockSizeBytes = 4096,
            ReplicaZones = new[]
            {
                "us-central1-a",
                "us-central1-f",
            },
        });
    
        var secondary = new Gcp.Compute.RegionDisk("secondary", new()
        {
            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{
    			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{
    			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()        
                .type("pd-ssd")
                .region("us-central1")
                .physicalBlockSizeBytes(4096)
                .replicaZones(            
                    "us-central1-a",
                    "us-central1-f")
                .build());
    
            var secondary = new RegionDisk("secondary", RegionDiskArgs.builder()        
                .type("pd-ssd")
                .region("us-east1")
                .physicalBlockSizeBytes(4096)
                .asyncPrimaryDisk(RegionDiskAsyncPrimaryDiskArgs.builder()
                    .disk(primary.id())
                    .build())
                .replicaZones(            
                    "us-east1-b",
                    "us-east1-c")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.compute.RegionDisk("primary",
        type="pd-ssd",
        region="us-central1",
        physical_block_size_bytes=4096,
        replica_zones=[
            "us-central1-a",
            "us-central1-f",
        ])
    secondary = gcp.compute.RegionDisk("secondary",
        type="pd-ssd",
        region="us-east1",
        physical_block_size_bytes=4096,
        async_primary_disk=gcp.compute.RegionDiskAsyncPrimaryDiskArgs(
            disk=primary.id,
        ),
        replica_zones=[
            "us-east1-b",
            "us-east1-c",
        ])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.compute.RegionDisk("primary", {
        type: "pd-ssd",
        region: "us-central1",
        physicalBlockSizeBytes: 4096,
        replicaZones: [
            "us-central1-a",
            "us-central1-f",
        ],
    });
    const secondary = new gcp.compute.RegionDisk("secondary", {
        type: "pd-ssd",
        region: "us-east1",
        physicalBlockSizeBytes: 4096,
        asyncPrimaryDisk: {
            disk: primary.id,
        },
        replicaZones: [
            "us-east1-b",
            "us-east1-c",
        ],
    });
    
    resources:
      primary:
        type: gcp:compute:RegionDisk
        properties:
          type: pd-ssd
          region: us-central1
          physicalBlockSizeBytes: 4096
          replicaZones:
            - us-central1-a
            - us-central1-f
      secondary:
        type: gcp:compute:RegionDisk
        properties:
          type: pd-ssd
          region: us-east1
          physicalBlockSizeBytes: 4096
          asyncPrimaryDisk:
            disk: ${primary.id}
          replicaZones:
            - us-east1-b
            - us-east1-c
    

    Region Disk Features

    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()
        {
            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",
            },
            PhysicalBlockSizeBytes = 4096,
            Region = "us-central1",
            ReplicaZones = new[]
            {
                "us-central1-a",
                "us-central1-f",
            },
            Type = "pd-ssd",
        });
    
    });
    
    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{
    			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"),
    			},
    			PhysicalBlockSizeBytes: pulumi.Int(4096),
    			Region:                 pulumi.String("us-central1"),
    			ReplicaZones: pulumi.StringArray{
    				pulumi.String("us-central1-a"),
    				pulumi.String("us-central1-f"),
    			},
    			Type: pulumi.String("pd-ssd"),
    		})
    		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()        
                .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")
                .physicalBlockSizeBytes(4096)
                .region("us-central1")
                .replicaZones(            
                    "us-central1-a",
                    "us-central1-f")
                .type("pd-ssd")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    regiondisk = gcp.compute.RegionDisk("regiondisk",
        guest_os_features=[
            gcp.compute.RegionDiskGuestOsFeatureArgs(
                type="SECURE_BOOT",
            ),
            gcp.compute.RegionDiskGuestOsFeatureArgs(
                type="MULTI_IP_SUBNET",
            ),
            gcp.compute.RegionDiskGuestOsFeatureArgs(
                type="WINDOWS",
            ),
        ],
        licenses=["https://www.googleapis.com/compute/v1/projects/windows-cloud/global/licenses/windows-server-core"],
        physical_block_size_bytes=4096,
        region="us-central1",
        replica_zones=[
            "us-central1-a",
            "us-central1-f",
        ],
        type="pd-ssd")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const regiondisk = new gcp.compute.RegionDisk("regiondisk", {
        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,
        region: "us-central1",
        replicaZones: [
            "us-central1-a",
            "us-central1-f",
        ],
        type: "pd-ssd",
    });
    
    resources:
      regiondisk:
        type: gcp:compute:RegionDisk
        properties:
          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
          region: us-central1
          replicaZones:
            - us-central1-a
            - us-central1-f
          type: pd-ssd
    

    Create RegionDisk Resource

    new RegionDisk(name: string, args: RegionDiskArgs, opts?: CustomResourceOptions);
    @overload
    def RegionDisk(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   async_primary_disk: Optional[RegionDiskAsyncPrimaryDiskArgs] = None,
                   description: Optional[str] = None,
                   disk_encryption_key: Optional[RegionDiskDiskEncryptionKeyArgs] = None,
                   guest_os_features: Optional[Sequence[RegionDiskGuestOsFeatureArgs]] = None,
                   interface: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   licenses: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   physical_block_size_bytes: Optional[int] = None,
                   project: Optional[str] = None,
                   region: Optional[str] = None,
                   replica_zones: Optional[Sequence[str]] = None,
                   size: Optional[int] = None,
                   snapshot: Optional[str] = None,
                   source_disk: Optional[str] = None,
                   source_snapshot_encryption_key: Optional[RegionDiskSourceSnapshotEncryptionKeyArgs] = None,
                   type: Optional[str] = None)
    @overload
    def RegionDisk(resource_name: str,
                   args: RegionDiskArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewRegionDisk(ctx *Context, name string, args RegionDiskArgs, opts ...ResourceOption) (*RegionDisk, error)
    public RegionDisk(string name, RegionDiskArgs args, CustomResourceOptions? opts = null)
    public RegionDisk(String name, RegionDiskArgs args)
    public RegionDisk(String name, RegionDiskArgs args, CustomResourceOptions options)
    
    type: gcp:compute:RegionDisk
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args RegionDiskArgs
    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 RegionDiskArgs
    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 RegionDiskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionDiskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionDiskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RegionDisk Resource Properties

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

    Inputs

    The RegionDisk resource accepts the following input properties:

    ReplicaZones List<string>

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


    AsyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    Description string

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

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

    GuestOsFeatures List<RegionDiskGuestOsFeature>

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

    Interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

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

    Licenses List<string>

    Any applicable license URI.

    Name 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 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 string

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

    Region string

    A reference to the region where the disk resides.

    Size 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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    SourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    SourceSnapshotEncryptionKey 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.

    Type string

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

    ReplicaZones []string

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


    AsyncPrimaryDisk RegionDiskAsyncPrimaryDiskArgs

    A nested object resource Structure is documented below.

    Description string

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

    DiskEncryptionKey RegionDiskDiskEncryptionKeyArgs

    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.

    GuestOsFeatures []RegionDiskGuestOsFeatureArgs

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

    Interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

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

    Licenses []string

    Any applicable license URI.

    Name 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 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 string

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

    Region string

    A reference to the region where the disk resides.

    Size 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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    SourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    SourceSnapshotEncryptionKey RegionDiskSourceSnapshotEncryptionKeyArgs

    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.

    Type string

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

    replicaZones List<String>

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


    asyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    description String

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

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

    guestOsFeatures List<RegionDiskGuestOsFeature>

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

    interface_ String

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

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

    licenses List<String>

    Any applicable license URI.

    name 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 Integer

    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 String

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

    region String

    A reference to the region where the disk resides.

    size Integer

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceSnapshotEncryptionKey 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.

    type String

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

    replicaZones string[]

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


    asyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    description string

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

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

    guestOsFeatures RegionDiskGuestOsFeature[]

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

    interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    labels {[key: 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.

    licenses string[]

    Any applicable license URI.

    name 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 number

    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 string

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

    region string

    A reference to the region where the disk resides.

    size number

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceSnapshotEncryptionKey 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.

    type string

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

    replica_zones Sequence[str]

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


    async_primary_disk RegionDiskAsyncPrimaryDiskArgs

    A nested object resource Structure is documented below.

    description str

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

    disk_encryption_key RegionDiskDiskEncryptionKeyArgs

    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.

    guest_os_features Sequence[RegionDiskGuestOsFeatureArgs]

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

    interface str

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    labels Mapping[str, str]

    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.

    licenses Sequence[str]

    Any applicable license URI.

    name str

    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.

    physical_block_size_bytes 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 str

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

    region str

    A reference to the region where the disk resides.

    size 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 str

    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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    source_disk str

    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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    source_snapshot_encryption_key RegionDiskSourceSnapshotEncryptionKeyArgs

    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.

    type str

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

    replicaZones List<String>

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


    asyncPrimaryDisk Property Map

    A nested object resource Structure is documented below.

    description String

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

    diskEncryptionKey Property Map

    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.

    guestOsFeatures List<Property Map>

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

    interface String

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

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

    licenses List<String>

    Any applicable license URI.

    name 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 Number

    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 String

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

    region String

    A reference to the region where the disk resides.

    size Number

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceSnapshotEncryptionKey Property Map

    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.

    type String

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegionDisk resource produces the following output properties:

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    EffectiveLabels Dictionary<string, string>

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

    Id string

    The provider-assigned unique ID for this managed resource.

    LabelFingerprint string

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

    LastAttachTimestamp string

    Last attach timestamp in RFC3339 text format.

    LastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    PulumiLabels Dictionary<string, string>

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

    SelfLink string

    The URI of the created resource.

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

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

    Users List<string>

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

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

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

    Id string

    The provider-assigned unique ID for this managed resource.

    LabelFingerprint string

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

    LastAttachTimestamp string

    Last attach timestamp in RFC3339 text format.

    LastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    PulumiLabels map[string]string

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

    SelfLink string

    The URI of the created resource.

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

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

    Users []string

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

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

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

    id String

    The provider-assigned unique ID for this managed resource.

    labelFingerprint String

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

    lastAttachTimestamp String

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp String

    Last detach timestamp in RFC3339 text format.

    pulumiLabels Map<String,String>

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

    selfLink String

    The URI of the created resource.

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

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

    users List<String>

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

    creationTimestamp string

    Creation timestamp in RFC3339 text format.

    effectiveLabels {[key: string]: string}

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

    id string

    The provider-assigned unique ID for this managed resource.

    labelFingerprint string

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

    lastAttachTimestamp string

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    pulumiLabels {[key: string]: string}

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

    selfLink string

    The URI of the created resource.

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

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

    users string[]

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

    creation_timestamp str

    Creation timestamp in RFC3339 text format.

    effective_labels Mapping[str, str]

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

    id str

    The provider-assigned unique ID for this managed resource.

    label_fingerprint str

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

    last_attach_timestamp str

    Last attach timestamp in RFC3339 text format.

    last_detach_timestamp str

    Last detach timestamp in RFC3339 text format.

    pulumi_labels Mapping[str, str]

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

    self_link str

    The URI of the created resource.

    source_disk_id str

    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.

    source_snapshot_id str

    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.

    users Sequence[str]

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

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    effectiveLabels Map<String>

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

    id String

    The provider-assigned unique ID for this managed resource.

    labelFingerprint String

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

    lastAttachTimestamp String

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp String

    Last detach timestamp in RFC3339 text format.

    pulumiLabels Map<String>

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

    selfLink String

    The URI of the created resource.

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

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

    users List<String>

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

    Look up Existing RegionDisk Resource

    Get an existing RegionDisk 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?: RegionDiskState, opts?: CustomResourceOptions): RegionDisk
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            async_primary_disk: Optional[RegionDiskAsyncPrimaryDiskArgs] = None,
            creation_timestamp: Optional[str] = None,
            description: Optional[str] = None,
            disk_encryption_key: Optional[RegionDiskDiskEncryptionKeyArgs] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            guest_os_features: Optional[Sequence[RegionDiskGuestOsFeatureArgs]] = None,
            interface: Optional[str] = None,
            label_fingerprint: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            last_attach_timestamp: Optional[str] = None,
            last_detach_timestamp: Optional[str] = None,
            licenses: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            physical_block_size_bytes: Optional[int] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            region: Optional[str] = None,
            replica_zones: Optional[Sequence[str]] = None,
            self_link: Optional[str] = None,
            size: Optional[int] = None,
            snapshot: Optional[str] = None,
            source_disk: Optional[str] = None,
            source_disk_id: Optional[str] = None,
            source_snapshot_encryption_key: Optional[RegionDiskSourceSnapshotEncryptionKeyArgs] = None,
            source_snapshot_id: Optional[str] = None,
            type: Optional[str] = None,
            users: Optional[Sequence[str]] = None) -> RegionDisk
    func GetRegionDisk(ctx *Context, name string, id IDInput, state *RegionDiskState, opts ...ResourceOption) (*RegionDisk, error)
    public static RegionDisk Get(string name, Input<string> id, RegionDiskState? state, CustomResourceOptions? opts = null)
    public static RegionDisk get(String name, Output<String> id, RegionDiskState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    AsyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

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

    DiskEncryptionKey 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 Dictionary<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 List<RegionDiskGuestOsFeature>

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

    Interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    LabelFingerprint string

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

    Labels Dictionary<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 string

    Last attach timestamp in RFC3339 text format.

    LastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    Licenses List<string>

    Any applicable license URI.

    Name 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 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 string

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

    PulumiLabels Dictionary<string, string>

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

    Region string

    A reference to the region where the disk resides.

    ReplicaZones List<string>

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


    SelfLink string

    The URI of the created resource.

    Size 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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    SourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    SourceDiskId 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 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 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 string

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

    Users List<string>

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

    AsyncPrimaryDisk RegionDiskAsyncPrimaryDiskArgs

    A nested object resource Structure is documented below.

    CreationTimestamp string

    Creation timestamp in RFC3339 text format.

    Description string

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

    DiskEncryptionKey RegionDiskDiskEncryptionKeyArgs

    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 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 []RegionDiskGuestOsFeatureArgs

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

    Interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    LabelFingerprint string

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

    Labels 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 string

    Last attach timestamp in RFC3339 text format.

    LastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    Licenses []string

    Any applicable license URI.

    Name 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 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 string

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

    PulumiLabels map[string]string

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

    Region string

    A reference to the region where the disk resides.

    ReplicaZones []string

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


    SelfLink string

    The URI of the created resource.

    Size 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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    SourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    SourceDiskId 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 RegionDiskSourceSnapshotEncryptionKeyArgs

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

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

    Users []string

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

    asyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

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

    diskEncryptionKey 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 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 List<RegionDiskGuestOsFeature>

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

    interface_ String

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    labelFingerprint String

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

    labels 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 String

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp String

    Last detach timestamp in RFC3339 text format.

    licenses List<String>

    Any applicable license URI.

    name 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 Integer

    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 String

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

    pulumiLabels Map<String,String>

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

    region String

    A reference to the region where the disk resides.

    replicaZones List<String>

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


    selfLink String

    The URI of the created resource.

    size Integer

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceDiskId 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 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 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 String

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

    users List<String>

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

    asyncPrimaryDisk RegionDiskAsyncPrimaryDisk

    A nested object resource Structure is documented below.

    creationTimestamp string

    Creation timestamp in RFC3339 text format.

    description string

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

    diskEncryptionKey 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 {[key: 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 RegionDiskGuestOsFeature[]

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

    interface string

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    labelFingerprint string

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

    labels {[key: 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 string

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp string

    Last detach timestamp in RFC3339 text format.

    licenses string[]

    Any applicable license URI.

    name 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 number

    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 string

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

    pulumiLabels {[key: string]: string}

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

    region string

    A reference to the region where the disk resides.

    replicaZones string[]

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


    selfLink string

    The URI of the created resource.

    size number

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceDiskId 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 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 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 string

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

    users string[]

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

    async_primary_disk RegionDiskAsyncPrimaryDiskArgs

    A nested object resource Structure is documented below.

    creation_timestamp str

    Creation timestamp in RFC3339 text format.

    description str

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

    disk_encryption_key RegionDiskDiskEncryptionKeyArgs

    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.

    effective_labels Mapping[str, str]

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

    guest_os_features Sequence[RegionDiskGuestOsFeatureArgs]

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

    interface str

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    label_fingerprint str

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

    labels Mapping[str, str]

    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.

    last_attach_timestamp str

    Last attach timestamp in RFC3339 text format.

    last_detach_timestamp str

    Last detach timestamp in RFC3339 text format.

    licenses Sequence[str]

    Any applicable license URI.

    name str

    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.

    physical_block_size_bytes 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 str

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

    pulumi_labels Mapping[str, str]

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

    region str

    A reference to the region where the disk resides.

    replica_zones Sequence[str]

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


    self_link str

    The URI of the created resource.

    size 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 str

    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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    source_disk str

    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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    source_disk_id str

    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.

    source_snapshot_encryption_key RegionDiskSourceSnapshotEncryptionKeyArgs

    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.

    source_snapshot_id str

    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 str

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

    users Sequence[str]

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

    asyncPrimaryDisk Property Map

    A nested object resource Structure is documented below.

    creationTimestamp String

    Creation timestamp in RFC3339 text format.

    description String

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

    diskEncryptionKey Property Map

    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 Map<String>

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

    guestOsFeatures List<Property Map>

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

    interface String

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

    Warning: interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    Deprecated:

    interface is deprecated and will be removed in a future major release. This field is no longer used and can be safely removed from your configurations; disk interfaces are automatically determined on attachment.

    labelFingerprint String

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

    labels Map<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 String

    Last attach timestamp in RFC3339 text format.

    lastDetachTimestamp String

    Last detach timestamp in RFC3339 text format.

    licenses List<String>

    Any applicable license URI.

    name 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 Number

    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 String

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

    pulumiLabels Map<String>

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

    region String

    A reference to the region where the disk resides.

    replicaZones List<String>

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


    selfLink String

    The URI of the created resource.

    size Number

    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 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: * 'https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot' * 'projects/project/global/snapshots/snapshot' * 'global/snapshots/snapshot' * 'snapshot'

    sourceDisk 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:

    • https://www.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks/{disk}
    • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/disks/{disk}
    • projects/{project}/zones/{zone}/disks/{disk}
    • projects/{project}/regions/{region}/disks/{disk}
    • zones/{zone}/disks/{disk}
    • regions/{region}/disks/{disk}
    sourceDiskId 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 Property Map

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

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

    users List<String>

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

    Supporting Types

    RegionDiskAsyncPrimaryDisk, RegionDiskAsyncPrimaryDiskArgs

    Disk string

    Primary disk for asynchronous disk replication.

    Disk string

    Primary disk for asynchronous disk replication.

    disk String

    Primary disk for asynchronous disk replication.

    disk string

    Primary disk for asynchronous disk replication.

    disk str

    Primary disk for asynchronous disk replication.

    disk String

    Primary disk for asynchronous disk replication.

    RegionDiskDiskEncryptionKey, RegionDiskDiskEncryptionKeyArgs

    KmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    RawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    Sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    KmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    RawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    Sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName String

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey String

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    sha256 String

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kms_key_name str

    The name of the encryption key that is stored in Google Cloud KMS.

    raw_key str

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    sha256 str

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName String

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey String

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. Note: This property is sensitive and will not be displayed in the plan.

    sha256 String

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    RegionDiskGuestOsFeature, RegionDiskGuestOsFeatureArgs

    Type string

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    Type string

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    type String

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    type string

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    type str

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    type String

    The type of supported feature. Read Enabling guest operating system features to see a list of available options. Possible values are: MULTI_IP_SUBNET, SECURE_BOOT, SEV_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS, GVNIC, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, SUSPEND_RESUME_COMPATIBLE, TDX_CAPABLE.

    RegionDiskSourceSnapshotEncryptionKey, RegionDiskSourceSnapshotEncryptionKeyArgs

    KmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    RawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    Sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    KmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    RawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    Sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName String

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey String

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    sha256 String

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName string

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey string

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    sha256 string

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kms_key_name str

    The name of the encryption key that is stored in Google Cloud KMS.

    raw_key str

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    sha256 str

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyName String

    The name of the encryption key that is stored in Google Cloud KMS.

    rawKey String

    Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

    sha256 String

    (Output) The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    Import

    RegionDisk can be imported using any of these accepted formats* projects/{{project}}/regions/{{region}}/disks/{{name}} * {{project}}/{{region}}/{{name}} * {{region}}/{{name}} * {{name}} In Terraform v1.5.0 and later, use an import block to import RegionDisk using one of the formats above. For exampletf import {

    id = “projects/{{project}}/regions/{{region}}/disks/{{name}}”

    to = google_compute_region_disk.default }

     $ pulumi import gcp:compute/regionDisk:RegionDisk When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), 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}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v7.2.2 published on Monday, Jan 1, 0001 by Pulumi