App Design Center lets you configure connections and parameters
to provision [Bigtable](https://docs.cloud.google.com/bigtable/docs/overview) instances based on the
[terraform-google-bigtable](https://github.com/GoogleCloudPlatform/terraform-google-bigtable)
Terraform module. This setup provides low-latency key-value and wide-column
storage for high-throughput workloads such as clickstream data, IoT telemetry,
and machine learning.

## Component connections

The following table lists components you can connect to a Bigtable
instance and the resulting updates to your application and Terraform code.

| Connected component | Application updates | Background information |
|---|---|---|
| [Compute Engine instance template](https://docs.cloud.google.com/application-design-center/docs/configure-compute-engine-instance) | - The Compute Engine instances can connect to and manage the Bigtable instance. - The Bigtable resource metadata is added to the Compute Engine instance template. - The `roles/bigtable.admin` role is added to the Compute Engine instance template service account. | [Bigtable overview](https://docs.cloud.google.com/bigtable/docs/overview) |
| [Cloud Run](https://docs.cloud.google.com/application-design-center/docs/configure-cloud-run) | - The Cloud Run service can perform administrative functions on the Bigtable instance. - The Bigtable resource metadata is added to the Cloud Run environment variables. - The `roles/bigtable.admin` role is added to the Cloud Run service account. | [What is Cloud Run](https://docs.cloud.google.com/run/docs/overview/what-is-cloud-run) |

## Required configuration parameters

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

| Parameter name | Description and constraints | Background information |
|---|---|---|
| **Project ID** | The project where you deploy the Bigtable instance. | [Configure components](https://docs.cloud.google.com/application-design-center/docs/design-application-templates#configure_components) |
| **Name** | [name](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances#Instance.FIELDS.name) | [name](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_instance#name-2) |

## Optional configuration parameters

The following parameters are optional. To display advanced parameters, in the
**Configuration** area, select **Show advanced fields**.

| Feature | Subfeature | Parameter name | Description and constraint information | Background information |
|---|---|---|---|---|
|   |   | **Display Name** | [displayName](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances#Instance.FIELDS.display_name) | [display_name](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_instance#display_name-1) |
| Zones |   | **Key** | The `zones` map object key. | [zones](https://github.com/GoogleCloudPlatform/terraform-google-bigtable/tree/main?tab=readme-ov-file#inputs) |
| Zones |   | **Zone** | [location](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#Cluster.FIELDS.location) | [Bigtable locations](https://docs.cloud.google.com/bigtable/docs/locations) |
| Zones |   | **Cluster ID** | [clusterID](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters/create#body.QUERY_PARAMETERS.cluster_id) | [cluster_id](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_instance#cluster_id-1) |
| Zones |   | **Num Nodes** | [serveNodes](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#Cluster.FIELDS.serve_nodes) | [Nodes](https://docs.cloud.google.com/bigtable/docs/instances-clusters-nodes#nodes) |
| Zones |   | **KMS Key Name** | [kmsKeyName](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#EncryptionConfig.FIELDS.kms_key_name) | [Customer-managed encryption keys (CMEK)](https://docs.cloud.google.com/bigtable/docs/cmek) |
| Zones | Autoscaling Config | **Min Nodes** | [minServeNodes](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#AutoscalingLimits.FIELDS.min_serve_nodes) | [Determine the minimum number of nodes](https://docs.cloud.google.com/bigtable/docs/autoscaling#determine-min) |
| Zones | Autoscaling Config | **Max Nodes** | [maxServeNodes](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#AutoscalingLimits.FIELDS.max_serve_nodes) | [Determine the maximum number of nodes](https://docs.cloud.google.com/bigtable/docs/autoscaling#determine-max) |
| Zones | Autoscaling Config | **CPU Target** | [cpuUtilizationPercent](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#AutoscalingTargets.FIELDS.cpu_utilization_percent) | [Determine the CPU utilization target](https://docs.cloud.google.com/bigtable/docs/autoscaling#determine-cpu) |
| Zones | Autoscaling Config | **Storage Target** | [storageUtilizationGibPerNode](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#AutoscalingTargets.FIELDS.storage_utilization_gib_per_node) | [Determine the storage utilization target](https://docs.cloud.google.com/bigtable/docs/autoscaling#determine-storage-utilization) |
| Tables |   | **Key** | The `tables` map object key. | [tables](https://github.com/GoogleCloudPlatform/terraform-google-bigtable/tree/main?tab=readme-ov-file#inputs) |
| Tables |   | **Table Name** | [name](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#Table.FIELDS.name) | [name](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_table#name-3) |
| Tables |   | **Split Keys** | [split_keys](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_table#split_keys-2) | [Optional: Split the table by row key](https://docs.cloud.google.com/bigtable/docs/managing-tables#splits) |
| Tables |   | **Deletion Protection** | [deletion_protection](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_table#deletion_protection-1) | [Modify deletion protection](https://docs.cloud.google.com/bigtable/docs/managing-tables#modify-deletion-protection) |
| Tables |   | **Change Stream Retention** | [retentionPeriod](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#changestreamconfig) | [Change streams overview](https://docs.cloud.google.com/bigtable/docs/change-streams-overview) |
| Tables | Automated Backup Policy | **Retention Period** | [retentionPeriod](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#AutomatedBackupPolicy.FIELDS.retention_period) | [Use automated backup](https://docs.cloud.google.com/bigtable/docs/managing-backups#use-automated-backup) |
| Tables | Automated Backup Policy | **Frequency** | [frequency](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#AutomatedBackupPolicy.FIELDS.frequency) | [Use automated backup](https://docs.cloud.google.com/bigtable/docs/managing-backups#use-automated-backup) |
| Tables | Column Family | **Key** | The `column_family` map object key, which is in the `tables` object. | [column_family](https://github.com/GoogleCloudPlatform/terraform-google-bigtable/tree/main?tab=readme-ov-file#inputs) |
| Tables | Column Family | **Family** | [family](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#columnfamily) | [Column families](https://docs.cloud.google.com/bigtable/docs/schema-design#column-families) |
|   |   | **Deletion Protection** | When selected, a `terraform apply` or `terraform destroy` that would delete the instance fails. When not selected, the instance can be deleted. | [deletion_protection](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/bigtable_instance.html#deletion_protection-1) |
|   |   | **Storage Type** | [defaultStorageType](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#Cluster.FIELDS.default_storage_type) | [Choose between SSD and HDD storage](https://docs.cloud.google.com/bigtable/docs/choosing-ssd-hdd) |
| Labels |   | **Key** | [labels](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances#Instance.FIELDS.labels) | [Create and manage instance labels](https://docs.cloud.google.com/bigtable/docs/creating-managing-labels) |
| Labels |   | **Value** | [labels](https://docs.cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances#Instance.FIELDS.labels) | [Create and manage instance labels](https://docs.cloud.google.com/bigtable/docs/creating-managing-labels) |