1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-11 23:49:35 +00:00
gcloud-help/gcloud/spanner/instances/update

158 lines
6.5 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud spanner instances update - update a Cloud Spanner instance
SYNOPSIS
gcloud spanner instances update INSTANCE [--async]
2024-11-13 10:04:10 +00:00
[--default-backup-schedule-type=DEFAULT_BACKUP_SCHEDULE_TYPE]
2024-09-18 09:49:45 +00:00
[--description=DESCRIPTION] [--edition=EDITION]
[--expire-behavior=EXPIRE_BEHAVIOR] [--instance-type=INSTANCE_TYPE]
2025-01-15 09:50:59 +00:00
[--nodes=NODES | --processing-units=PROCESSING_UNITS
2025-01-23 10:02:29 +00:00
| --autoscaling-high-priority-cpu-target=AUTOSCALING_HIGH_PRIORITY_CPU_TARGET --autoscaling-storage-target=AUTOSCALING_STORAGE_TARGET --asymmetric-autoscaling-option=[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]
| --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]
2022-04-13 08:33:42 +00:00
[GCLOUD_WIDE_FLAG ...]
2022-03-01 04:29:52 +00:00
DESCRIPTION
Update a Cloud Spanner instance.
EXAMPLES
To update the display name of a Cloud Spanner instance, run:
$ gcloud spanner instances update my-instance-id \
--description=my-new-display-name
To update the node count of a Cloud Spanner instance, run:
$ gcloud spanner instances update my-instance-id --nodes=1
POSITIONAL ARGUMENTS
INSTANCE
Cloud Spanner instance ID.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
2024-11-13 10:04:10 +00:00
--default-backup-schedule-type=DEFAULT_BACKUP_SCHEDULE_TYPE
The default backup schedule type that is used in the instance.
DEFAULT_BACKUP_SCHEDULE_TYPE must be one of:
AUTOMATIC
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.
DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED
Not specified.
NONE
No default backup schedule is created automatically when a new
database is created in an instance.
2022-03-01 04:29:52 +00:00
--description=DESCRIPTION
Description of the instance.
2024-09-18 09:49:45 +00:00
--edition=EDITION
2025-01-23 10:02:29 +00:00
Spanner edition. You can upgrade your Standard edition instance to the
ENTERPRISE edition or ENTERPRISE_PLUS edition. You can also upgrade
your Enterprise edition instance to the ENTERPRISE_PLUS edition. You
can downgrade your ENTERPRISE_PLUS edition instance to the ENTERPRISE
or STANDARD edition. You can also downgrade your ENTERPRISE edition
instance to the STANDARD 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).
2024-09-18 09:49:45 +00:00
2022-08-24 09:45:53 +00:00
--expire-behavior=EXPIRE_BEHAVIOR
The expire behavior of a free trial instance. EXPIRE_BEHAVIOR must be
one of:
free-to-provisioned
When the free trial instance expires, upgrade the instance to a
provisioned instance.
remove-after-grace-period
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.
--instance-type=INSTANCE_TYPE
Specifies the type for this instance. INSTANCE_TYPE must be one of:
free-instance
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.
provisioned
Provisioned instances have dedicated resources, standard usage
limits, and support.
2022-04-13 08:33:42 +00:00
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.
2022-03-01 04:29:52 +00:00
2025-01-15 09:50:59 +00:00
Autoscaling
--autoscaling-high-priority-cpu-target=AUTOSCALING_HIGH_PRIORITY_CPU_TARGET
Specifies the target percentage of high-priority CPU the autoscaled
instance can utilize.
--autoscaling-storage-target=AUTOSCALING_STORAGE_TARGET
Specifies the target percentage of storage the autoscaled instance
can utilize.
2025-01-23 10:02:29 +00:00
At most one of these can be specified:
--asymmetric-autoscaling-option=[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]
Specify the asymmetric autoscaling option for the instance.
--clear-asymmetric-autoscaling-option=LOCATION,[LOCATION,...]
Specify a comma separated list of locations from which to remove
asymmetric autoscaling options
2025-01-15 09:50:59 +00:00
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.
2022-03-01 04:29:52 +00:00
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
These variants are also available:
$ gcloud alpha spanner instances update
$ gcloud beta spanner instances update