- NAME
-
- gcloud alpha spanner instances update - update a Cloud Spanner instance
- SYNOPSIS
-
-
gcloud alpha spanner instances update
INSTANCE
[--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
--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
-
(ALPHA)
Update a Cloud Spanner instance. - EXAMPLES
-
To update the display name of a Cloud Spanner instance, run:
gcloud alpha spanner instances update my-instance-id --description=my-new-display-name
To update the node count of a Cloud Spanner instance, run:
gcloud alpha 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.
--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.
--description
=DESCRIPTION
- Description of the instance.
--edition
=EDITION
-
Cloud Spanner edition. You can upgrade your Standard edition instance to the
ENTERPRISE
edition orENTERPRISE_PLUS
edition. You can also upgrade your Enterprise edition instance to theENTERPRISE_PLUS
edition. Self-service downgrade isn't available. To downgrade the edition of your instance, file a support ticket. For more information, see the Spanner editions overview --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.
-
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 (Preview)
--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.
-
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 help
for details. - 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:
gcloud spanner instances update
gcloud beta spanner instances update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-12 UTC.