Three different resources help you manage your IAM policy for pubsub subscription. Each of these resources serves a different use case:
google_pubsub_subscription_iam_policy
: Authoritative. Sets the IAM policy for the subscription and replaces any existing policy already attached.google_pubsub_subscription_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 subscription are preserved.google_pubsub_subscription_iam_member
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subscription are preserved.data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
}
resource "google_pubsub_subscription_iam_policy" "editor" {
subscription = "your-subscription-name"
policy_data = data.google_iam_policy.admin.policy_data
}
resource "google_pubsub_subscription_iam_binding" "editor" {
subscription = "your-subscription-name"
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
resource "google_pubsub_subscription_iam_member" "editor" {
subscription = "your-subscription-name"
role = "roles/editor"
member = "user:jane@example.com"
}
The following arguments are supported:
subscription
- (Required) The subscription name or id to bind to attach IAM policy to.
member/members
- (Required) Identities that will be granted the privilege in role
.
Each entry can have one of the following values:
role
- (Required) The role that should be applied. Only one
google_pubsub_subscription_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_subscription_iam_policy
) The policy data generated by
a google_iam_policy
data source.
project
- (Optional) The project in which the resource belongs. If it
is not provided, the provider project is used.In addition to the arguments listed above, the following computed attributes are exported:
etag
- (Computed) The etag of the subscription's IAM policy.IAM member imports use space-delimited identifiers that contains the subscription
, role
, and member
. For example:
"projects/{{project_id}}/subscriptions/{{subscription}} roles/editor jane@example.com"
An import
block (Terraform v1.5.0 and later) can be used to import IAM members:
import {
id = "projects/{{project_id}}/subscriptions/{{subscription}} roles/editor jane@example.com"
to = google_pubsub_subscription_iam_member.default
}
The terraform import
command can also be used:
$ terraform import google_pubsub_subscription_iam_member.default "projects/{{project_id}}/subscriptions/{{subscription}} roles/editor jane@example.com"
IAM binding imports use space-delimited identifiers that contain the resource's subscription
and role
. For example:
"projects/{{project_id}}/subscriptions/{{subscription}} roles/editor"
An import
block (Terraform v1.5.0 and later) can be used to import IAM bindings:
import {
id = "projects/{{project_id}}/subscriptions/{{subscription}} roles/editor"
to = google_pubsub_subscription_iam_binding.default
}
The terraform import
command can also be used:
$ terraform import google_pubsub_subscription_iam_binding.default "projects/{{project_id}}/subscriptions/{{subscription}} roles/editor"
IAM policy imports use the identifier of the Pubsub Subscription resource. For example:
"projects/{{project_id}}/subscriptions/{{subscription}}"
An import
block (Terraform v1.5.0 and later) can be used to import IAM policies:
import {
id = "projects/{{project_id}}/subscriptions/{{subscription}}"
to = google_pubsub_subscription_iam_policy.default
}
The terraform import
command can also be used:
$ terraform import google_pubsub_subscription_iam_policy.default projects/{{project_id}}/subscriptions/{{subscription}}