InstanceTemplateDisk class
Constructors
-
InstanceTemplateDisk({Input<String?>? architecture, Input<bool?>? autoDelete, Input<bool?>? boot, Input<String?>? deviceName, Input<InstanceTemplateDiskDiskEncryptionKey?>? diskEncryptionKey, Input<String?>? diskName, Input<int?>? diskSizeGb, Input<String?>? diskType, Input<List<String>?>? guestOsFeatures, Input<String?>? interface, Input<Map<String, String>?>? labels, Input<String?>? mode, Input<int?>? provisionedIops, Input<int?>? provisionedThroughput, Input<Map<String, String>?>? resourceManagerTags, Input<String?>? resourcePolicies, Input<String?>? source, Input<String?>? sourceImage, Input<InstanceTemplateDiskSourceImageEncryptionKey?>? sourceImageEncryptionKey, Input<String?>? sourceSnapshot, Input<InstanceTemplateDiskSourceSnapshotEncryptionKey?>? sourceSnapshotEncryptionKey, Input<String?>? storagePool, Input<String?>? type})
-
Creates a new InstanceTemplateDisk.
architecture The architecture of the attached disk. Valid values are ARM64 or x8664.
autoDelete Whether or not the disk should be auto-deleted.
boot Indicates that this is a boot disk.
deviceName A unique device name that is reflected into the
diskEncryptionKey Encrypts or decrypts a disk using a customer-supplied encryption key.
diskName Name of the disk. When not provided, this defaults
diskSizeGb The size of the image in gigabytes. If not
diskType The GCE disk type. Such as "pd-ssd", "local-ssd",
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.
interface Specifies the disk interface to use for attaching this disk,
labels A set of ket/value label pairs to assign to disk created from
mode The mode in which to attach this disk, either READ_WRITE
provisionedIops Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. For more details, see the Extreme persistent disk documentation or the Hyperdisk documentation depending on the selected disk_type.
provisionedThroughput Indicates how much throughput to provision for the disk, in MB/s. This sets the amount of data that can be read or written from the disk per second. Values must greater than or equal to 1. For more details, see the Hyperdisk documentation.
resourceManagerTags A set of key/value resource manager tag pairs to bind to this disk. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456.
resourcePolicies - A list (short name or id) of resource policies to attach to this disk for automatic snapshot creations. Currently a max of 1 resource policy is supported.
source The name (not self_link)
sourceImage The image from which to
sourceImageEncryptionKey The customer-supplied encryption
sourceSnapshot The source snapshot to create this disk.
sourceSnapshotEncryptionKey The customer-supplied encryption
storagePool The URL of the storage pool in which the new disk is created.
type The type of GCE disk, can be either "SCRATCH" or
const
-
InstanceTemplateDisk.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
architecture
→ Input<String?>?
-
The architecture of the attached disk. Valid values are
ARM64 or x8664.
final
-
autoDelete
→ Input<bool?>?
-
Whether or not the disk should be auto-deleted.
This defaults to true.
final
-
boot
→ Input<bool?>?
-
Indicates that this is a boot disk.
final
-
deviceName
→ Input<String?>?
-
A unique device name that is reflected into the
/dev/ tree of a Linux operating system running within the instance. If not
specified, the server chooses a default device name to apply to this disk.
final
-
diskEncryptionKey
→ Input<InstanceTemplateDiskDiskEncryptionKey?>?
-
Encrypts or decrypts a disk using a customer-supplied encryption key.
final
-
diskName
→ Input<String?>?
-
Name of the disk. When not provided, this defaults
to the name of the instance.
final
-
diskSizeGb
→ Input<int?>?
-
The size of the image in gigabytes. If not
specified, it will inherit the size of its base image. For SCRATCH disks,
the size must be exactly 375GB.
final
-
diskType
→ Input<String?>?
-
The GCE disk type. Such as
"pd-ssd", "local-ssd",
"pd-balanced" or "pd-standard", "hyperdisk-balanced", "hyperdisk-throughput" or "hyperdisk-extreme".
final
-
guestOsFeatures
→ Input<List<String>?>?
-
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
-
interface
→ Input<String?>?
-
Specifies the disk interface to use for attaching this disk,
which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI
and the request will fail if you attempt to attach a persistent disk in any other format
than SCSI. Local SSDs can use either NVME or SCSI.
final
-
labels
→ Input<Map<String, String>?>?
-
A set of ket/value label pairs to assign to disk created from
this template
final
-
mode
→ Input<String?>?
-
The mode in which to attach this disk, either READ_WRITE
or READ_ONLY. If you are attaching or creating a boot disk, this must
read-write mode.
final
-
provisionedIops
→ Input<int?>?
-
Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. For more details, see the Extreme persistent disk documentation or the Hyperdisk documentation depending on the selected disk_type.
final
-
provisionedThroughput
→ Input<int?>?
-
Indicates how much throughput to provision for the disk, in MB/s. This sets the amount of data that can be read or written from the disk per second. Values must greater than or equal to 1. For more details, see the Hyperdisk documentation.
final
-
resourceManagerTags
→ Input<Map<String, String>?>?
-
A set of key/value resource manager tag pairs to bind to this disk. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456.
final
-
resourcePolicies
→ Input<String?>?
-
- A list (short name or id) of resource policies to attach to this disk for automatic snapshot creations. Currently a max of 1 resource policy is supported.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
source
→ Input<String?>?
-
The name (not self_link)
of the disk (such as those managed by
gcp.compute.Disk) to attach.
> Note: Either source, sourceImage, or sourceSnapshot is required in a disk block unless the disk type is local-ssd. Check the API docs for details.
final
-
sourceImage
→ Input<String?>?
-
The image from which to
initialize this disk. This can be one of: the image's
selfLink,
projects/{project}/global/images/{image},
projects/{project}/global/images/family/{family}, global/images/{image},
global/images/family/{family}, family/{family}, {project}/{family},
{project}/{image}, {family}, or {image}.
> Note: Either source, sourceImage, or sourceSnapshot is required in a disk block unless the disk type is local-ssd. Check the API docs for details.
final
-
sourceImageEncryptionKey
→ Input<InstanceTemplateDiskSourceImageEncryptionKey?>?
-
The customer-supplied encryption
key of the source image. Required if the source image is protected by a
customer-supplied encryption key.
final
-
sourceSnapshot
→ Input<String?>?
-
The source snapshot to create this disk.
> Note: Either
source, sourceImage, or sourceSnapshot is required in a disk block unless the disk type is local-ssd. Check the API docs for details.
final
-
sourceSnapshotEncryptionKey
→ Input<InstanceTemplateDiskSourceSnapshotEncryptionKey?>?
-
The customer-supplied encryption
key of the source snapshot. Structure
documented below.
final
-
storagePool
→ Input<String?>?
-
The URL of the storage pool in which the new disk is created.
For example:
final
-
type
→ Input<String?>?
-
The type of GCE disk, can be either
"SCRATCH" or
"PERSISTENT".
final
