Attach Disk

Attaches an existing Disk resource to an instance

39 variables
32 variables

Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources

Input

This building block consumes 39 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

zone STRING Required

The name of the zone for this request

instance STRING Required

The instance name for this request

forceAttach BOOLEAN

Whether to force attach the disk even if it's currently attached to another instance

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

autoDelete BOOLEAN

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)

boot BOOLEAN

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem

deviceName STRING

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks

diskEncryptionKey OBJECT

Represents a customer-supplied encryption key

diskEncryptionKey.kmsKeyName STRING

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

diskEncryptionKey.rawKey STRING

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

diskEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

guestOsFeatures[] OBJECT

Guest OS features

guestOsFeatures[].type ENUMERATION

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options

index INTEGER

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number

initializeParams OBJECT

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both

initializeParams.description STRING

An optional description. Provide this property when creating the disk

initializeParams.diskName STRING

Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated

initializeParams.diskSizeGb INTEGER

Specifies the size of the disk in base-2 GB

initializeParams.diskType STRING

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
  • projects/project/zones/zone/diskTypes/diskType
  • zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

initializeParams.labels OBJECT

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

initializeParams.labels.customKey.value STRING Required

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

initializeParams.resourcePolicies[] STRING

initializeParams.sourceImage STRING

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

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

If the source image is deleted later, this field will not be set

initializeParams.sourceImageEncryptionKey OBJECT

Represents a customer-supplied encryption key

initializeParams.sourceImageEncryptionKey.kmsKeyName STRING

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

initializeParams.sourceImageEncryptionKey.rawKey STRING

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

initializeParams.sourceImageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

initializeParams.sourceSnapshot STRING

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD.

To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup

If the source snapshot is deleted later, this field will not be set

initializeParams.sourceSnapshotEncryptionKey OBJECT

Represents a customer-supplied encryption key

initializeParams.sourceSnapshotEncryptionKey.kmsKeyName STRING

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

initializeParams.sourceSnapshotEncryptionKey.rawKey STRING

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

initializeParams.sourceSnapshotEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

interface ENUMERATION

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817): Update documentation when NVME is supported

kind STRING

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks

licenses[] STRING

mode ENUMERATION

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode

source STRING

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk

type ENUMERATION

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT

Output

This building block provides 32 output parameters

  = Parameter name
  = Format

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

warnings[].code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warnings[].data[] OBJECT

warnings[].data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warnings[].data[].value STRING

[Output Only] A warning data value corresponding to the key

warnings[].message STRING

[Output Only] A human-readable description of the warning code

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations