gcloud workbench instances update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud workbench instances update - updates a workbench instance
- SYNOPSIS
gcloud workbench instances update(INSTANCE:--location=LOCATION)[--async][--labels=[KEY=VALUE,…]][--machine-type=MACHINE_TYPE--metadata=[KEY=VALUE,…]--tags=[TAGS,…]--accelerator-core-count=ACCELERATOR_CORE_COUNT--accelerator-type=ACCELERATOR_TYPE[--container-repository=CONTAINER_REPOSITORY:--container-tag=CONTAINER_TAG]--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH--install-gpu-driver--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING--shielded-secure-boot=SHIELDED_SECURE_BOOT--shielded-vtpm=SHIELDED_VTPM][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Updates a workbench instance.
- EXAMPLES
- To update machine type for an instance, run:
gcloudworkbenchinstancesupdateexample-instance--machine-type=n1-standard-8--location=us-central1-aTo update labels for an instance, run:
gcloudworkbenchinstancesupdateexample-instance--labels=k1=v1,k2=v2--location=us-central1-a - POSITIONAL ARGUMENTS
- Instance resource - User-defined unique name of this instance. The instance namemust be 1 to 63 characters long and contain only lowercase letters, numericcharacters, and dashes. The first character must be a lowercase letter and thelast character cannot be a dash. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
INSTANCE- ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:- provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- Google Cloud location of this environmenthttps://cloud.google.com/compute/docs/regions-zones/#locations.
To set the
locationattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
notebooks/location.
- provide the argument
- provide the argument
- Instance resource - User-defined unique name of this instance. The instance namemust be 1 to 63 characters long and contain only lowercase letters, numericcharacters, and dashes. The first character must be a lowercase letter and thelast character cannot be a dash. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--labels=[KEY=VALUE,…]- Labels to apply to this instance. These can be later modified by the setLabelsmethod.
- Gce Setup for the instance
--machine-type=MACHINE_TYPE- TheComputeEngine machine type of this instance.
--metadata=[KEY=VALUE,…]- Custom metadata to apply to this instance.
--tags=[TAGS,…]- Tags to apply to this instance.
- Accelerator configurations.
--accelerator-core-count=ACCELERATOR_CORE_COUNT- Count of cores of this accelerator.
--accelerator-type=ACCELERATOR_TYPE- Type of this accelerator.
ACCELERATOR_TYPEmust be oneof:NVIDIA_TESLA_K80,NVIDIA_TESLA_P100,NVIDIA_TESLA_V100,NVIDIA_TESLA_P4,NVIDIA_TESLA_T4,NVIDIA_TESLA_A100,NVIDIA_A100_80GB,NVIDIA_TESLA_T4_VWS,NVIDIA_TESLA_P100_VWS,NVIDIA_TESLA_P4_VWS,NVIDIA_L4,NVIDIA_H100_80GB,NVIDIA_H100_MEGA_80GB.
- Container image configurations.
--container-repository=CONTAINER_REPOSITORY- The path to the container image repository. For example:gcr.io/
{project_id}/{image_name}.This flag argument must be specified if any of the other arguments in this groupare specified.
--container-tag=CONTAINER_TAG- The tag of the container image. If not specified, this defaults to the latesttag.
- GPU driver configurations.
--custom-gpu-driver-path=CUSTOM_GPU_DRIVER_PATH- custom gpu driver path
--install-gpu-driver- Install gpu driver
- Shielded VM configurations.
--shielded-integrity-monitoring=SHIELDED_INTEGRITY_MONITORING- Boolean. Enable monitoring of the boot integrity of the instance. Supportedvalues:
true,false. --shielded-secure-boot=SHIELDED_SECURE_BOOT- Boolean. Boot instance with secure boot enabled. Supported values:
true,false. --shielded-vtpm=SHIELDED_VTPM- Boolean. Boot instance with TPM (Trusted Platform Module) enabled. Supportedvalues:
true,false.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- This variant is also available:
gcloudbetaworkbenchinstancesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-16 UTC.