gcloud beta spanner instances create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta spanner instances create - create a Cloud Spanner instance
- SYNOPSIS
gcloud beta spanner instances createINSTANCE--config=CONFIG--description=DESCRIPTION[--async][--default-backup-schedule-type=DEFAULT_BACKUP_SCHEDULE_TYPE][--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) :--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]]][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Create a Cloud Spanner instance.- EXAMPLES
- To create a Cloud Spanner instance, run:
gcloudbetaspannerinstancescreatemy-instance-id--config=regional-us-east1--description=my-instance-display-name--nodes=3 - POSITIONAL ARGUMENTS
INSTANCE- Cloud Spanner instance ID.
- REQUIRED FLAGS
--config=CONFIG- Instance configuration defines the geographic placement and replication of thedatabases in that instance. Available configurations can be found by running"gcloud spanner instance-configs list"
--description=DESCRIPTION- Description of the instance.
- OPTIONAL 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.
--edition=EDITION- Spanner edition.
EDITIONmust be one of:EDITION_UNSPECIFIED- Spanner's legacy pricing model. For more information, see theSpanner editionsoverview
ENTERPRISE- Enterprise edition
ENTERPRISE_PLUS- Enterprise Plus edition
STANDARD- Standard edition
--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.
This flag argument must be specified if any of the other arguments in this groupare specified.
--autoscaling-storage-target=AUTOSCALING_STORAGE_TARGET- Specifies the target percentage of storage the autoscaled instance can utilize.
This flag argument must be specified if any of the other arguments in this groupare 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.
- Autoscaling limits can be defined in either nodes or processing units.
Exactly one of these must be specified:
- Autoscaling limits in nodes:
--autoscaling-max-nodes=AUTOSCALING_MAX_NODES- Maximum number of nodes for the autoscaled instance.
This flag argument must be specified if any of the other arguments in this groupare specified.
--autoscaling-min-nodes=AUTOSCALING_MIN_NODES- Minimum number of nodes for the autoscaled instance.
This flag argument must be specified if any of the other arguments in this groupare specified.
- Autoscaling limits in processing units:
--autoscaling-max-processing-units=AUTOSCALING_MAX_PROCESSING_UNITS- Maximum number of processing units for the autoscaled instance.
This flag argument must be specified if any of the other arguments in this groupare specified.
--autoscaling-min-processing-units=AUTOSCALING_MIN_PROCESSING_UNITS- Minimum number of processing units for the autoscaled instance.
This flag argument must be specified if any of the other arguments in this groupare specified.
- 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:
gcloudspannerinstancescreategcloudalphaspannerinstancescreate
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.