2017-06-15 17:41:05 +00:00
---
layout: "google"
page_title: "Google: google_bigtable_instance"
2017-07-05 18:32:26 +00:00
sidebar_current: "docs-google-bigtable-instance"
2017-06-15 17:41:05 +00:00
description: |-
Creates a Google Bigtable instance.
---
# google_bigtable_instance
Creates a Google Bigtable instance. For more information see
[the official documentation ](https://cloud.google.com/bigtable/ ) and
[API ](https://cloud.google.com/bigtable/docs/go/reference ).
2018-11-05 16:45:11 +00:00
## Example Usage - Production Instance
2017-06-15 17:41:05 +00:00
```hcl
2018-11-05 16:45:11 +00:00
resource "google_bigtable_instance" "production-instance" {
2017-06-26 20:33:05 +00:00
name = "tf-instance"
2018-11-05 16:45:11 +00:00
2018-10-03 23:37:24 +00:00
cluster {
cluster_id = "tf-instance-cluster"
zone = "us-central1-b"
num_nodes = 3
storage_type = "HDD"
}
2017-06-15 17:41:05 +00:00
}
```
2018-11-05 16:45:11 +00:00
## Example Usage - Development Instance
```hcl
resource "google_bigtable_instance" "development-instance" {
name = "tf-instance"
instance_type = "DEVELOPMENT"
cluster {
cluster_id = "tf-instance-cluster"
zone = "us-central1-b"
storage_type = "HDD"
}
}
```
2017-06-15 17:41:05 +00:00
## Argument Reference
The following arguments are supported:
2018-10-23 22:40:29 +00:00
* `name` - (Required) The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.
2017-06-15 17:41:05 +00:00
2018-10-23 22:40:29 +00:00
* `cluster` - (Required) A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.
-----
2017-06-15 17:41:05 +00:00
2018-03-12 20:59:47 +00:00
* `project` - (Optional) The ID of the project in which the resource belongs. If it
2017-06-15 17:41:05 +00:00
is not provided, the provider project is used.
2018-10-23 22:40:29 +00:00
* `instance_type` - (Optional) The instance type to create. One of `"DEVELOPMENT"` or `"PRODUCTION"` . Defaults to `"PRODUCTION"` .
2018-10-03 23:37:24 +00:00
2018-10-23 22:40:29 +00:00
* `display_name` - (Optional) The human-readable display name of the Bigtable instance. Defaults to the instance `name` .
2018-10-03 23:37:24 +00:00
-----
2018-10-23 22:40:29 +00:00
The `cluster` block supports the following arguments:
2018-10-03 23:37:24 +00:00
* `cluster_id` - (Required) The ID of the Cloud Bigtable cluster.
2018-10-23 22:40:29 +00:00
* `zone` - (Required) The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the [Cloud Bigtable locations page ](https://cloud.google.com/bigtable/docs/locations ).
2018-10-03 23:37:24 +00:00
2018-11-05 16:45:11 +00:00
* `num_nodes` - (Optional) The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of `3` for a `PRODUCTION` instance. Must be left unset for a `DEVELOPMENT` instance.
2018-10-03 23:37:24 +00:00
* `storage_type` - (Optional) The storage type to use. One of `"SSD"` or `"HDD"` . Defaults to `"SSD"` .
2017-06-15 17:41:05 +00:00
## Attributes Reference
Only the arguments listed above are exposed as attributes.