1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 18:45:13 +00:00
gcloud-help/gcloud/alpha/spanner/instance-configs/update
2022-10-05 10:40:53 +00:00

107 lines
3.9 KiB
Text

NAME
gcloud alpha spanner instance-configs update - update a Cloud Spanner
instance configuration
SYNOPSIS
gcloud alpha spanner instance-configs update INSTANCE_CONFIG [--async]
[--display-name=DISPLAY_NAME] [--etag=ETAG]
[--update-labels=[KEY=VALUE,...]] [--validate-only]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a Cloud Spanner instance configuration.
EXAMPLES
To update display name of a custom Cloud Spanner instance configuration
'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --display-name=nam3-RO-us-central1
To modify the instance config 'custom-instance-config' by adding label
'k0', with value 'value1' and label 'k1' with value 'value2' and removing
labels with key 'k3', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --update-labels=k0=value1,k1=value2 \
--remove-labels=k3
To clear all labels of a custom Cloud Spanner instance configuration
'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --clear-labels
To remove an existing label of a custom Cloud Spanner instance
configuration 'custom-instance-config', run:
$ gcloud alpha spanner instance-configs update \
custom-instance-config --remove-labels=KEY1,KEY2
POSITIONAL ARGUMENTS
INSTANCE_CONFIG
Cloud Spanner instance config. The 'custom-' prefix is required to
avoid name conflicts with Google-managed configurations.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--display-name=DISPLAY_NAME
The name of this instance configuration as it appears in UIs.
--etag=ETAG
Used for optimistic concurrency control.
--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.
--validate-only
Use this flag to validate that the request will succeed before
executing it.
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 spanner instance-configs update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha spanner instance-configs 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.
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 spanner instance-configs update
$ gcloud beta spanner instance-configs update