InstanceArgs class

The set of arguments for Instance. The set of arguments for Instance.

Constructors

InstanceArgs({Input<AcceleratorConfig>? acceleratorConfig, Input<String>? bootDiskSizeGb, Input<InstanceBootDiskType>? bootDiskType, Input<bool>? canIpForward, Input<ContainerImage>? containerImage, Input<String>? customGpuDriverPath, Input<String>? dataDiskSizeGb, Input<InstanceDataDiskType>? dataDiskType, Input<InstanceDiskEncryption>? diskEncryption, Input<bool>? installGpuDriver, required Input<String> instanceId, Input<List<String>>? instanceOwners, Input<String>? kmsKey, Input<Map<String, String>>? labels, Input<String>? location, required Input<String> machineType, Input<Map<String, String>>? metadata, Input<String>? network, Input<InstanceNicType>? nicType, Input<bool>? noProxyAccess, Input<bool>? noPublicIp, Input<bool>? noRemoveDataDisk, Input<String>? postStartupScript, Input<String>? project, Input<ReservationAffinity>? reservationAffinity, Input<String>? serviceAccount, Input<List<String>>? serviceAccountScopes, Input<ShieldedInstanceConfig>? shieldedInstanceConfig, Input<String>? subnet, Input<List<String>>? tags, Input<List<UpgradeHistoryEntry>>? upgradeHistory, Input<VmImage>? vmImage})
Creates a new InstanceArgs. acceleratorConfig The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected. bootDiskSizeGb Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100. bootDiskType Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). canIpForward Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward containerImage Use a container image to start the notebook instance. customGpuDriverPath Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. dataDiskSizeGb Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100. dataDiskType Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD). diskEncryption Input only. Disk encryption method used on the boot and data disks, defaults to GMEK. installGpuDriver Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. instanceId Required. User-defined unique ID of this instance. instanceOwners Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. kmsKey Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys. labels Labels to apply to this instance. These can be later modified by the setLabels method. location Optional. machineType The Compute Engine machine type of this instance. metadata Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=``BUCKET''". network The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id} nicType Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. noProxyAccess If true, the notebook instance will not register with the proxy. noPublicIp If true, no external IP will be assigned to this instance. noRemoveDataDisk Input only. If true, the data disk will not be auto deleted when deleting the instance. postStartupScript Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name). project Optional. reservationAffinity Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance. serviceAccount The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used. serviceAccountScopes Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute shieldedInstanceConfig Optional. Shielded VM configuration. Images using supported Shielded VM features. subnet The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id} tags Optional. The Compute Engine tags to add to runtime (see Tagging instances). upgradeHistory The upgrade history of this instance. vmImage Use a Compute Engine VM image to start the notebook instance.
const
InstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

acceleratorConfig → Input<AcceleratorConfig>?
The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.
final
bootDiskSizeGb → Input<String>?
Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.
final
bootDiskType → Input<InstanceBootDiskType>?
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
final
canIpForward → Input<bool>?
Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
final
containerImage → Input<ContainerImage>?
Use a container image to start the notebook instance.
final
customGpuDriverPath → Input<String>?
Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
final
dataDiskSizeGb → Input<String>?
Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.
final
dataDiskType → Input<InstanceDataDiskType>?
Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
final
diskEncryption → Input<InstanceDiskEncryption>?
Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
final
hashCode → int
The hash code for this object.
no setterinherited
installGpuDriver → Input<bool>?
Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.
final
instanceId → Input<String>
Required. User-defined unique ID of this instance.
final
instanceOwners → Input<List<String>>?
Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.
final
kmsKey → Input<String>?
Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id} Learn more about using your own encryption keys.
final
labels → Input<Map<String, String>>?
Labels to apply to this instance. These can be later modified by the setLabels method.
final
location → Input<String>?
final
machineType → Input<String>
The Compute Engine machine type of this instance.
final
metadata → Input<Map<String, String>>?
Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use the gcs-data-bucket metadata tag. Format: "--metadata=gcs-data-bucket=``BUCKET''".
final
network → Input<String>?
The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
final
nicType → Input<InstanceNicType>?
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
final
noProxyAccess → Input<bool>?
If true, the notebook instance will not register with the proxy.
final
noPublicIp → Input<bool>?
If true, no external IP will be assigned to this instance.
final
noRemoveDataDisk → Input<bool>?
Input only. If true, the data disk will not be auto deleted when deleting the instance.
final
postStartupScript → Input<String>?
Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).
final
project → Input<String>?
final
reservationAffinity → Input<ReservationAffinity>?
Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccount → Input<String>?
The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the Compute Engine default service account is used.
final
serviceAccountScopes → Input<List<String>>?
Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following scopes are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute
final
shieldedInstanceConfig → Input<ShieldedInstanceConfig>?
Optional. Shielded VM configuration. Images using supported Shielded VM features.
final
subnet → Input<String>?
The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
final
tags → Input<List<String>>?
Optional. The Compute Engine tags to add to runtime (see Tagging instances).
final
upgradeHistory → Input<List<UpgradeHistoryEntry>>?
The upgrade history of this instance.
final
vmImage → Input<VmImage>?
Use a Compute Engine VM image to start the notebook instance.
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