IAM policy for folders

Four different resources help you manage your IAM policy for a folder. Each of these resources serves a different use case:

googleFolderIamPolicy: Authoritative. Sets the IAM policy for the folder and replaces any existing policy already attached.
googleFolderIamBinding: 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.
googleFolderIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the folder are preserved.
googleFolderIamAuditConfig: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service.

\~> Note: googleFolderIamPolicy cannot be used in conjunction with googleFolderIamBinding, googleFolderIamMember, or googleFolderIamAuditConfig or they will fight over what your policy should be.

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

\~> Note: The underlying API method projectsSetIamPolicy 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.

googleFolderIamPolicy

!> Be careful! You can accidentally lock yourself out of your folder using this resource. Deleting a googleFolderIamPolicy removes access from anyone without permissions on its parent folder/organization. Proceed with caution. It's not recommended to use googleFolderIamPolicy with your provider folder to avoid locking yourself out, and it should generally only be used with folders fully managed by Terraform. If you do use this resource, it is recommended to import the policy before applying the change.

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
  new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
    binding: [
      {
        members: ["user:jane@example.com"],
        role: "roles/editor",
      },
    ],
  });
new google.folderIamPolicy.FolderIamPolicy(this, "folder", {
  folder: "folders/1234567",
  policy_data: dataGoogleIamPolicyAdmin.policyData,
});

With IAM Conditions:

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
  new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
    binding: [
      {
        condition: [
          {
            description: "Expiring at midnight of 2019-12-31",
            expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
            title: "expires_after_2019_12_31",
          },
        ],
        members: ["user:jane@example.com"],
        role: "roles/compute.admin",
      },
    ],
  });
new google.folderIamPolicy.FolderIamPolicy(this, "folder", {
  folder: "folders/1234567",
  policy_data: dataGoogleIamPolicyAdmin.policyData,
});

googleFolderIamBinding

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.folderIamBinding.FolderIamBinding(this, "folder", {
  folder: "folders/1234567",
  members: ["user:jane@example.com"],
  role: "roles/editor",
});

With IAM Conditions:

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.folderIamBinding.FolderIamBinding(this, "folder", {
  condition: [
    {
      description: "Expiring at midnight of 2019-12-31",
      expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
      title: "expires_after_2019_12_31",
    },
  ],
  folder: "folders/1234567",
  members: ["user:jane@example.com"],
  role: "roles/container.admin",
});

googleFolderIamMember

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.folderIamMember.FolderIamMember(this, "folder", {
  folder: "folders/1234567",
  member: "user:jane@example.com",
  role: "roles/editor",
});

With IAM Conditions:

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.folderIamMember.FolderIamMember(this, "folder", {
  condition: [
    {
      description: "Expiring at midnight of 2019-12-31",
      expression: 'request.time < timestamp("2020-01-01T00:00:00Z")',
      title: "expires_after_2019_12_31",
    },
  ],
  folder: "folders/1234567",
  member: "user:jane@example.com",
  role: "roles/firebase.admin",
});

googleFolderIamAuditConfig

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.folderIamAuditConfig.FolderIamAuditConfig(this, "folder", {
  audit_log_config: [
    {
      log_type: "ADMIN_READ",
    },
    {
      exempted_members: ["user:joebloggs@hashicorp.com"],
      log_type: "DATA_READ",
    },
  ],
  folder: "folders/1234567",
  service: "allServices",
});

Argument Reference

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, 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 except for google_folder_iam_audit_config) The role that should be applied. Only one googleFolderIamBinding can be used per role. Note that custom roles must be of the format organizations/{{orgId}}/roles/{{roleId}}.
policyData - (Required only by googleFolderIamPolicy) The googleIamPolicy 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 logTypes specified in each auditLogConfig are enabled, and the exemptedMembers in each auditLogConfig are exempted.
auditLogConfig - (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 auditLogConfig block supports:

logType - (Required) Permission type for which logging is to be configured. Must be one of dataRead, dataWrite, or adminRead.
exemptedMembers - (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.

Attributes Reference

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

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

Import

IAM member imports use space-delimited identifiers; the resource in question, the role, and the account. This member resource can be imported using the folder, role, and member e.g.

$ terraform import google_folder_iam_member.my_folder "folder roles/viewer user:foo@example.com"

IAM binding imports use space-delimited identifiers; the resource in question and the role. This binding resource can be imported using the folder and role, e.g.

terraform import google_folder_iam_binding.my_folder "folder roles/viewer"

IAM policy imports use the identifier of the resource in question. This policy resource can be imported using the folder.

$ terraform import google_folder_iam_policy.my_folder folder

IAM audit config imports use the identifier of the resource in question and the service, e.g.

terraform import google_folder_iam_audit_config.my_folder "folder foo.googleapis.com"

-> Custom Roles: If you're importing a IAM resource with a custom role, make sure to use the full name of the custom role, e.g. organizations/{{orgId}}/roles/{{roleId}}.

-> Conditional IAM Bindings: If you're importing a IAM binding with a condition block, make sure to include the title of condition, e.g. terraformImportGoogleFolderIamBindingMyFolder "folderRoles/{{roleId}}ConditionTitle"