gcloud alpha workstations clusters update

NAME
gcloud alpha workstations clusters update - update a workstation cluster
SYNOPSIS
gcloud alpha workstations clusters update (CLUSTER : --region=REGION) [--async] [--display-name=DISPLAY_NAME] [--enable-http2] [--update-labels=[KEY=VALUE,…]] [--clear-labels     | --remove-labels=[KEY,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Update a workstation cluster.
EXAMPLES
To update the display name of workstation cluster my-cluster in region us-central1, run: 
gcloud alpha 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.
--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.

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 alpha workstations clusters update --clear-labels

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

gcloud alpha 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/v1beta API. The full documentation for this API can be found at: https://cloud.google.com/workstations
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available: 
gcloud workstations clusters update
 
gcloud beta workstations clusters update