terraform-provider-google/website/docs/r/bigtable_instance.html.markdown

50 lines
1.5 KiB
Markdown

---
layout: "google"
page_title: "Google: google_bigtable_instance"
sidebar_current: "docs-google-bigtable-instance"
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).
## Example Usage
```hcl
resource "google_bigtable_instance" "instance" {
name = "tf-instance"
cluster_id = "tf-instance-cluster"
zone = "us-central1-b"
num_nodes = 3
storage_type = "HDD"
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the Bigtable instance.
* `cluster_id` - (Required) The name of the Bigtable instance's cluster.
* `zone` - (Required) The zone to create the Bigtable instance in. Zones that support Bigtable instances are noted on the [Cloud Locations page](https://cloud.google.com/about/locations/).
* `num_nodes` - (Optional) The number of nodes in your Bigtable instance. Minimum of `3`. Defaults to `3`.
* `storage_type` - (Optional) The storage type to use. One of `"SSD"` or `"HDD"`. Defaults to `SSD`.
* `project` - (Optional) The project in which the resource belongs. If it
is not provided, the provider project is used.
* `display_name` - (Optional) The human-readable display name of the Bigtable instance. Defaults to the instance `name`.
## Attributes Reference
Only the arguments listed above are exposed as attributes.