Skip to content

Commit c176d93

Browse files
authored
Merge pull request hashicorp#2161 from terraform-providers/paddy_bigtable_clusters
Move Bigtable config to cluster block.
2 parents 8698ef6 + 581cd4c commit c176d93

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

docs/r/bigtable_instance.html.markdown

+28-12
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,12 @@ Creates a Google Bigtable instance. For more information see
1818
```hcl
1919
resource "google_bigtable_instance" "instance" {
2020
name = "tf-instance"
21-
cluster_id = "tf-instance-cluster"
22-
zone = "us-central1-b"
23-
num_nodes = 3
24-
storage_type = "HDD"
21+
cluster {
22+
cluster_id = "tf-instance-cluster"
23+
zone = "us-central1-b"
24+
num_nodes = 3
25+
storage_type = "HDD"
26+
}
2527
}
2628
```
2729

@@ -31,21 +33,35 @@ The following arguments are supported:
3133

3234
* `name` - (Required) The name of the Cloud Bigtable instance.
3335

34-
* `cluster_id` - (Required) The ID of the Cloud Bigtable cluster.
35-
36-
* `zone` - (Required) The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the [Cloud Bigtable locations page](https://cloud.google.com/bigtable/docs/locations).
37-
38-
* `num_nodes` - (Optional) The number of nodes in your Cloud Bigtable cluster. Minimum of `3` for a `PRODUCTION` instance. Cannot be set for a `DEVELOPMENT` instance.
39-
4036
* `instance_type` - (Optional) The instance type to create. One of `"DEVELOPMENT"` or `"PRODUCTION"`. Defaults to `"PRODUCTION"`.
4137

42-
* `storage_type` - (Optional) The storage type to use. One of `"SSD"` or `"HDD"`. Defaults to `"SSD"`.
43-
4438
* `project` - (Optional) The ID of the project in which the resource belongs. If it
4539
is not provided, the provider project is used.
4640

4741
* `display_name` - (Optional) The human-readable display name of the Bigtable instance. Defaults to the instance `name`.
4842

43+
* `cluster` - (Optional) A block of cluster configuration options. Either `cluster` or `cluster_id` must be used. Only one cluster may be specified. See structure below.
44+
45+
* `cluster_id` - (Optional, Deprecated) The ID of the Cloud Bigtable cluster. Use `cluster.cluster_id` instead.
46+
47+
* `zone` - (Optional, Deprecated) The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the [Cloud Bigtable locations page](https://cloud.google.com/bigtable/docs/locations). Use `cluster.zone` instead.
48+
49+
* `num_nodes` - (Optional, Deprecated) The number of nodes in your Cloud Bigtable cluster. Minimum of `3` for a `PRODUCTION` instance. Cannot be set for a `DEVELOPMENT` instance. Use `cluster.num_nodes` instead.
50+
51+
* `storage_type` - (Optional, Deprecated) The storage type to use. One of `"SSD"` or `"HDD"`. Defaults to `"SSD"`. Use `cluster.storage_type` instead.
52+
53+
-----
54+
55+
`cluster` supports the following arguments:
56+
57+
* `cluster_id` - (Required) The ID of the Cloud Bigtable cluster.
58+
59+
* `zone` - (Optional) The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the [Cloud Bigtable locations page](https://cloud.google.com/bigtable/docs/locations).
60+
61+
* `num_nodes` - (Optional) The number of nodes in your Cloud Bigtable cluster. Minimum of `3` for a `PRODUCTION` instance. Cannot be set for a `DEVELOPMENT` instance.
62+
63+
* `storage_type` - (Optional) The storage type to use. One of `"SSD"` or `"HDD"`. Defaults to `"SSD"`.
64+
4965
## Attributes Reference
5066

5167
Only the arguments listed above are exposed as attributes.

0 commit comments

Comments
 (0)