gcloud workstations clusters update

NAME
gcloud workstations clusters update - update a workstation cluster
SYNOPSIS
gcloud workstations clusters update (CLUSTER : --region=REGION) [--async] [--display-name=DISPLAY_NAME] [--enable-http2] [--endpoint-mode=ENDPOINT_MODE] [--update-labels=[KEY=VALUE,…]] [--workstation-authorization-url=WORKSTATION_AUTHORIZATION_URL] [--workstation-launch-url=WORKSTATION_LAUNCH_URL] [--clear-labels     | --remove-labels=[KEY,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
Update a workstation cluster.
EXAMPLES
To update the display name of workstation cluster my-cluster in region us-central1, run: 
gcloud workstations clusters update my-cluster --region=us-central1 --display-name='My New Cluster Name'
POSITIONAL ARGUMENTS
Cluster resource - Arguments and flags that specify the cluster to update. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument cluster on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

CLUSTER
ID of the cluster or fully qualified identifier for the cluster.

To set the cluster attribute:

  • provide the argument cluster on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--region=REGION
The name of the region of the cluster. To set the region attribute:
  • provide the argument cluster on the command line with a fully specified name;
  • provide the argument --region on the command line;
  • set the property workstations/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--display-name=DISPLAY_NAME
Human-readable name for this workstation cluster.
--enable-http2
Enable or disable HTTP/2 for the workstation cluster.
--endpoint-mode=ENDPOINT_MODE
Specifies endpoint mode for a given command. Regional endpoints provide enhanced data residency and reliability by ensuring your request is handled entirely within the specified Google Cloud region. This differs from global endpoints, which may process parts of the request outside the target region. Overrides the default regional/endpoint_mode property value for this command invocation. ENDPOINT_MODE must be one of:
global
(Default) Use global rather than regional endpoints.
regional
Only use regional endpoints. An error will be raised if a regional endpoint is not available for a given command.
regional-preferred
Use regional endpoints when available, otherwise use global endpoints. Recommended for most users.
--update-labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.

--workstation-authorization-url=WORKSTATION_AUTHORIZATION_URL
The redirect URL for unauthorized requests.
--workstation-launch-url=WORKSTATION_LAUNCH_URL
The launch URL for workstations.
At most one of these can be specified:
--clear-labels
Remove all labels. If --update-labels is also specified then --clear-labels is applied first.

For example, to remove all labels: 

gcloud workstations clusters update --clear-labels

To remove all existing labels and create two new labels, foo and baz: 

gcloud workstations clusters update --clear-labels --update-labels foo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored. If --update-labels is also specified then --update-labels is applied first.
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 help for details.

API REFERENCE
This command uses the workstations/v1 API. The full documentation for this API can be found at: https://cloud.google.com/workstations
REGIONAL ENDPOINTS
This command supports regional endpoints. To use regional endpoints for this command, use the --endpoint-mode=regional-preferred flag. To use regional endpoints by default, run $ gcloud config set regional/endpoint_mode regional-preferred.
NOTES
These variants are also available: 
gcloud alpha workstations clusters update
 
gcloud beta workstations clusters update