» IAM policy for Spanner Instances

Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:

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

» google_spanner_instance_iam_policy

data "google_iam_policy" "admin" {
  binding {
    role = "roles/editor"

    members = [
      "user:jane@example.com",
    ]
  }
}

resource "google_spanner_instance_iam_policy" "instance" {
  instance    = "your-instance-name"
  policy_data = data.google_iam_policy.admin.policy_data
}

» google_spanner_instance_iam_binding

resource "google_spanner_instance_iam_binding" "instance" {
  instance = "your-instance-name"
  role     = "roles/compute.networkUser"

  members = [
    "user:jane@example.com",
  ]
}

» google_spanner_instance_iam_member

resource "google_spanner_instance_iam_member" "instance" {
  instance = "your-instance-name"
  role     = "roles/compute.networkUser"
  member   = "user:jane@example.com"
}

» Argument Reference

The following arguments are supported:

  • instance - (Required) The name of the instance.

  • 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, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
  • role - (Required) The role that should be applied. Only one google_spanner_instance_iam_binding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

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

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

» Attributes Reference

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

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

» Import

For all import syntaxes, the "resource in question" can take any of the following forms:

  • {{project}}/{{name}}
  • {{name}} (project is taken from provider project)

IAM member imports use space-delimited identifiers; the resource in question, the role, and the account, e.g.

$ terraform import google_spanner_instance_iam_member.instance "project-name/instance-name roles/viewer user:foo@example.com"

IAM binding imports use space-delimited identifiers; the resource in question and the role, e.g.

$ terraform import google_spanner_instance_iam_binding.instance "project-name/instance-name roles/viewer"

IAM policy imports use the identifier of the resource in question, e.g.

$ terraform import google_spanner_instance_iam_policy.instance project-name/instance-name