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

layout	page_title	sidebar_current	description
google	Google: google_pubsub_topic_iam	docs-google-pubsub-topic-iam	Collection of resources to manage IAM policy for a Pubsub Topic.

IAM policy for Pubsub Topic

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

• google_pubsub_topic_iam_policy: Authoritative. Sets the IAM policy for the topic and replaces any existing policy already attached.
• google_pubsub_topic_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 topic are preserved.
• google_pubsub_topic_iam_member: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the topic are preserved.

~> Note: google_pubsub_topic_iam_policy cannot be used in conjunction with google_pubsub_topic_iam_binding and google_pubsub_topic_iam_member or they will fight over what your policy should be.

~> Note: google_pubsub_topic_iam_binding resources can be used in conjunction with google_pubsub_topic_iam_member resources only if they do not grant privilege to the same role.

google_pubsub_topic_iam_policy

data "google_iam_policy" "admin" {
  binding {
    role    = "roles/editor"
    members = [
      "user:jane@example.com",
    ]
  }
}

resource "google_pubsub_topic_iam_policy" "editor" {
  topic       = "your-topic-name"
  policy_data = "${data.google_iam_policy.admin.policy_data}"
}

google_pubsub_topic_iam_binding

resource "google_pubsub_topic_iam_binding" "editor" {
  topic   = "your-topic-name"
  role    = "roles/editor"
  members = [
    "user:jane@example.com",
  ]
}

google_pubsub_topic_iam_member

resource "google_pubsub_topic_iam_member" "editor" {
  topic  = "your-topic-name"
  role   = "roles/editor"
  member = "user:jane@example.com"
}

Argument Reference

The following arguments are supported:

• topic - (Required) The topic name or id to bind to attach IAM policy to.

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

• 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_pubsub_topic_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_pubsub_topic_iam_policy) The policy data generated by a google_iam_policy data source.

Attributes Reference

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

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

Import

Pubsub topic IAM resources can be imported using the project, topic name, role and member.

$ terraform import google_pubsub_topic_iam_policy.editor projects/{your-project-id}/topics/{your-topic-name}

$ terraform import google_pubsub_topic_iam_binding.editor "projects/{your-project-id}/topics/{your-topic-name} roles/editor"

$ terraform import google_pubsub_topic_iam_member.editor "projects/{your-project-id}/topics/{your-topic-name} roles/editor jane@example.com"