Four different resources help you manage your IAM policy for a folder. Each of these resources serves a different use case:
google_folder_iam_policy
: Authoritative. Sets the IAM policy for the folder and replaces any existing policy already attached.google_folder_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 folder are preserved.google_folder_iam_member
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the folder are preserved.google_folder_iam_audit_config
: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service.resource "google_folder_iam_policy" "folder" {
folder = "folders/1234567"
policy_data = data.google_iam_policy.admin.policy_data
}
data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
}
With IAM Conditions:
resource "google_folder_iam_policy" "folder" {
folder = "folders/1234567"
policy_data = "${data.google_iam_policy.admin.policy_data}"
}
data "google_iam_policy" "admin" {
binding {
role = "roles/compute.admin"
members = [
"user:jane@example.com",
]
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
}
resource "google_folder_iam_binding" "folder" {
folder = "folders/1234567"
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
With IAM Conditions:
resource "google_folder_iam_binding" "folder" {
folder = "folders/1234567"
role = "roles/container.admin"
members = [
"user:jane@example.com",
]
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
resource "google_folder_iam_member" "folder" {
folder = "folders/1234567"
role = "roles/editor"
member = "user:jane@example.com"
}
With IAM Conditions:
resource "google_folder_iam_member" "folder" {
folder = "folders/1234567"
role = "roles/firebase.admin"
member = "user:jane@example.com"
condition {
title = "expires_after_2019_12_31"
description = "Expiring at midnight of 2019-12-31"
expression = "request.time < timestamp(\"2020-01-01T00:00:00Z\")"
}
}
resource "google_folder_iam_audit_config" "folder" {
folder = "folders/1234567"
service = "allServices"
audit_log_config {
log_type = "ADMIN_READ"
}
audit_log_config {
log_type = "DATA_READ"
exempted_members = [
"user:joebloggs@hashicorp.com",
]
}
}
The following arguments are supported:
member/members
- (Required except for google_folder_iam_audit_config) Identities that will be granted the privilege in role
.
Each entry can have one of the following values:
role
- (Required except for google_folder_iam_audit_config) The role that should be applied. Only one
google_folder_iam_binding
can be used per role. Note that custom roles must be of the format
organizations/{{org_id}}/roles/{{role_id}}
.
policy_data
- (Required only by google_folder_iam_policy
) The google_iam_policy
data source that represents
the IAM policy that will be applied to the folder. The policy will be
merged with any existing policy applied to the folder.
Changing this updates the policy.
Deleting this removes all policies from the folder, locking out users without folder-level access.
folder
- (Required) The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
service
- (Required only by google_folder_iam_audit_config) Service which will be enabled for audit logging. The special value allServices
covers all services. Note that if there are google_folder_iam_audit_config resources covering both allServices
and a specific service then the union of the two AuditConfigs is used for that service: the log_types
specified in each audit_log_config
are enabled, and the exempted_members
in each audit_log_config
are exempted.
audit_log_config
- (Required only by google_folder_iam_audit_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below.
condition
- (Optional) An IAM Condition for a given binding.
Structure is documented below.
The audit_log_config
block supports:
log_type
- (Required) Permission type for which logging is to be configured. Must be one of DATA_READ
, DATA_WRITE
, or ADMIN_READ
.
exempted_members
- (Optional) Identities that do not cause logging for this type of permission. The format is the same as that for members
.
expression
- (Required) Textual representation of an expression in Common Expression Language syntax.
title
- (Required) A title for the expression, i.e. a short string describing its purpose.
description
- (Optional) An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
In addition to the arguments listed above, the following computed attributes are exported:
etag
- (Computed) The etag of the folder's IAM policy.IAM member imports use space-delimited identifiers that contain the resource's folder_id
, role
, and member
e.g.
"folders/{{folder_id}} roles/viewer user:foo@example.com"
An import
block (Terraform v1.5.0 and later) can be used to import IAM members:
import {
id = "folders/{{folder_id}} roles/viewer user:foo@example.com"
to = google_folder_iam_member.default
}
The terraform import
command can also be used:
$ terraform import google_folder_iam_member.default "folder roles/viewer user:foo@example.com"
IAM binding imports use space-delimited identifiers that contain the resource's folder_id
and role
, e.g.
"folders/{{folder_id}} roles/viewer"
An import
block (Terraform v1.5.0 and later) can be used to import IAM bindings:
import {
id = "folders/{{folder_id}} roles/viewer"
to = google_folder_iam_binding.default
}
The terraform import
command can also be used:
$ terraform import google_folder_iam_binding.default "folder roles/viewer"
IAM policy imports use the identifier of the Folder only. For example:
folders/{{folder_id}}
An import
block (Terraform v1.5.0 and later) can be used to import IAM policies:
import {
id = "folders/{{folder_id}}"
to = google_folder_iam_policy.default
}
The terraform import
command can also be used:
$ terraform import google_folder_iam_policy.default folders/{{folder_id}}
An audit config can be imported into a google_folder_iam_audit_config
resource using the resource's folder_id
and the service
, e.g:
"folder/{{folder_id}} foo.googleapis.com"
An import
block (Terraform v1.5.0 and later) can be used to import audit configs:
import {
id = "folder/{{folder_id}} foo.googleapis.com"
to = google_folder_iam_audit_config.default
}
The terraform import
command can also be used:
terraform import google_folder_iam_audit_config.default "folder/{{folder_id}} foo.googleapis.com"