Vertex AI Workbench Instance

Vertex AI Workbench Instance is a managed Jupyter-based development environment in Google Cloud designed for data science and machine learning. It integrates with Vertex AI services, BigQuery, and other GCP tools, allowing users to build, train, and deploy models efficiently. It supports both managed and user-managed notebook instances with customizable compute and storage options.

gcp.notebooks_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Instance creation time.
creatorcorestringOutput only. Email address of entity that sent original CreateInstance request.
datadog_display_namecorestring
disable_proxy_accesscoreboolOptional. If true, the notebook instance will not register with the proxy.
enable_deletion_protectioncoreboolOptional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.
enable_managed_euccoreboolOptional. Flag to enable managed end user credentials for the instance.
enable_third_party_identitycoreboolOptional. Flag that specifies that a notebook can be accessed with third party identity provider.
gce_setupcorejsonOptional. Compute Engine setup for the notebook. Uses notebook-defined fields.
health_statecorestringOutput only. Instance health_state.
idcorestringOutput only. Unique ID of the resource.
instance_ownerscorearray<string>Optional. 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.
labelscorearray<string>Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
namecorestringOutput only. Identifier. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
proxy_uricorestringOutput only. The proxy endpoint that is used to access the Jupyter notebook.
region_idcorestring
resource_namecorestring
satisfies_pzicoreboolOutput only. Reserved for future use for Zone Isolation.
satisfies_pzscoreboolOutput only. Reserved for future use for Zone Separation.
statecorestringOutput only. The state of this instance.
tagscorehstore_csv
third_party_proxy_urlcorestringOutput only. The workforce pools proxy endpoint that is used to access the Jupyter notebook.
update_timecoretimestampOutput only. Instance update time.
upgrade_historycorejsonOutput only. The upgrade history of this instance.
zone_idcorestring