InstanceState class

Input properties used for looking up and filtering Instance resources.

Constructors

InstanceState({Input<String?>? createTime, Input<String?>? creator, Input<String?>? deletionPolicy, Input<String?>? desiredState, Input<bool?>? disableProxyAccess, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? enableDeletionProtection, Input<bool?>? enableManagedEuc, Input<bool?>? enableThirdPartyIdentity, Input<InstanceGceSetup?>? gceSetup, Input<List<Map<String, dynamic>>?>? healthInfos, Input<String?>? healthState, Input<String?>? instanceId, Input<List<String>?>? instanceOwners, Input<Map<String, String>?>? labels, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<String?>? proxyUri, Input<Map<String, String>?>? pulumiLabels, Input<String?>? state, Input<String?>? updateTime, Input<List<InstanceUpgradeHistory>?>? upgradeHistories})
Creates a new InstanceState. createTime An RFC3339 timestamp in UTC time. This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ. creator Output only. Email address of entity that sent original CreateInstance request. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. desiredState Desired state of the Workbench Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance. disableProxyAccess Optional. If true, the workbench instance will not register with the proxy. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. enableDeletionProtection Optional. If true, deletion protection will be enabled for this Workbench Instance. enableManagedEuc Flag to enable managed end user credentials for the instance. enableThirdPartyIdentity Flag that specifies that a notebook can be accessed with third party gceSetup The definition of how to configure a VM instance outside of Resources and Identity. healthInfos 'Output only. Additional information about instance health. Example: healthState Output only. Instance health_state. instanceId Required. User-defined unique ID of this instance. instanceOwners 'Optional. Input only. The owner of this instance after creation. Format: labels Optional. Labels to apply to this instance. These can be later modified location Part of parent. See documentation of projectsId. name The name of this workbench instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id} project The ID of the project in which the resource belongs. proxyUri Output only. The proxy endpoint that is used to access the Jupyter notebook. pulumiLabels The combination of labels configured directly on the resource state (Output) updateTime An RFC3339 timestamp in UTC time. This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ. upgradeHistories Output only. The upgrade history of this instance.
const
InstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

createTime → Input<String?>?
An RFC3339 timestamp in UTC time. This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ. The milliseconds portion (".SSS") is optional.
final
creator → Input<String?>?
Output only. Email address of entity that sent original CreateInstance request.
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 Workbench Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
final
disableProxyAccess → Input<bool?>?
Optional. If true, the workbench instance will not register with the proxy.
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
enableDeletionProtection → Input<bool?>?
Optional. If true, deletion protection will be enabled for this Workbench Instance.
final
enableManagedEuc → Input<bool?>?
Flag to enable managed end user credentials for the instance.
final
enableThirdPartyIdentity → Input<bool?>?
Flag that specifies that a notebook can be accessed with third party identity provider.
final
gceSetup → Input<InstanceGceSetup?>?
The definition of how to configure a VM instance outside of Resources and Identity. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
healthInfos → Input<List<Map<String, dynamic>>?>?
'Output only. Additional information about instance health. Example: healthInfo": { "dockerProxyAgentStatus": "1", "dockerStatus": "1", "jupyterlabApiStatus": "-1", "jupyterlabStatus": "-1", "updated": "2020-10-18 09:40:03.573409" }'
final
healthState → Input<String?>?
Output only. Instance health_state.
final
instanceId → Input<String?>?
Required. User-defined unique ID of this instance.
final
instanceOwners → Input<List<String>?>?
'Optional. 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. If specified, sets the access mode to Single user. For more details, see https://cloud.google.com/vertex-ai/docs/workbench/instances/manage-access-jupyterlab'
final
labels → Input<Map<String, String>?>?
Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
final
location → Input<String?>?
Part of parent. See documentation of projectsId.
final
name → Input<String?>?
The name of this workbench instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
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?>?
Output only. The proxy endpoint that is used to access the Jupyter notebook.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
(Output) Output only. The state of this instance upgrade history entry.
final
updateTime → Input<String?>?
An RFC3339 timestamp in UTC time. This in the format of yyyy-MM-ddTHH:mm:ss.SSSZ. The milliseconds portion (".SSS") is optional.
final
upgradeHistories → Input<List<InstanceUpgradeHistory>?>?
Output only. The upgrade history of this 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