terraform-provider-google/website/docs/r/bigtable_instance.html.markdown
Paddy Carver f743cc057b Only one cluster, max.
Only allow one cluster for bigtable instances. We can expand to 2 for
2.0.0.
2018-10-03 18:01:26 -07:00

2.7 KiB

layout page_title sidebar_current description
google Google: google_bigtable_instance docs-google-bigtable-instance Creates a Google Bigtable instance.

google_bigtable_instance

Creates a Google Bigtable instance. For more information see the official documentation and API.

Example Usage

resource "google_bigtable_instance" "instance" {
  name         = "tf-instance"
  cluster {
    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 Cloud Bigtable instance.

  • instance_type - (Optional) The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

  • project - (Optional) The ID of 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.

  • 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.

  • cluster_id - (Optional, Deprecated) The ID of the Cloud Bigtable cluster. Use cluster.cluster_id instead.

  • 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. Use cluster.zone instead.

  • 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.

  • storage_type - (Optional, Deprecated) The storage type to use. One of "SSD" or "HDD". Defaults to "SSD". Use cluster.storage_type instead.


cluster supports the following arguments:

  • cluster_id - (Required) The ID of the Cloud Bigtable cluster.

  • zone - (Optional) The zone to create the Cloud Bigtable cluster in. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

  • 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.

  • storage_type - (Optional) The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

Attributes Reference

Only the arguments listed above are exposed as attributes.