InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<InstanceAcceleratorConfig?>? acceleratorConfig, Input<int?>? bootDiskSizeGb, Input<String?>? bootDiskType, Input<InstanceContainerImage?>? containerImage, Input<String?>? createTime, Input<String?>? customGpuDriverPath, Input<int?>? dataDiskSizeGb, Input<String?>? dataDiskType, Input<String?>? deletionPolicy, Input<String?>? desiredState, Input<String?>? diskEncryption, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? installGpuDriver, Input<List<String>?>? instanceOwners, Input<String?>? kmsKey, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? machineType, Input<Map<String, String>?>? metadata, Input<String?>? name, Input<String?>? network, Input<String?>? nicType, Input<bool?>? noProxyAccess, Input<bool?>? noPublicIp, Input<bool?>? noRemoveDataDisk, Input<String?>? postStartupScript, Input<String?>? project, Input<String?>? proxyUri, Input<Map<String, String>?>? pulumiLabels, Input<InstanceReservationAffinity?>? reservationAffinity, Input<String?>? serviceAccount, Input<List<String>?>? serviceAccountScopes, Input<InstanceShieldedInstanceConfig?>? shieldedInstanceConfig, Input<String?>? state, Input<String?>? subnet, Input<List<String>?>? tags, Input<String?>? updateTime, Input<InstanceVmImage?>? vmImage})
Creates a new InstanceState. acceleratorConfig The hardware accelerator used on this instance. If you use accelerators, bootDiskSizeGb The size of the boot disk in GB attached to this instance, bootDiskType Possible disk types for notebook instances. containerImage Use a container image to start the notebook instance. createTime Instance creation time customGpuDriverPath Specify a custom Cloud Storage path where the GPU driver is stored. dataDiskSizeGb The size of the data disk in GB attached to this instance, dataDiskType Possible disk types for notebook instances. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. desiredState Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance. diskEncryption Disk encryption method used on the boot and data disks, defaults to GMEK. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. installGpuDriver Whether the end user authorizes Google Cloud to install GPU driver instanceOwners The list of owners of this instance after creation. kmsKey The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. labels Labels to apply to this instance. These can be later modified by the setLabels method. location A reference to the zone where the machine resides. machineType A reference to a machine type which defines VM kind. metadata Custom metadata to apply to this instance. name The name specified for the Notebook instance. network The name of the VPC that this instance is in. nicType The type of vNIC driver. noProxyAccess The notebook instance will not register with the proxy.. noPublicIp No public IP will be assigned to this instance. noRemoveDataDisk 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 project The ID of the project in which the resource belongs. proxyUri The proxy endpoint that is used to access the Jupyter notebook. pulumiLabels The combination of labels configured directly on the resource reservationAffinity Reservation Affinity for consuming Zonal reservation. serviceAccount The service account on this instance, giving access to other serviceAccountScopes Optional. The URIs of service account scopes to be included in Compute Engine instances. shieldedInstanceConfig A set of Shielded Instance options. Check Images using supported Shielded VM features state The state of this instance. subnet The name of the subnet that this instance is in. tags The Compute Engine tags to add to instance. updateTime Instance update time. vmImage Use a Compute Engine VM image to start the notebook instance.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

acceleratorConfig → Input<InstanceAcceleratorConfig?>?
The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machineType you have selected. Structure is documented below.
final
bootDiskSizeGb → Input<int?>?
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<String?>?
Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
final
containerImage → Input<InstanceContainerImage?>?
Use a container image to start the notebook instance. Structure is documented below.
final
createTime → Input<String?>?
Instance creation time
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<int?>?
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<String?>?
Possible disk types for notebook instances. Possible values are: DISK_TYPE_UNSPECIFIED, PD_STANDARD, PD_SSD, PD_BALANCED, PD_EXTREME.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
desiredState → Input<String?>?
Desired state of the Notebook Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
final
diskEncryption → Input<String?>?
Disk encryption method used on the boot and data disks, defaults to GMEK. Possible values are: DISK_ENCRYPTION_UNSPECIFIED, GMEK, CMEK.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
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
instanceOwners → Input<List<String>?>?
The list of owners 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?>?
The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}
final
labels → Input<Map<String, String>?>?
Labels to apply to this instance. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
location → Input<String?>?
A reference to the zone where the machine resides.
final
machineType → Input<String?>?
A reference to a machine type which defines VM kind.
final
metadata → Input<Map<String, String>?>?
Custom metadata to apply to this instance. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
name → Input<String?>?
The name specified for the Notebook instance.
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<String?>?
The type of vNIC driver. Possible values are: UNSPECIFIED_NIC_TYPE, VIRTIO_NET, GVNIC.
final
noProxyAccess → Input<bool?>?
The notebook instance will not register with the proxy..
final
noPublicIp → Input<bool?>?
No public IP will be assigned to this instance.
final
noRemoveDataDisk → Input<bool?>?
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?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
proxyUri → Input<String?>?
The proxy endpoint that is used to access the Jupyter notebook. Only returned when the resource is in a PROVISIONED state. If needed you can utilize pulumi up -refresh-only to await the population of this value.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
reservationAffinity → Input<InstanceReservationAffinity?>?
Reservation Affinity for consuming Zonal reservation. Structure is documented below.
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:
final
shieldedInstanceConfig → Input<InstanceShieldedInstanceConfig?>?
A set of Shielded Instance options. Check Images using supported Shielded VM features Not all combinations are valid Structure is documented below.
final
state → Input<String?>?
The state of this instance.
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>?>?
The Compute Engine tags to add to instance.
final
updateTime → Input<String?>?
Instance update time.
final
vmImage → Input<InstanceVmImage?>?
Use a Compute Engine VM image to start the notebook instance. Structure is documented below.
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