gcp_compute_disk

ancestors

Type: UNORDERED_LIST_STRING

architecture

Type: STRING
Provider name: architecture
Description: The architecture of the disk. Valid values are ARM64 or X86_64.
Possible values:

• ARCHITECTURE_UNSPECIFIED - Default value indicating Architecture is not set.
  
• ARM64 - Machines with architecture ARM64
  
• X86_64 - Machines with architecture X86_64
  

async_primary_disk

Type: STRUCT
Provider name: asyncPrimaryDisk
Description: Disk asynchronously replicated into this disk.

• consistency_group_policy
  Type: STRING
  Provider name: consistencyGroupPolicy
  Description: [Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.
  
• consistency_group_policy_id
  Type: STRING
  Provider name: consistencyGroupPolicyId
  Description: [Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.
  
• disk
  Type: STRING
  Provider name: disk
  Description: The other disk asynchronously replicated to or from the current 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 - projects/project/zones/zone/disks/disk - zones/zone/disks/disk
  
• disk_id
  Type: STRING
  Provider name: diskId
  Description: [Output Only] The unique ID of the other disk asynchronously replicated to or from the current disk. This value identifies the exact disk that was used to create this replication. For example, if you started replicating the persistent disk from a disk that was later deleted and recreated under the same name, the disk ID would identify the exact version of the disk that was used.
  

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

disk_encryption_key

Type: STRUCT
Provider name: diskEncryptionKey
Description: Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: “diskEncryptionKey.kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don’t need to provide a key to use the disk later.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  
• kms_key_service_account
  Type: STRING
  Provider name: kmsKeyServiceAccount
  Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  
• raw_key
  Type: STRING
  Provider name: rawKey
  Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  
• rsa_encrypted_key
  Type: STRING
  Provider name: rsaEncryptedKey
  Description: 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. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  
• sha256
  Type: STRING
  Provider name: sha256
  Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
  

gcp_status

Type: STRING
Provider name: status
Description: [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 - Disk is provisioning
  
• DELETING - Disk is deleting.
  
• FAILED - Disk creation failed.
  
• READY - Disk is ready for use.
  
• RESTORING - Source data is being copied into the disk.
  

guest_os_features

Type: UNORDERED_LIST_STRUCT
Provider name: guestOsFeatures
Description: A 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.

• type
  Type: STRING
  Provider name: type
  Description: The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE - SEV_SNP_CAPABLE For more information, see Enabling guest operating system features.
  Possible values:
  
  • FEATURE_TYPE_UNSPECIFIED
  • GVNIC
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • SEV_CAPABLE
  • SEV_LIVE_MIGRATABLE
  • SEV_SNP_CAPABLE
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind

Type: STRING
Provider name: kind
Description: [Output Only] Type of the resource. Always compute#disk for disks.

labels

Type: UNORDERED_LIST_STRING

last_attach_timestamp

Type: STRING
Provider name: lastAttachTimestamp
Description: [Output Only] Last attach timestamp in RFC3339 text format.

last_detach_timestamp

Type: STRING
Provider name: lastDetachTimestamp
Description: [Output Only] Last detach timestamp in RFC3339 text format.

license_codes

Type: UNORDERED_LIST_STRING
Provider name: licenseCodes
Description: Integer license codes indicating which licenses are attached to this disk.

licenses

Type: UNORDERED_LIST_STRING
Provider name: licenses
Description: A list of publicly visible licenses. Reserved for Google’s use.

location_hint

Type: STRING
Provider name: locationHint
Description: An 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.

name

Type: STRING
Provider name: name
Description: 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]([-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.

options

Type: STRING
Provider name: options
Description: Internal use only.

organization_id

Type: STRING

params

Type: STRUCT
Provider name: params
Description: Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

parent

Type: STRING

physical_block_size_bytes

Type: INT64
Provider name: physicalBlockSizeBytes
Description: Physical 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_id

Type: STRING

project_number

Type: STRING

provisioned_iops

Type: INT64
Provider name: provisionedIops
Description: Indicates 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_throughput

Type: INT64
Provider name: provisionedThroughput
Description: Indicates 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 between 1 and 7,124.

region

Type: STRING
Provider name: region
Description: [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_zones

Type: UNORDERED_LIST_STRING
Provider name: replicaZones
Description: URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

resource_name

Type: STRING

resource_policies

Type: UNORDERED_LIST_STRING
Provider name: resourcePolicies
Description: Resource policies applied to this disk for automatic snapshot creations.

resource_status

Type: STRUCT
Provider name: resourceStatus
Description: [Output Only] Status information for the disk resource.

• async_primary_disk
  Type: STRUCT
  Provider name: asyncPrimaryDisk
  
  • state
    Type: STRING
    Provider name: state
    

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output Only] Reserved for future use.

self_link

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined fully-qualified URL for this resource.

size_gb

Type: INT64
Provider name: sizeGb
Description: Size, 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 1 to 65536, inclusive.

source_consistency_group_policy

Type: STRING
Provider name: sourceConsistencyGroupPolicy
Description: [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

source_consistency_group_policy_id

Type: STRING
Provider name: sourceConsistencyGroupPolicyId
Description: [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

source_disk

Type: STRING
Provider name: sourceDisk
Description: 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

Type: STRING
Provider name: sourceDiskId
Description: [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_image

Type: STRING
Provider name: sourceImage
Description: The 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_encryption_key

Type: STRUCT
Provider name: sourceImageEncryptionKey
Description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  
• kms_key_service_account
  Type: STRING
  Provider name: kmsKeyServiceAccount
  Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  
• raw_key
  Type: STRING
  Provider name: rawKey
  Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  
• rsa_encrypted_key
  Type: STRING
  Provider name: rsaEncryptedKey
  Description: 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. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  
• sha256
  Type: STRING
  Provider name: sha256
  Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
  

source_image_id

Type: STRING
Provider name: sourceImageId
Description: [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_snapshot

Type: STRING
Provider name: sourceSnapshot
Description: 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

source_snapshot_encryption_key

Type: STRUCT
Provider name: sourceSnapshotEncryptionKey
Description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
  
• kms_key_service_account
  Type: STRING
  Provider name: kmsKeyServiceAccount
  Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
  
• raw_key
  Type: STRING
  Provider name: rawKey
  Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
  
• rsa_encrypted_key
  Type: STRING
  Provider name: rsaEncryptedKey
  Description: 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. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
  
• sha256
  Type: STRING
  Provider name: sha256
  Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
  

source_snapshot_id

Type: STRING
Provider name: sourceSnapshotId
Description: [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_object

Type: STRING
Provider name: sourceStorageObject
Description: The 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.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: URL 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.

users

Type: UNORDERED_LIST_STRING
Provider name: users
Description: [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

zone

Type: STRING
Provider name: zone
Description: [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.