Google Cloud Bigtable Instance IAM

This page shows how to write Terraform for Cloud Bigtable Instance IAM and write them securely.

google_bigtable_instance_iam (Terraform)

The Instance IAM in Cloud Bigtable can be configured in Terraform with the resource name google_bigtable_instance_iam. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


The following arguments are supported:

  • instance - (Required) The name or relative resource id of the instance to manage IAM policies for.

For google_bigtable_instance_iam_member or google_bigtable_instance_iam_binding:

  • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:[emailid]: An email address that represents a specific Google account. For example, or
    • serviceAccount:[emailid]: An email address that represents a service account. For example,
    • group:[emailid]: An email address that represents a Google group. For example,
    • domain:[domain]: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, or
  • role - (Required) The role that should be applied. Only one google_bigtable_instance_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/[parent-name]/roles/[role-name]. Read more about roles here.

google_bigtable_instance_iam_policy only:

  • policy_data - (Required) The policy data generated by a google_iam_policy data source.

  • project - (Optional) The project in which the instance belongs. If it is not provided, Terraform will use the provider default.

In addition to the arguments listed above, the following computed attributes are exported:

  • etag - (Computed) The etag of the instances's IAM policy.

Explanation in Terraform Registry

Three different resources help you manage IAM policies on bigtable instances. Each of these resources serves a different use case:

  • google_bigtable_instance_iam_policy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
  • google_bigtable_instance_iam_binding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.
  • google_bigtable_instance_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.

    Note: google_bigtable_instance_iam_policy cannot be used in conjunction with google_bigtable_instance_iam_binding and google_bigtable_instance_iam_member or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the instance as google_bigtable_instance_iam_policy replaces the entire policy.

    Note: google_bigtable_instance_iam_binding resources can be used in conjunction with google_bigtable_instance_iam_member resources only if they do not grant privilege to the same role.

Frequently asked questions

What is Google Cloud Bigtable Instance IAM?

Google Cloud Bigtable Instance IAM is a resource for Cloud Bigtable of Google Cloud Platform. Settings can be wrote in Terraform.


Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.