Class AttachedDisk (1.12.1)

Version 1.12.1

• 1.23.0 (latest)
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

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

An instance-attached disk resource.

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

Attributes
Name	Description
architecture	str [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values. This field is a member of oneof_ _architecture.
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.
boot	bool Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. This field is a member of oneof_ _boot.
device_name	str 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. This field is a member of oneof_ _device_name.
disk_encryption_key	google.cloud.compute_v1.types.CustomerEncryptionKey Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. This field is a member of oneof_ _disk_encryption_key.
disk_size_gb	int The size of the disk in GB. This field is a member of oneof_ _disk_size_gb.
force_attach	bool [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. This field is a member of oneof_ _force_attach.
guest_os_features	MutableSequence[google.cloud.compute_v1.types.GuestOsFeature] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
index	int [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. This field is a member of oneof_ _index.
initialize_params	google.cloud.compute_v1.types.AttachedDiskInitializeParams [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. This field is a member of oneof_ _initialize_params.
interface	str Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks. Check the Interface enum for the list of possible values. This field is a member of oneof_ _interface.
kind	str [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. This field is a member of oneof_ _kind.
licenses	MutableSequence[str] [Output Only] Any valid publicly visible licenses.
mode	str 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. Check the Mode enum for the list of possible values. This field is a member of oneof_ _mode.
saved_state	str For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. Check the SavedState enum for the list of possible values. This field is a member of oneof_ _saved_state.
shielded_instance_initial_state	google.cloud.compute_v1.types.InitialStateConfig [Output Only] shielded vm initial state stored on disk This field is a member of oneof_ _shielded_instance_initial_state.
source	str Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot 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 for zonal disk, and the URL for regional disk. This field is a member of oneof_ _source.
type_	str Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values. This field is a member of oneof_ _type.

Classes

Architecture

Architecture(value)

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.

Values: UNDEFINED_ARCHITECTURE (0): A value indicating that the enum field is not set. ARCHITECTURE_UNSPECIFIED (394750507): Default value indicating Architecture is not set. ARM64 (62547450): Machines with architecture ARM64 X86_64 (425300551): Machines with architecture X86_64

Interface

Interface(value)

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.

Values: UNDEFINED_INTERFACE (0): A value indicating that the enum field is not set. NVME (2408800): No description available. SCSI (2539686): No description available.

Mode

Mode(value)

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.

Values: UNDEFINED_MODE (0): A value indicating that the enum field is not set. READ_ONLY (91950261): Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time. READ_WRITE (173607894): [Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.

SavedState

SavedState(value)

For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

Values: UNDEFINED_SAVED_STATE (0): A value indicating that the enum field is not set. DISK_SAVED_STATE_UNSPECIFIED (391290831): [Default] Disk state has not been preserved. PRESERVED (254159736): Disk state has been preserved.

Type

Type(value)

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

Values: UNDEFINED_TYPE (0): A value indicating that the enum field is not set. PERSISTENT (460683927): No description available. SCRATCH (496778970): No description available.