Persistent Disk

Persistent Disk in Google Cloud is a durable block storage option for virtual machine instances. It provides high-performance, reliable storage that can be attached to and detached from VM instances as needed. Persistent Disks are automatically encrypted, can be resized without downtime, and support both standard and SSD-backed options to balance cost and performance. They are designed for workloads requiring consistent availability and data durability.

gcp.compute_disk

Fields

TitleIDTypeData TypeDescription
_keycorestring
access_modecorestringThe access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types.
ancestorscorearray<string>
architecturecorestringThe architecture of the disk. Valid values are ARM64 or X86_64.
async_primary_diskcorejsonDisk asynchronously replicated into this disk.
creation_timestampcoretimestamp[Output Only] Creation timestamp in RFC3339 text format.
datadog_display_namecorestring
descriptioncorestringAn optional description of this resource. Provide this property when you create the resource.
enable_confidential_computecoreboolWhether this disk is using confidential compute mode.
gcp_statuscorestring[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Possible values: ['CREATING', 'DELETING', 'FAILED', 'READY', 'RESTORING', 'UNAVAILABLE']. Values descriptions: ['Disk is provisioning', 'Disk is deleting.', 'Disk creation failed.', 'Disk is ready for use.', 'Source data is being copied into the disk.', 'Disk is currently unavailable and cannot be accessed, attached or detached.']
guest_os_featurescorejsonA list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
idcorestring[Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindcorestring[Output Only] Type of the resource. Always compute#disk for disks.
labelscorearray<string>Labels to apply to this disk. These can be later modified by the setLabels method.
last_attach_timestampcorestring[Output Only] Last attach timestamp in RFC3339 text format.
last_detach_timestampcorestring[Output Only] Last detach timestamp in RFC3339 text format.
license_codescorearray<string>Integer license codes indicating which licenses are attached to this disk.
licensescorearray<string>A list of publicly visible licenses. Reserved for Google's use.
location_hintcorestringAn opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
namecorestringName 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]([-a-z0-9]*[a-z0-9])?` 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.
optionscorestringInternal use only.
organization_idcorestring
paramscorejsonInput only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
parentcorestring
physical_block_size_bytescoreint64Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, 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_idcorestring
project_numbercorestring
provisioned_iopscoreint64Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
provisioned_throughputcoreint64Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.
regioncorestring[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
replica_zonescorearray<string>URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
resource_namecorestring
resource_policiescorearray<string>Resource policies applied to this disk for automatic snapshot creations.
resource_statuscorejson[Output Only] Status information for the disk resource.
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscorebool[Output Only] Reserved for future use.
self_linkcorestring[Output Only] Server-defined fully-qualified URL for this resource.
size_gbcoreint64Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.
source_consistency_group_policycorestring[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
source_consistency_group_policy_idcorestring[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
source_diskcorestringThe 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_idcorestring[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
source_imagecorestringThe source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family
source_image_idcorestring[Output Only] 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.
source_instant_snapshotcorestringThe source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
source_instant_snapshot_idcorestring[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
source_snapshotcorestringThe 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
source_snapshot_idcorestring[Output Only] 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.
source_storage_objectcorestringThe full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
storage_poolcorestringThe storage pool in which the new disk is created. 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 /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool
tagscorehstore
typecorestringURL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
userscorearray<string>[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
zonecorestring[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.