InstanceArgs

data class InstanceArgs(val acceleratorConfig: Output<AcceleratorConfigArgs>? = null, val bootDiskSizeGb: Output<String>? = null, val bootDiskType: Output<InstanceBootDiskType>? = null, val canIpForward: Output<Boolean>? = null, val containerImage: Output<ContainerImageArgs>? = null, val customGpuDriverPath: Output<String>? = null, val dataDiskSizeGb: Output<String>? = null, val dataDiskType: Output<InstanceDataDiskType>? = null, val diskEncryption: Output<InstanceDiskEncryption>? = null, val installGpuDriver: Output<Boolean>? = null, val instanceId: Output<String>? = null, val instanceOwners: Output<List<String>>? = null, val kmsKey: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val machineType: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val network: Output<String>? = null, val nicType: Output<InstanceNicType>? = null, val noProxyAccess: Output<Boolean>? = null, val noPublicIp: Output<Boolean>? = null, val noRemoveDataDisk: Output<Boolean>? = null, val postStartupScript: Output<String>? = null, val project: Output<String>? = null, val reservationAffinity: Output<ReservationAffinityArgs>? = null, val serviceAccount: Output<String>? = null, val serviceAccountScopes: Output<List<String>>? = null, val shieldedInstanceConfig: Output<ShieldedInstanceConfigArgs>? = null, val subnet: Output<String>? = null, val tags: Output<List<String>>? = null, val upgradeHistory: Output<List<UpgradeHistoryEntryArgs>>? = null, val vmImage: Output<VmImageArgs>? = null) : ConvertibleToJava<InstanceArgs>

Creates a new Instance in a given project and location. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun InstanceArgs(acceleratorConfig: Output<AcceleratorConfigArgs>? = null, bootDiskSizeGb: Output<String>? = null, bootDiskType: Output<InstanceBootDiskType>? = null, canIpForward: Output<Boolean>? = null, containerImage: Output<ContainerImageArgs>? = null, customGpuDriverPath: Output<String>? = null, dataDiskSizeGb: Output<String>? = null, dataDiskType: Output<InstanceDataDiskType>? = null, diskEncryption: Output<InstanceDiskEncryption>? = null, installGpuDriver: Output<Boolean>? = null, instanceId: Output<String>? = null, instanceOwners: Output<List<String>>? = null, kmsKey: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, machineType: Output<String>? = null, metadata: Output<Map<String, String>>? = null, network: Output<String>? = null, nicType: Output<InstanceNicType>? = null, noProxyAccess: Output<Boolean>? = null, noPublicIp: Output<Boolean>? = null, noRemoveDataDisk: Output<Boolean>? = null, postStartupScript: Output<String>? = null, project: Output<String>? = null, reservationAffinity: Output<ReservationAffinityArgs>? = null, serviceAccount: Output<String>? = null, serviceAccountScopes: Output<List<String>>? = null, shieldedInstanceConfig: Output<ShieldedInstanceConfigArgs>? = null, subnet: Output<String>? = null, tags: Output<List<String>>? = null, upgradeHistory: Output<List<UpgradeHistoryEntryArgs>>? = null, vmImage: Output<VmImageArgs>? = null)

Functions

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

Properties

Link copied to clipboard

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.

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

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.

Link copied to clipboard
val bootDiskType: Output<InstanceBootDiskType>? = null

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

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

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

Link copied to clipboard
val containerImage: Output<ContainerImageArgs>? = null

Use a container image to start the notebook instance.

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

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

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

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.

Link copied to clipboard
val dataDiskType: Output<InstanceDataDiskType>? = null

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

Link copied to clipboard

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

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

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.

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

Required. User-defined unique ID of this instance.

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

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.

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

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 /kms/docs/quickstart.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

Labels to apply to this instance. These can be later modified by the setLabels method.

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

The Compute Engine machine type of this instance.

Link copied to clipboard
val metadata: Output<Map<String, String>>? = null

Custom metadata to apply to this instance.

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

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

Link copied to clipboard
val nicType: Output<InstanceNicType>? = null

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

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

If true, the notebook instance will not register with the proxy.

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

If true, no public IP will be assigned to this instance.

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

Input only. If true, the data disk will not be auto deleted when deleting the instance.

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

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).

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

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

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

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.

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

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

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

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

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

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Link copied to clipboard

The upgrade history of this instance.

Link copied to clipboard
val vmImage: Output<VmImageArgs>? = null

Use a Compute Engine VM image to start the notebook instance.