Class DiskInstantiationConfig (1.13.0)

DiskInstantiationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
auto_delete 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.

Values: UNDEFINED_INSTANTIATE_FROM (0): A value indicating that the enum field is not set. ATTACH_READ_ONLY (513775419): 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 (63281460): Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs. CUSTOM_IMAGE (196311789): Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks. DEFAULT (115302945): 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 (104218952): Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks. SOURCE_IMAGE (62631959): 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 (76850316): 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.