HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/help/man/man1/gcloud_spanner_instance-configs_update.1
.TH "GCLOUD_SPANNER_INSTANCE\-CONFIGS_UPDATE" 1



.SH "NAME"
.HP
gcloud spanner instance\-configs update \- update a Cloud Spanner instance configuration



.SH "SYNOPSIS"
.HP
\f5gcloud spanner instance\-configs update\fR \fIINSTANCE_CONFIG\fR [\fB\-\-async\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-etag\fR=\fIETAG\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-validate\-only\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Cloud Spanner instance configuration.



.SH "EXAMPLES"

To update display name of a custom Cloud Spanner instance configuration
\'custom\-instance\-config', run:

.RS 2m
$ gcloud spanner instance\-configs update custom\-instance\-config \e
    \-\-display\-name=nam3\-RO\-us\-central1
.RE

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:

.RS 2m
$ gcloud spanner instance\-configs update custom\-instance\-config \e
     \-\-update\-labels=k0=value1,k1=value2 \-\-remove\-labels=k3
.RE

To clear all labels of a custom Cloud Spanner instance configuration
\'custom\-instance\-config', run:

.RS 2m
$ gcloud spanner instance\-configs update custom\-instance\-config \e
    \-\-clear\-labels
.RE

To remove an existing label of a custom Cloud Spanner instance configuration
\'custom\-instance\-config', run:

.RS 2m
$ gcloud spanner instance\-configs update custom\-instance\-config \e
    \-\-remove\-labels=KEY1,KEY2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE_CONFIG\fR

Cloud Spanner instance config. The 'custom\-' prefix is required to avoid name
conflicts with Google\-managed configurations.


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

The name of this instance configuration as it appears in UIs.

.TP 2m
\fB\-\-etag\fR=\fIETAG\fR

Used for optimistic concurrency control.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

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 (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-validate\-only\fR

Use this flag to validate that the request will succeed before executing it.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud spanner instance\-configs update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud spanner instance\-configs update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha spanner instance\-configs update
.RE

.RS 2m
$ gcloud beta spanner instance\-configs update
.RE