.TH "GCLOUD_SPANNER_INSTANCES_UPDATE" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud spanner instances update\fR \fIINSTANCE\fR [\fB\-\-async\fR] [\fB\-\-default\-backup\-schedule\-type\fR=\fIDEFAULT_BACKUP_SCHEDULE_TYPE\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-edition\fR=\fIEDITION\fR] [\fB\-\-expire\-behavior\fR=\fIEXPIRE_BEHAVIOR\fR] [\fB\-\-instance\-type\fR=\fIINSTANCE_TYPE\fR] [\fB\-\-nodes\fR=\fINODES\fR\ |\ \fB\-\-processing\-units\fR=\fIPROCESSING_UNITS\fR\ |\ \fB\-\-autoscaling\-high\-priority\-cpu\-target\fR=\fIAUTOSCALING_HIGH_PRIORITY_CPU_TARGET\fR\ \fB\-\-autoscaling\-storage\-target\fR=\fIAUTOSCALING_STORAGE_TARGET\fR\ \fB\-\-asymmetric\-autoscaling\-option\fR=[\fIdisable_high_priority_cpu_autoscaling\fR=\fIDISABLE_HIGH_PRIORITY_CPU_AUTOSCALING\fR],[\fIdisable_total_cpu_autoscaling\fR=\fIDISABLE_TOTAL_CPU_AUTOSCALING\fR],[\fIhigh_priority_cpu_target\fR=\fIHIGH_PRIORITY_CPU_TARGET\fR],[\fIlocation\fR=\fILOCATION\fR],[\fImax_nodes\fR=\fIMAX_NODES\fR],[\fImax_processing_units\fR=\fIMAX_PROCESSING_UNITS\fR],[\fImin_nodes\fR=\fIMIN_NODES\fR],[\fImin_processing_units\fR=\fIMIN_PROCESSING_UNITS\fR],[\fItotal_cpu_target\fR=\fITOTAL_CPU_TARGET\fR]\ |\ \fB\-\-clear\-asymmetric\-autoscaling\-option\fR=\fILOCATION\fR,[\fILOCATION\fR,...]\ \fB\-\-autoscaling\-max\-nodes\fR=\fIAUTOSCALING_MAX_NODES\fR\ \fB\-\-autoscaling\-min\-nodes\fR=\fIAUTOSCALING_MIN_NODES\fR\ |\ \fB\-\-autoscaling\-max\-processing\-units\fR=\fIAUTOSCALING_MAX_PROCESSING_UNITS\fR\ \fB\-\-autoscaling\-min\-processing\-units\fR=\fIAUTOSCALING_MIN_PROCESSING_UNITS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Cloud Spanner instance.



.SH "EXAMPLES"

To update the display name of a Cloud Spanner instance, run:

.RS 2m
$ gcloud spanner instances update my\-instance\-id \e
    \-\-description=my\-new\-display\-name
.RE

To update the node count of a Cloud Spanner instance, run:

.RS 2m
$ gcloud spanner instances update my\-instance\-id \-\-nodes=1
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIINSTANCE\fR

Cloud Spanner instance ID.


.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\-\-default\-backup\-schedule\-type\fR=\fIDEFAULT_BACKUP_SCHEDULE_TYPE\fR

The default backup schedule type that is used in the instance.
\fIDEFAULT_BACKUP_SCHEDULE_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBAUTOMATIC\fR
A default backup schedule is created automatically when a new database is
created in an instance. You can edit or delete the default backup schedule once
it's created. The default backup schedule creates a full backup every 24 hours.
These full backups are retained for 7 days.
.TP 2m
\fBDEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED\fR
Not specified.
.TP 2m
\fBNONE\fR
No default backup schedule is created automatically when a new database is
created in an instance.
.RE
.sp


.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the instance.

.TP 2m
\fB\-\-edition\fR=\fIEDITION\fR

Spanner edition. You can upgrade your Standard edition instance to the
\f5ENTERPRISE\fR edition or \f5ENTERPRISE_PLUS\fR edition. You can also upgrade
your Enterprise edition instance to the \f5ENTERPRISE_PLUS\fR edition. You can
downgrade your \f5ENTERPRISE_PLUS\fR edition instance to the \f5ENTERPRISE\fR or
\f5STANDARD\fR edition. You can also downgrade your \f5ENTERPRISE\fR edition
instance to the \f5STANDARD\fR edition. You must stop using the higher\-tier
edition features in order to downgrade. Otherwise, downgrade fails. For more
information, see Spanner editions overview
(https://cloud.google.com/spanner/docs/editions\-overview).

.TP 2m
\fB\-\-expire\-behavior\fR=\fIEXPIRE_BEHAVIOR\fR

The expire behavior of a free trial instance. \fIEXPIRE_BEHAVIOR\fR must be one
of:

.RS 2m
.TP 2m
\fBfree\-to\-provisioned\fR
When the free trial instance expires, upgrade the instance to a provisioned
instance.
.TP 2m
\fBremove\-after\-grace\-period\fR
When the free trial instance expires, disable the instance, and delete it after
the grace period passes if it has not been upgraded to a provisioned instance.
.RE
.sp


.TP 2m
\fB\-\-instance\-type\fR=\fIINSTANCE_TYPE\fR

Specifies the type for this instance. \fIINSTANCE_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBfree\-instance\fR
Free trial instances provide no guarantees for dedicated resources, both
node_count and processing_units should be 0. They come with stricter usage
limits and limited support.
.TP 2m
\fBprovisioned\fR
Provisioned instances have dedicated resources, standard usage limits, and
support.
.RE
.sp


.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-nodes\fR=\fINODES\fR

Number of nodes for the instance.

.TP 2m
\fB\-\-processing\-units\fR=\fIPROCESSING_UNITS\fR

Number of processing units for the instance.

.TP 2m

Autoscaling


.RS 2m
.TP 2m
\fB\-\-autoscaling\-high\-priority\-cpu\-target\fR=\fIAUTOSCALING_HIGH_PRIORITY_CPU_TARGET\fR

Specifies the target percentage of high\-priority CPU the autoscaled instance
can utilize.

.TP 2m
\fB\-\-autoscaling\-storage\-target\fR=\fIAUTOSCALING_STORAGE_TARGET\fR

Specifies the target percentage of storage the autoscaled instance can utilize.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-asymmetric\-autoscaling\-option\fR=[\fIdisable_high_priority_cpu_autoscaling\fR=\fIDISABLE_HIGH_PRIORITY_CPU_AUTOSCALING\fR],[\fIdisable_total_cpu_autoscaling\fR=\fIDISABLE_TOTAL_CPU_AUTOSCALING\fR],[\fIhigh_priority_cpu_target\fR=\fIHIGH_PRIORITY_CPU_TARGET\fR],[\fIlocation\fR=\fILOCATION\fR],[\fImax_nodes\fR=\fIMAX_NODES\fR],[\fImax_processing_units\fR=\fIMAX_PROCESSING_UNITS\fR],[\fImin_nodes\fR=\fIMIN_NODES\fR],[\fImin_processing_units\fR=\fIMIN_PROCESSING_UNITS\fR],[\fItotal_cpu_target\fR=\fITOTAL_CPU_TARGET\fR]

Specifies the asymmetric autoscaling option for the instance.

.TP 2m
\fB\-\-clear\-asymmetric\-autoscaling\-option\fR=\fILOCATION\fR,[\fILOCATION\fR,...]

Specify a comma separated list of locations from which to remove asymmetric
autoscaling options

.RE
.sp
.TP 2m

Autoscaling limits can be defined in either nodes or processing units.

At most one of these can be specified:


.RS 2m
.TP 2m

Autoscaling limits in nodes:


.RS 2m
.TP 2m
\fB\-\-autoscaling\-max\-nodes\fR=\fIAUTOSCALING_MAX_NODES\fR

Maximum number of nodes for the autoscaled instance.

.TP 2m
\fB\-\-autoscaling\-min\-nodes\fR=\fIAUTOSCALING_MIN_NODES\fR

Minimum number of nodes for the autoscaled instance.

.RE
.sp
.TP 2m

Autoscaling limits in processing units:


.RS 2m
.TP 2m
\fB\-\-autoscaling\-max\-processing\-units\fR=\fIAUTOSCALING_MAX_PROCESSING_UNITS\fR

Maximum number of processing units for the autoscaled instance.

.TP 2m
\fB\-\-autoscaling\-min\-processing\-units\fR=\fIAUTOSCALING_MIN_PROCESSING_UNITS\fR

Minimum number of processing units for the autoscaled instance.


.RE
.RE
.RE
.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 instances update
.RE

.RS 2m
$ gcloud beta spanner instances update
.RE