AttachedDiskResponse class

An instance-attached disk resource.

Constructors

AttachedDiskResponse({required Input<String> architecture, required Input<bool> autoDelete, required Input<bool> boot, required Input<String> deviceName, required Input<CustomerEncryptionKeyResponse> diskEncryptionKey, required Input<String> diskSizeGb, required Input<bool> forceAttach, required Input<List<GuestOsFeatureResponse>> guestOsFeatures, required Input<int> index, required Input<AttachedDiskInitializeParamsResponse> initializeParams, required Input<String> interface, required Input<String> kind, required Input<List<String>> licenses, required Input<bool> locked, required Input<String> mode, required Input<String> savedState, required Input<InitialStateConfigResponse> shieldedInstanceInitialState, required Input<String> source, required Input<String> type, required Input<List<String>> userLicenses})
Creates a new AttachedDiskResponse. architecture The architecture of the attached disk. Valid values are ARM64 or X86_64. autoDelete Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). boot Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. deviceName 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. diskEncryptionKey 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. diskSizeGb The size of the disk in GB. forceAttach 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. guestOsFeatures 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 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. initializeParams 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. interface 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. kind Type of the resource. Always compute#attachedDisk for attached disks. licenses Any valid publicly visible licenses. locked Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. mode 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. savedState 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. shieldedInstanceInitialState shielded vm initial state stored on disk source 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. type Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. userLicenses A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.
const
AttachedDiskResponse.fromMap(Map<String, dynamic> map)
factory

Properties

architecture → Input<String>
The architecture of the attached disk. Valid values are ARM64 or X86_64.
final
autoDelete → Input<bool>
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
final
boot → Input<bool>
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
final
deviceName → Input<String>
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.
final
diskEncryptionKey → Input<CustomerEncryptionKeyResponse>
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.
final
diskSizeGb → Input<String>
The size of the disk in GB.
final
forceAttach → Input<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.
final
guestOsFeatures → Input<List<GuestOsFeatureResponse>>
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.
final
hashCode → int
The hash code for this object.
no setterinherited
index → Input<int>
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.
final
initializeParams → Input<AttachedDiskInitializeParamsResponse>
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.
final
interface → Input<String>
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.
final
kind → Input<String>
Type of the resource. Always compute#attachedDisk for attached disks.
final
licenses → Input<List<String>>
Any valid publicly visible licenses.
final
locked → Input<bool>
Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.
final
mode → Input<String>
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
savedState → Input<String>
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.
final
shieldedInstanceInitialState → Input<InitialStateConfigResponse>
shielded vm initial state stored on disk
final
source → Input<String>
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.
final
type → Input<String>
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
final
userLicenses → Input<List<String>>
A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited