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.
Enums
Name
Description
UNDEFINED_INSTANTIATE_FROM
A value indicating that the enum field is not set.
ATTACH_READ_ONLY
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
Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.
CUSTOM_IMAGE
Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.
DEFAULT
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
Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.
SOURCE_IMAGE
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
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-11 UTC."],[],[],null,["# Class InstantiateFrom (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/python/docs/reference/compute/latest/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.34.0](/python/docs/reference/compute/1.34.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.33.0](/python/docs/reference/compute/1.33.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.32.0](/python/docs/reference/compute/1.32.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.31.0](/python/docs/reference/compute/1.31.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.30.0](/python/docs/reference/compute/1.30.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.29.0](/python/docs/reference/compute/1.29.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.28.0](/python/docs/reference/compute/1.28.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.27.0](/python/docs/reference/compute/1.27.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.26.0](/python/docs/reference/compute/1.26.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.25.0](/python/docs/reference/compute/1.25.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.24.0](/python/docs/reference/compute/1.24.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.23.0](/python/docs/reference/compute/1.23.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.22.0](/python/docs/reference/compute/1.22.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.21.0](/python/docs/reference/compute/1.21.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.20.1](/python/docs/reference/compute/1.20.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.19.2](/python/docs/reference/compute/1.19.2/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.18.0](/python/docs/reference/compute/1.18.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.17.0](/python/docs/reference/compute/1.17.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.16.1](/python/docs/reference/compute/1.16.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.15.0](/python/docs/reference/compute/1.15.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.14.1](/python/docs/reference/compute/1.14.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.13.0](/python/docs/reference/compute/1.13.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.12.1](/python/docs/reference/compute/1.12.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.11.0](/python/docs/reference/compute/1.11.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.10.1](/python/docs/reference/compute/1.10.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.9.0](/python/docs/reference/compute/1.9.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.8.0](/python/docs/reference/compute/1.8.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.7.0](/python/docs/reference/compute/1.7.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.6.1](/python/docs/reference/compute/1.6.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.5.2](/python/docs/reference/compute/1.5.2/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.4.0](/python/docs/reference/compute/1.4.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.3.2](/python/docs/reference/compute/1.3.2/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.2.0](/python/docs/reference/compute/1.2.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.1.0](/python/docs/reference/compute/1.1.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [1.0.0](/python/docs/reference/compute/1.0.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.9.0](/python/docs/reference/compute/0.9.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.8.0](/python/docs/reference/compute/0.8.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.7.0](/python/docs/reference/compute/0.7.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.6.0](/python/docs/reference/compute/0.6.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.5.0](/python/docs/reference/compute/0.5.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.4.2](/python/docs/reference/compute/0.4.2/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.3.0](/python/docs/reference/compute/0.3.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.2.1](/python/docs/reference/compute/0.2.1/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom)\n- [0.1.0](/python/docs/reference/compute/0.1.0/google.cloud.compute_v1.types.DiskInstantiationConfig.InstantiateFrom) \n\n InstantiateFrom(value)\n\nSpecifies whether to include the disk and what image to use.\nPossible values are: - source-image: to use the same image that\nwas used to create the source instance's corresponding disk.\nApplicable to the boot disk and additional read-write disks. -\nsource-image-family: to use the same image family that was used\nto create the source instance's corresponding disk. Applicable\nto the boot disk and additional read-write disks. -\ncustom-image: to use a user-provided image url for disk\ncreation. Applicable to the boot disk and additional read-write\ndisks. - attach-read-only: to attach a read-only disk.\nApplicable to read-only disks. - do-not-include: to exclude a\ndisk from the template. Applicable to additional read-write\ndisks, local SSDs, and read-only disks."]]