Docs Packages
  1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. folder
  5. IAMBinding
gcp logo
Google Cloud Classic v6.56.0, May 18 23

gcp.folder.IAMBinding

Explore with Pulumi AI

Allows creation and management of a single binding within IAM policy for an existing Google Cloud Platform folder.

Note: This resource must not be used in conjunction with gcp.folder.IAMPolicy or they will fight over what your policy should be.

Note: On create, this resource will overwrite members of any existing roles. Use pulumi import and inspect the output to ensure your existing members are preserved.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var department1 = new Gcp.Organizations.Folder("department1", new()
    {
        DisplayName = "Department 1",
        Parent = "organizations/1234567",
    });

    var admin = new Gcp.Folder.IAMBinding("admin", new()
    {
        Folder = department1.Name,
        Role = "roles/editor",
        Members = new[]
        {
            "user:alice@gmail.com",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/folder"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		department1, err := organizations.NewFolder(ctx, "department1", &organizations.FolderArgs{
			DisplayName: pulumi.String("Department 1"),
			Parent:      pulumi.String("organizations/1234567"),
		})
		if err != nil {
			return err
		}
		_, err = folder.NewIAMBinding(ctx, "admin", &folder.IAMBindingArgs{
			Folder: department1.Name,
			Role:   pulumi.String("roles/editor"),
			Members: pulumi.StringArray{
				pulumi.String("user:alice@gmail.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.folder.IAMBinding;
import com.pulumi.gcp.folder.IAMBindingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var department1 = new Folder("department1", FolderArgs.builder()        
            .displayName("Department 1")
            .parent("organizations/1234567")
            .build());

        var admin = new IAMBinding("admin", IAMBindingArgs.builder()        
            .folder(department1.name())
            .role("roles/editor")
            .members("user:alice@gmail.com")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

department1 = gcp.organizations.Folder("department1",
    display_name="Department 1",
    parent="organizations/1234567")
admin = gcp.folder.IAMBinding("admin",
    folder=department1.name,
    role="roles/editor",
    members=["user:alice@gmail.com"])

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const department1 = new gcp.organizations.Folder("department1", {
    displayName: "Department 1",
    parent: "organizations/1234567",
});
const admin = new gcp.folder.IAMBinding("admin", {
    folder: department1.name,
    role: "roles/editor",
    members: ["user:alice@gmail.com"],
});

resources:
  department1:
    type: gcp:organizations:Folder
    properties:
      displayName: Department 1
      parent: organizations/1234567
  admin:
    type: gcp:folder:IAMBinding
    properties:
      folder: ${department1.name}
      role: roles/editor
      members:
        - user:alice@gmail.com

Create IAMBinding Resource

new IAMBinding(name: string, args: IAMBindingArgs, opts?: CustomResourceOptions);
@overload
def IAMBinding(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               condition: Optional[IAMBindingConditionArgs] = None,
               folder: Optional[str] = None,
               members: Optional[Sequence[str]] = None,
               role: Optional[str] = None)
@overload
def IAMBinding(resource_name: str,
               args: IAMBindingArgs,
               opts: Optional[ResourceOptions] = None)
func NewIAMBinding(ctx *Context, name string, args IAMBindingArgs, opts ...ResourceOption) (*IAMBinding, error)
public IAMBinding(string name, IAMBindingArgs args, CustomResourceOptions? opts = null)
public IAMBinding(String name, IAMBindingArgs args)
public IAMBinding(String name, IAMBindingArgs args, CustomResourceOptions options)

type: gcp:folder:IAMBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args IAMBindingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args IAMBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IAMBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IAMBinding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The IAMBinding resource accepts the following input properties:

Folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

Members List<string>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
Role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition IAMBindingConditionArgs
Folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

Members []string

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
Role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition IAMBindingConditionArgs
folder String

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members List<String>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role String

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members string[]

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
folder str

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members Sequence[str]

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role str

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
folder String

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members List<String>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role String

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the IAMBinding resource produces the following output properties:

Etag string

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

Id string

The provider-assigned unique ID for this managed resource.

Etag string

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

Id string

The provider-assigned unique ID for this managed resource.

etag String

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

id String

The provider-assigned unique ID for this managed resource.

etag string

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

id string

The provider-assigned unique ID for this managed resource.

etag str

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

id str

The provider-assigned unique ID for this managed resource.

etag String

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

id String

The provider-assigned unique ID for this managed resource.

Look up Existing IAMBinding Resource

Get an existing IAMBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IAMBindingState, opts?: CustomResourceOptions): IAMBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[IAMBindingConditionArgs] = None,
        etag: Optional[str] = None,
        folder: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        role: Optional[str] = None) -> IAMBinding
func GetIAMBinding(ctx *Context, name string, id IDInput, state *IAMBindingState, opts ...ResourceOption) (*IAMBinding, error)
public static IAMBinding Get(string name, Input<string> id, IAMBindingState? state, CustomResourceOptions? opts = null)
public static IAMBinding get(String name, Output<String> id, IAMBindingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Condition IAMBindingConditionArgs
Etag string

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

Folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

Members List<string>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
Role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition IAMBindingConditionArgs
Etag string

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

Folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

Members []string

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
Role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
etag String

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

folder String

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members List<String>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role String

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
etag string

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

folder string

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members string[]

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role string

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition IAMBindingConditionArgs
etag str

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

folder str

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members Sequence[str]

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role str

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Property Map
etag String

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

folder String

The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.

members List<String>

An array of identities that will be granted the privilege in the role. Each entry can have one of the following values:

  • user:{emailid}: An email address that is associated with a specific Google account. For example, alice@gmail.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.
  • For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
role String

The role that should be applied. Only one gcp.folder.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Supporting Types

IAMBindingCondition

Expression string
Title string
Description string
Expression string
Title string
Description string
expression String
title String
description String
expression string
title string
description string
expression String
title String
description String

Import

IAM binding imports use space-delimited identifiers; first the resource in question and then the role.

These bindings can be imported using the folder and role, e.g.

 $ pulumi import gcp:folder/iAMBinding:IAMBinding viewer "folder-name roles/viewer"

-> Custom RolesIf you’re importing a IAM binding with a custom role, make sure to use the

full name of the custom role, e.g. [projects/my-project|organizations/my-org]/roles/my-custom-role.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.