Google Cloud Platform Folder IAM

This page shows how to write Terraform for Cloud Platform Folder IAM and write them securely.

google_folder_iam (Terraform)

The Folder IAM in Cloud Platform can be configured in Terraform with the resource name google_folder_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:

  • 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:

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

The condition block supports:

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

Warning: Terraform considers the role and condition contents (title+description+expression) as the identifier for the binding. This means that if any part of the condition is changed out-of-band, Terraform will consider it to be an entirely different resource and will treat it as such.

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

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

Explanation in Terraform Registry

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.

    Note: google_folder_iam_policy cannot be used in conjunction with google_folder_iam_binding, google_folder_iam_member, or google_folder_iam_audit_config or they will fight over what your policy should be.

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

    Note: The underlying API method projects.setIamPolicy has constraints which are documented here. In addition to these constraints, IAM Conditions cannot be used with Basic Roles such as Owner. Violating these constraints will result in the API returning a 400 error code so please review these if you encounter errors with this resource.

Tips: Best Practices for The Other Google Cloud Platform Resources

In addition to the google_project, Google Cloud Platform has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.



Ensure project-level default network creation is disabled

It is better to disable the auto-creation of default networks. The default network for a GCP project is usually configured coarsely, leaving the risk of unwanted access to resources in the network.

Review your Google Cloud Platform settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Frequently asked questions

What is Google Cloud Platform Folder IAM?

Google Cloud Platform Folder IAM is a resource for Cloud Platform 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.