Instance

class Instance : KotlinCustomResource

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

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>

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<String>

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>

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

Link copied to clipboard

Use a container image to start the notebook instance.

Link copied to clipboard
val createTime: Output<String>

Instance creation time.

Link copied to clipboard
val creator: Output<String>

Email address of entity that sent original CreateInstance request.

Link copied to clipboard

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>

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<String>

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

Link copied to clipboard
val diskEncryption: Output<String>

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

Link copied to clipboard
val disks: Output<List<DiskResponse>>

Attached disks to notebook instance.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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>

Required. User-defined unique ID of this instance.

Link copied to clipboard
val instanceOwners: Output<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.

Link copied to clipboard
val kmsKey: Output<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 /kms/docs/quickstart.

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

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

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

The Compute Engine machine type of this instance.

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

Custom metadata to apply to this instance.

Link copied to clipboard
val name: Output<String>

The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

Link copied to clipboard
val network: Output<String>

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<String>

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>

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

Link copied to clipboard
val noPublicIp: Output<Boolean>

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

Link copied to clipboard

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

Link copied to clipboard

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>
Link copied to clipboard
val proxyUri: Output<String>

The proxy endpoint that is used to access the Jupyter notebook.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
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>

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

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 state: Output<String>

The state of this instance.

Link copied to clipboard
val subnet: Output<String>

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

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

Link copied to clipboard
val updateTime: Output<String>

Instance update time.

Link copied to clipboard

The upgrade history of this instance.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

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