gcloud beta spanner instances update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta spanner instances update - update a Cloud Spanner instance
- SYNOPSIS
gcloud beta spanner instances updateINSTANCE[--async][--default-backup-schedule-type=DEFAULT_BACKUP_SCHEDULE_TYPE][--description=DESCRIPTION][--edition=EDITION][--expire-behavior=EXPIRE_BEHAVIOR][--instance-type=INSTANCE_TYPE][--nodes=NODES|--processing-units=PROCESSING_UNITS|--autoscaling-high-priority-cpu-target=AUTOSCALING_HIGH_PRIORITY_CPU_TARGET--autoscaling-storage-target=AUTOSCALING_STORAGE_TARGET--asymmetric-autoscaling-option=[disable_high_priority_cpu_autoscaling=DISABLE_HIGH_PRIORITY_CPU_AUTOSCALING],[disable_total_cpu_autoscaling=DISABLE_TOTAL_CPU_AUTOSCALING],[high_priority_cpu_target=HIGH_PRIORITY_CPU_TARGET],[location=LOCATION],[max_nodes=MAX_NODES],[max_processing_units=MAX_PROCESSING_UNITS],[min_nodes=MIN_NODES],[min_processing_units=MIN_PROCESSING_UNITS],[total_cpu_target=TOTAL_CPU_TARGET] |--clear-asymmetric-autoscaling-option=LOCATION,[LOCATION,…]--autoscaling-max-nodes=AUTOSCALING_MAX_NODES--autoscaling-min-nodes=AUTOSCALING_MIN_NODES|--autoscaling-max-processing-units=AUTOSCALING_MAX_PROCESSING_UNITS--autoscaling-min-processing-units=AUTOSCALING_MIN_PROCESSING_UNITS][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Update a Cloud Spanner instance.- EXAMPLES
- To update the display name of a Cloud Spanner instance, run:
gcloudbetaspannerinstancesupdatemy-instance-id--description=my-new-display-nameTo update the node count of a Cloud Spanner instance, run:
gcloudbetaspannerinstancesupdatemy-instance-id--nodes=1 - POSITIONAL ARGUMENTS
INSTANCE- Cloud Spanner instance ID.
- FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--default-backup-schedule-type=DEFAULT_BACKUP_SCHEDULE_TYPE- The default backup schedule type that is used in the instance.
DEFAULT_BACKUP_SCHEDULE_TYPEmust be one of:AUTOMATIC- A default backup schedule is created automatically when a new database iscreated in an instance. You can edit or delete the default backup schedule onceit's created. The default backup schedule creates a full backup every 24 hours.These full backups are retained for 7 days.
DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED- Not specified.
NONE- No default backup schedule is created automatically when a new database iscreated in an instance.
--description=DESCRIPTION- Description of the instance.
--edition=EDITION- Spanner edition. You can upgrade your Standard edition instance to the
ENTERPRISEedition orENTERPRISE_PLUSedition. You canalso upgrade your Enterprise edition instance to theENTERPRISE_PLUSedition. You can downgrade yourENTERPRISE_PLUSedition instance to theENTERPRISEorSTANDARDedition. You can also downgrade yourENTERPRISEedition instance to theSTANDARDedition.You must stop using the higher-tier edition features in order to downgrade.Otherwise, downgrade fails. For more information, seeSpanner editionsoverview. --expire-behavior=EXPIRE_BEHAVIOR- The expire behavior of a free trial instance.
EXPIRE_BEHAVIORmust be one of:free-to-provisioned- When the free trial instance expires, upgrade the instance to a provisionedinstance.
remove-after-grace-period- When the free trial instance expires, disable the instance, and delete it afterthe grace period passes if it has not been upgraded to a provisioned instance.
--instance-type=INSTANCE_TYPE- Specifies the type for this instance.
INSTANCE_TYPEmustbe one of:free-instance- Free trial instances provide no guarantees for dedicated resources, bothnode_count and processing_units should be 0. They come with stricter usagelimits and limited support.
provisioned- Provisioned instances have dedicated resources, standard usage limits, andsupport.
- At most one of these can be specified:
--nodes=NODES- Number of nodes for the instance.
--processing-units=PROCESSING_UNITS- Number of processing units for the instance.
- Autoscaling
--autoscaling-high-priority-cpu-target=AUTOSCALING_HIGH_PRIORITY_CPU_TARGET- Specifies the target percentage of high-priority CPU the autoscaled instance canutilize.
--autoscaling-storage-target=AUTOSCALING_STORAGE_TARGET- Specifies the target percentage of storage the autoscaled instance can utilize.
- At most one of these can be specified:
--asymmetric-autoscaling-option=[disable_high_priority_cpu_autoscaling=DISABLE_HIGH_PRIORITY_CPU_AUTOSCALING],[disable_total_cpu_autoscaling=DISABLE_TOTAL_CPU_AUTOSCALING],[high_priority_cpu_target=HIGH_PRIORITY_CPU_TARGET],[location=LOCATION],[max_nodes=MAX_NODES],[max_processing_units=MAX_PROCESSING_UNITS],[min_nodes=MIN_NODES],[min_processing_units=MIN_PROCESSING_UNITS],[total_cpu_target=TOTAL_CPU_TARGET]- Specifies the asymmetric autoscaling option for the instance.
--clear-asymmetric-autoscaling-option=LOCATION,[LOCATION,…]- Specify a comma separated list of locations from which to remove asymmetricautoscaling options
- Autoscaling limits can be defined in either nodes or processing units.
At most one of these can be specified:
- Autoscaling limits in nodes:
--autoscaling-max-nodes=AUTOSCALING_MAX_NODES- Maximum number of nodes for the autoscaled instance.
--autoscaling-min-nodes=AUTOSCALING_MIN_NODES- Minimum number of nodes for the autoscaled instance.
- Autoscaling limits in processing units:
--autoscaling-max-processing-units=AUTOSCALING_MAX_PROCESSING_UNITS- Maximum number of processing units for the autoscaled instance.
--autoscaling-min-processing-units=AUTOSCALING_MIN_PROCESSING_UNITS- Minimum number of processing units for the autoscaled instance.
- Autoscaling limits in nodes:
- 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 helpfor details. - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudspannerinstancesupdategcloudalphaspannerinstancesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-16 UTC.