Reference documentation and code samples for the Google Cloud Compute V1 API module Google::Cloud::Compute::V1::DiskInstantiationConfig::InstantiateFrom.
Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.
Constants
UNDEFINED_INSTANTIATE_FROM
value: 0 A value indicating that the enum field is not set.
ATTACH_READ_ONLY
value: 513_775_419 Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.
BLANK
value: 63_281_460 Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.
CUSTOM_IMAGE
value: 196_311_789 Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.
DEFAULT
value: 115_302_945 Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
DO_NOT_INCLUDE
value: 104_218_952 Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.
SOURCE_IMAGE
value: 62_631_959 Use the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.
SOURCE_IMAGE_FAMILY
value: 76_850_316 Use the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["# Google Cloud Compute V1 API - Module Google::Cloud::Compute::V1::DiskInstantiationConfig::InstantiateFrom (v3.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.0.0 (latest)](/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.22.0](/ruby/docs/reference/google-cloud-compute-v1/2.22.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.21.1](/ruby/docs/reference/google-cloud-compute-v1/2.21.1/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.20.0](/ruby/docs/reference/google-cloud-compute-v1/2.20.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.19.1](/ruby/docs/reference/google-cloud-compute-v1/2.19.1/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.18.0](/ruby/docs/reference/google-cloud-compute-v1/2.18.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.17.0](/ruby/docs/reference/google-cloud-compute-v1/2.17.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.16.0](/ruby/docs/reference/google-cloud-compute-v1/2.16.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.15.0](/ruby/docs/reference/google-cloud-compute-v1/2.15.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.14.0](/ruby/docs/reference/google-cloud-compute-v1/2.14.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.13.0](/ruby/docs/reference/google-cloud-compute-v1/2.13.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.12.0](/ruby/docs/reference/google-cloud-compute-v1/2.12.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.11.0](/ruby/docs/reference/google-cloud-compute-v1/2.11.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.10.0](/ruby/docs/reference/google-cloud-compute-v1/2.10.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.9.0](/ruby/docs/reference/google-cloud-compute-v1/2.9.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.8.0](/ruby/docs/reference/google-cloud-compute-v1/2.8.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.7.2](/ruby/docs/reference/google-cloud-compute-v1/2.7.2/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.6.0](/ruby/docs/reference/google-cloud-compute-v1/2.6.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.5.0](/ruby/docs/reference/google-cloud-compute-v1/2.5.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.4.0](/ruby/docs/reference/google-cloud-compute-v1/2.4.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.3.0](/ruby/docs/reference/google-cloud-compute-v1/2.3.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.2.0](/ruby/docs/reference/google-cloud-compute-v1/2.2.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.1.0](/ruby/docs/reference/google-cloud-compute-v1/2.1.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [2.0.0](/ruby/docs/reference/google-cloud-compute-v1/2.0.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.10.0](/ruby/docs/reference/google-cloud-compute-v1/1.10.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.9.0](/ruby/docs/reference/google-cloud-compute-v1/1.9.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.8.0](/ruby/docs/reference/google-cloud-compute-v1/1.8.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.7.1](/ruby/docs/reference/google-cloud-compute-v1/1.7.1/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.6.0](/ruby/docs/reference/google-cloud-compute-v1/1.6.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.5.0](/ruby/docs/reference/google-cloud-compute-v1/1.5.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.4.0](/ruby/docs/reference/google-cloud-compute-v1/1.4.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.3.0](/ruby/docs/reference/google-cloud-compute-v1/1.3.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.2.0](/ruby/docs/reference/google-cloud-compute-v1/1.2.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.1.0](/ruby/docs/reference/google-cloud-compute-v1/1.1.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [1.0.0](/ruby/docs/reference/google-cloud-compute-v1/1.0.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom)\n- [0.5.0](/ruby/docs/reference/google-cloud-compute-v1/0.5.0/Google-Cloud-Compute-V1-DiskInstantiationConfig-InstantiateFrom) \nReference documentation and code samples for the Google Cloud Compute V1 API module Google::Cloud::Compute::V1::DiskInstantiationConfig::InstantiateFrom.\n\nSpecifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.\n\nConstants\n---------\n\n### UNDEFINED_INSTANTIATE_FROM\n\n**value:** 0 \nA value indicating that the enum field is not set.\n\n### ATTACH_READ_ONLY\n\n**value:** 513_775_419 \nAttach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.\n\n### BLANK\n\n**value:** 63_281_460 \nCreate a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.\n\n### CUSTOM_IMAGE\n\n**value:** 196_311_789 \nUse the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.\n\n### DEFAULT\n\n**value:** 115_302_945 \nUse the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.\n\n### DO_NOT_INCLUDE\n\n**value:** 104_218_952 \nDo not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.\n\n### SOURCE_IMAGE\n\n**value:** 62_631_959 \nUse the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.\n\n### SOURCE_IMAGE_FAMILY\n\n**value:** 76_850_316 \nUse the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks."]]