Vertex AI Workbench Runtime Template
Vertex AI Workbench Runtime Template is a configuration resource in Google Cloud that defines the environment setup for Vertex AI Workbench instances. It specifies runtime parameters such as machine type, environment variables, dependencies, and container images used for data science and machine learning workflows. This template helps standardize and automate the creation of consistent, reproducible notebook environments across teams and projects.
gcp.aiplatform_notebook_runtime_template
Fields
| Title | ID | Type | Data Type | Description |
|---|
| _key | core | string | |
| ancestors | core | array<string> | |
| create_time | core | timestamp | Output only. Timestamp when this NotebookRuntimeTemplate was created. |
| data_persistent_disk_spec | core | json | Optional. The specification of persistent disk attached to the runtime as data disk storage. |
| datadog_display_name | core | string | |
| description | core | string | The description of the NotebookRuntimeTemplate. |
| encryption_spec | core | json | Customer-managed encryption key spec for the notebook runtime. |
| etag | core | string | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| euc_config | core | json | EUC configuration of the NotebookRuntimeTemplate. |
| gcp_display_name | core | string | Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| idle_shutdown_config | core | json | The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled. |
| is_default | core | bool | Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified. |
| labels | core | array<string> | The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| machine_spec | core | json | Optional. Immutable. The specification of a single machine for the template. |
| name | core | string | The resource name of the NotebookRuntimeTemplate. |
| network_spec | core | json | Optional. Network spec. |
| network_tags | core | array<string> | Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). |
| notebook_runtime_type | core | string | Optional. Immutable. The type of the notebook runtime template. |
| organization_id | core | string | |
| parent | core | string | |
| project_id | core | string | |
| project_number | core | string | |
| region_id | core | string | |
| reservation_affinity | core | json | Optional. Reservation Affinity of the notebook runtime template. |
| resource_name | core | string | |
| service_account | core | string | Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. 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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. |
| shielded_vm_config | core | json | Optional. Immutable. Runtime Shielded VM spec. |
| software_config | core | json | Optional. The notebook software configuration of the notebook runtime. |
| tags | core | hstore_csv | |
| update_time | core | timestamp | Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. |
| zone_id | core | string | |
