AttachedDiskArgs

data class AttachedDiskArgs(val autoDelete: Output<Boolean>? = null, val boot: Output<Boolean>? = null, val deviceName: Output<String>? = null, val diskEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, val diskSizeGb: Output<String>? = null, val forceAttach: Output<Boolean>? = null, val guestOsFeatures: Output<List<GuestOsFeatureArgs>>? = null, val initializeParams: Output<AttachedDiskInitializeParamsArgs>? = null, val interface: Output<AttachedDiskInterface>? = null, val mode: Output<AttachedDiskMode>? = null, val savedState: Output<AttachedDiskSavedState>? = null, val source: Output<String>? = null, val type: Output<AttachedDiskType>? = null) : ConvertibleToJava<AttachedDiskArgs>

An instance-attached disk resource.

Constructors

Link copied to clipboard
fun AttachedDiskArgs(autoDelete: Output<Boolean>? = null, boot: Output<Boolean>? = null, deviceName: Output<String>? = null, diskEncryptionKey: Output<CustomerEncryptionKeyArgs>? = null, diskSizeGb: Output<String>? = null, forceAttach: Output<Boolean>? = null, guestOsFeatures: Output<List<GuestOsFeatureArgs>>? = null, initializeParams: Output<AttachedDiskInitializeParamsArgs>? = null, interface: Output<AttachedDiskInterface>? = null, mode: Output<AttachedDiskMode>? = null, savedState: Output<AttachedDiskSavedState>? = null, source: Output<String>? = null, type: Output<AttachedDiskType>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AttachedDiskArgs

Properties

Link copied to clipboard
val autoDelete: Output<Boolean>? = null

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Link copied to clipboard
val boot: Output<Boolean>? = null

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Link copied to clipboard
val deviceName: Output<String>? = null

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.

Link copied to clipboard

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.

Link copied to clipboard
val diskSizeGb: Output<String>? = null

The size of the disk in GB.

Link copied to clipboard
val forceAttach: Output<Boolean>? = null

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val interface: Output<AttachedDiskInterface>? = null

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.

Link copied to clipboard
val mode: Output<AttachedDiskMode>? = null

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.

Link copied to clipboard
val savedState: Output<AttachedDiskSavedState>? = null

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.

Link copied to clipboard
val source: Output<String>? = null

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.

Link copied to clipboard
val type: Output<AttachedDiskType>? = null

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