File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_spanner_instance-configs_update.1
.TH "GCLOUD_ALPHA_SPANNER_INSTANCE\-CONFIGS_UPDATE" 1
.SH "NAME"
.HP
gcloud alpha spanner instance\-configs update \- update a Cloud Spanner instance configuration
.SH "SYNOPSIS"
.HP
\f5gcloud alpha 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"
\fB(ALPHA)\fR 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 alpha spanner instance\-configs update \e
custom\-instance\-config \-\-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 alpha spanner instance\-configs update \e
custom\-instance\-config \-\-update\-labels=k0=value1,k1=value2 \e
\-\-remove\-labels=k3
.RE
To clear all labels of a custom Cloud Spanner instance configuration
\'custom\-instance\-config', run:
.RS 2m
$ gcloud alpha spanner instance\-configs update \e
custom\-instance\-config \-\-clear\-labels
.RE
To remove an existing label of a custom Cloud Spanner instance configuration
\'custom\-instance\-config', run:
.RS 2m
$ gcloud alpha spanner instance\-configs update \e
custom\-instance\-config \-\-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 alpha 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 alpha 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"
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:
.RS 2m
$ gcloud spanner instance\-configs update
.RE
.RS 2m
$ gcloud beta spanner instance\-configs update
.RE