Skip to content

googleComputeDisk

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD).

Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements.

Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

To get more information about Disk, see:

\~> Warning: All arguments including diskEncryptionKeyRawKey and diskEncryptionKeyRsaEncryptedKey will be stored in the raw state as plain-text. Read more about sensitive data in state.

Open in Cloud Shell

Example Usage - Disk Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.computeDisk.ComputeDisk(this, "default", {
  image: "debian-11-bullseye-v20220719",
  labels: [
    {
      environment: "dev",
    },
  ],
  name: "test-disk",
  physical_block_size_bytes: 4096,
  type: "pd-ssd",
  zone: "us-central1-a",
});

Argument Reference

The following arguments are supported:

  • name - (Required) 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 [aZ]([AZ09]*[aZ09])? 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.

  • description - (Optional) An optional description of this resource. Provide this property when you create the resource.

  • labels - (Optional) Labels to apply to this disk. A list of key->value pairs.

  • size - (Optional) Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the image or snapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with image or snapshot, the value must not be less than the size of the image or the size of the snapshot. \~>NOTE If you change the size, Terraform updates the disk size if upsizing is detected but recreates the disk if downsizing is requested. You can add lifecyclePreventDestroy in the config to prevent destroying and recreating.

  • physicalBlockSizeBytes - (Optional) 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.

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

  • sourceDisk - (Optional) 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}

  • type - (Optional) URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.

  • image - (Optional) The image from which to initialize this disk. This can be one of: the image's selfLink, projects/{project}/global/images/{image}, projects/{project}/global/images/family/{family}, global/images/{image}, global/images/family/{family}, family/{family}, {project}/{family}, {project}/{image}, {family}, or {image}. If referred by family, the images names must include the family name. If they don't, use the google_compute_image data source. For instance, the image centos6V20180104 includes its family name centos6. These images can be referred by family name here.

  • resourcePolicies - (Optional, Beta) Resource policies applied to this disk for automatic snapshot creations. \~>NOTE This value does not support updating the resource policy, as resource policies can not be updated more than one at a time. Use googleComputeDiskResourcePolicyAttachment to allow for updating the resource policy attached to the disk.

  • multiWriter - (Optional, Beta) Indicates whether or not the disk can be read/write attached to more than one instance.

  • provisionedIops - (Optional) Indicates how many IOPS must be provisioned for the disk.

  • zone - (Optional) A reference to the zone where the disk resides.

  • sourceImageEncryptionKey - (Optional) The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Structure is documented below.

  • diskEncryptionKey - (Optional) 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.

  • snapshot - (Optional) The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. If the snapshot is in another project than this disk, you must supply a full URL. For example, the following are valid values:

    • https://wwwGoogleapisCom/compute/v1/projects/project/global/snapshots/snapshot
    • projects/project/global/snapshots/snapshot
    • global/snapshots/snapshot
    • snapshot

  • sourceSnapshotEncryptionKey - (Optional) 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.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The sourceImageEncryptionKey block supports:

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

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

  • kmsKeySelfLink - (Optional) The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account (service-{{projectNumber}}@computeSystemIamGserviceaccountCom) must have roles/cloudkmsCryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

  • kmsKeyServiceAccount - (Optional) The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.

The diskEncryptionKey block supports:

  • rawKey - (Optional) 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.

  • rsaEncryptedKey - (Optional) Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. Note: This property is sensitive and will not be displayed in the plan.

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

  • kmsKeySelfLink - (Optional) The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account (service-{{projectNumber}}@computeSystemIamGserviceaccountCom) must have roles/cloudkmsCryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

  • kmsKeyServiceAccount - (Optional) The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.

The sourceSnapshotEncryptionKey block supports:

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

  • kmsKeySelfLink - (Optional) The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project's Compute Engine System service account (service-{{projectNumber}}@computeSystemIamGserviceaccountCom) must have roles/cloudkmsCryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

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

  • kmsKeyServiceAccount - (Optional) The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/zones/{{zone}}/disks/{{name}}

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

  • creationTimestamp - Creation timestamp in RFC3339 text format.

  • lastAttachTimestamp - Last attach timestamp in RFC3339 text format.

  • lastDetachTimestamp - Last detach timestamp in RFC3339 text format.

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

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

  • sourceImageId - The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

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

  • selfLink - The URI of the created resource.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

Disk can be imported using any of these accepted formats:

$ terraform import google_compute_disk.default projects/{{project}}/zones/{{zone}}/disks/{{name}}
$ terraform import google_compute_disk.default {{project}}/{{zone}}/{{name}}
$ terraform import google_compute_disk.default {{zone}}/{{name}}
$ terraform import google_compute_disk.default {{name}}

User Project Overrides

This resource supports User Project Overrides.