bool
Specifies whether the disk will be
auto-deleted when the instance is deleted (but
not when the disk is detached from the
instance).
This field is a member of oneof_ _auto_delete.
custom_image
str
The custom source image to be used to restore
this disk when instantiating this instance
template.
This field is a member of oneof_ _custom_image.
device_name
str
Specifies the device name of the disk to
which the configurations apply to.
This field is a member of oneof_ _device_name.
instantiate_from
str
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. Check the InstantiateFrom enum
for the list of possible values.
This field is a member of oneof_ _instantiate_from.
Classes
InstantiateFrom
InstantiateFrom(value)
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.
[[["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 DiskInstantiationConfig (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)\n- [1.34.0](/python/docs/reference/compute/1.34.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.33.0](/python/docs/reference/compute/1.33.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.32.0](/python/docs/reference/compute/1.32.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.31.0](/python/docs/reference/compute/1.31.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.30.0](/python/docs/reference/compute/1.30.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.29.0](/python/docs/reference/compute/1.29.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.28.0](/python/docs/reference/compute/1.28.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.27.0](/python/docs/reference/compute/1.27.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.26.0](/python/docs/reference/compute/1.26.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.25.0](/python/docs/reference/compute/1.25.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.24.0](/python/docs/reference/compute/1.24.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.23.0](/python/docs/reference/compute/1.23.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.22.0](/python/docs/reference/compute/1.22.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.21.0](/python/docs/reference/compute/1.21.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.20.1](/python/docs/reference/compute/1.20.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.19.2](/python/docs/reference/compute/1.19.2/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.18.0](/python/docs/reference/compute/1.18.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.17.0](/python/docs/reference/compute/1.17.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.16.1](/python/docs/reference/compute/1.16.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.15.0](/python/docs/reference/compute/1.15.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.14.1](/python/docs/reference/compute/1.14.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.13.0](/python/docs/reference/compute/1.13.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.12.1](/python/docs/reference/compute/1.12.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.11.0](/python/docs/reference/compute/1.11.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.10.1](/python/docs/reference/compute/1.10.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.9.0](/python/docs/reference/compute/1.9.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.8.0](/python/docs/reference/compute/1.8.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.7.0](/python/docs/reference/compute/1.7.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.6.1](/python/docs/reference/compute/1.6.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.5.2](/python/docs/reference/compute/1.5.2/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.4.0](/python/docs/reference/compute/1.4.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.3.2](/python/docs/reference/compute/1.3.2/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.2.0](/python/docs/reference/compute/1.2.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.1.0](/python/docs/reference/compute/1.1.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [1.0.0](/python/docs/reference/compute/1.0.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.9.0](/python/docs/reference/compute/0.9.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.8.0](/python/docs/reference/compute/0.8.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.7.0](/python/docs/reference/compute/0.7.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.6.0](/python/docs/reference/compute/0.6.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.5.0](/python/docs/reference/compute/0.5.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.4.2](/python/docs/reference/compute/0.4.2/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.3.0](/python/docs/reference/compute/0.3.0/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.2.1](/python/docs/reference/compute/0.2.1/google.cloud.compute_v1.types.DiskInstantiationConfig)\n- [0.1.0](/python/docs/reference/compute/0.1.0/google.cloud.compute_v1.types.DiskInstantiationConfig) \n\n DiskInstantiationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA specification of the desired way to instantiate a disk in\nthe instance template when its created from a source instance.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### 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."]]
