Configure Spanner in Application Design Center

Spanner is a fully managed, mission-critical database service that brings together relational, graph, key-value, and search. Spanner offers transactional consistency at global scale, automatic, synchronous replication for high availability, and support for the following SQL dialects:

GoogleSQL
PostgreSQL

For more information, see Instances overview .

This document describes the connections and parameters you can configure when using App Design Center to create a Spanner instance. The configuration parameters are based on the terraform-google-cloud-spanner Terraform module.

Component connections

The following table includes the components that you can connect to a Spanner instance, and the resulting updates to your application and its generated Terraform code.

Connected component

Application updates

Background information

Compute Engine instance template

The Compute Engine instances can read and write data in the Spanner instance.
The roles/spanner.databaseAdmin role is added to the Compute Engine instance template service account.
The Compute Engine service account is added as an IAM user to the Spanner instance.

Using Spanner in a virtual machine instance

Service account

The service account has access to the Spanner instance.
The service account is added as an IAM user to the Spanner instance.

Configure an instance with a service account

Cloud Run

The Cloud Run service can manage the Spanner instance.
The Spanner connection details are added to the Cloud Run environment variables.
The roles/spanner.databaseAdmin role is added to the Cloud Run service account.
The Cloud Run service account IAM information is added to the Spanner instance.

Connect to Google Cloud services

Required configuration parameters

If your template includes a Spanner component, you must configure the following parameters before you deploy.

Parameter name	Description and constraints	Background information
Project ID	The project where you want to deploy the Spanner instance.	Configure components
Instance Name	A unique identifier for the instance, which cannot be changed after the instance is created. The name must be between 6 and 30 characters in length.	name
Instance Config	config	Instance configurations

Optional configuration parameters

The following parameters are optional. To display advanced parameters, in the Configurationarea, select Show advanced fields.

Feature

Parameter name

Description and constraint information

Background information

Instance Size

Num Nodes

nodeCount

Compute capacity, nodes and processing units

Processing Units

processingUnits

Compute capacity, nodes and processing units

Instance Display Name

displayName

Change the display name

Create Instance

By default, a new Spanner instance is created. Clear the checkbox to use an existing instance.

Create and manage instances

Enable Autoscaling

Select to enable autoscaling on the Spanner instance.

Autoscaling overview

Instance IAM

A comma-separated list of permissions on the instance. For example, user:user1@cymbalgroup.com=>roles/spanner.databaseAdmin, user:user2@cymbalgroup.com=>roles/spanner.databaseAdmin

IAM overview

Instance Labels

Key

labels

Label an instance

Value

labels

Label an instance

Database Config

Key

The database_config map object key.

database_config

Version Retention Period

versionRetentionPeriod

Point-in-time (PITR) recovery overview

DDL

ddl

GoogleSQL or PostgreSQL

KMS Key Name

kmsKeyName

Customer-managed encryption keys (CMEK) overview

Deletion Protection

Select to prevent Terraform from deleting the database.

deletion_protection

Database IAM

A comma-separated list of permissions on the database. For example, user:user1@cymbalgroup.com=>roles/spanner.databaseAdmin, user:user2@cymbalgroup.com=>roles/spanner.databaseAdmin

IAM overview

Enable Backup

By default, an automated database backup is created. If you don't want a backup, clear the checkbox.

Backups overview

Backup Retention

retentionDuration

Incremental backups

Create DB

By default, a database is created. If you don't want a database, clear the checkbox.

Databases overview

Cron Spec Text

text

Create and manage backup schedules

Min Processing Units

minProcessingUnits

Managed autoscaler

Max Processing Units

maxProcessingUnits

Managed autoscaler

Min Nodes

minNodes

Managed autoscaler

Max Nodes

maxNodes

Managed autoscaler

High Priority CPU Utilization Percent

highPriorityCpuUtilizationPercent

Managed autoscaler

Storage Utilization Percent

storageUtilizationPercent

Managed autoscaler

Replica Location

location

Asymmetric read-only autoscaling

Override Min Nodes

AutoscalingConfigOverrides

Managed autoscaler parameters

Override Max Nodes

AutoscalingConfigOverrides

Managed autoscaler parameters

Edition

Edition

Spanner editions overview

Default Backup Schedule Type

defaultBackupScheduleType

Default backup schedules

Force Destroy

Select to delete backups when you delete the Spanner instance.

force_destroy

Use Full Backup Spec

fullBackupSpec

Backup schedules

Use Incremental Backup Spec

incrementalBackupSpec

Incremental backups