# Google Cloud BigTable Module
This module allows managing a single BigTable instance, including access configuration and tables.
## TODO
- [ ] support bigtable_gc_policy
- [ ] support bigtable_app_profile
## Examples
### Simple instance with access configuration
```hcl
module "bigtable-instance" {
source = "./modules/bigtable-instance"
project_id = "my-project"
name = "instance"
cluster_id = "instance"
zone = "europe-west1-b"
tables = {
test1 = null,
test2 = {
split_keys = ["a", "b", "c"]
column_family = null
}
}
iam = {
"roles/bigtable.user" = ["user:viewer@testdomain.com"]
}
}
# tftest modules=1 resources=4
```
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [name](variables.tf#L45) | The name of the Cloud Bigtable instance. | string
| ✓ | |
| [project_id](variables.tf#L56) | Id of the project where datasets will be created. | string
| ✓ | |
| [zone](variables.tf#L88) | The zone to create the Cloud Bigtable cluster in. | string
| ✓ | |
| [cluster_id](variables.tf#L17) | The ID of the Cloud Bigtable cluster. | string
| | "europe-west1"
|
| [deletion_protection](variables.tf#L23) | Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. |
| | true
|
| [display_name](variables.tf#L28) | The human-readable display name of the Bigtable instance. |
| | null
|
| [iam](variables.tf#L33) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string))
| | {}
|
| [instance_type](variables.tf#L39) | (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. | string
| | null
|
| [num_nodes](variables.tf#L50) | The number of nodes in your Cloud Bigtable cluster. | number
| | 1
|
| [storage_type](variables.tf#L61) | The storage type to use. | string
| | "SSD"
|
| [table_options_defaults](variables.tf#L67) | Default option of tables created in the BigTable instance. | object({…})
| | {…}
|
| [tables](variables.tf#L79) | Tables to be created in the BigTable instance, options can be null. | map(object({…}))
| | {}
|
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [id](outputs.tf#L17) | An identifier for the resource with format projects/{{project}}/instances/{{name}}. | |
| [instance](outputs.tf#L26) | BigTable intance. | |
| [table_ids](outputs.tf#L35) | Map of fully qualified table ids keyed by table name. | |
| [tables](outputs.tf#L40) | Table resources. | |