Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. organizations
  5. IAMBinding
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.organizations.IAMBinding

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

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

Note: This resource must not be used in conjunction with gcp.organizations.IAMMember for the same role 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

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

const binding = new gcp.organizations.IAMBinding("binding", {
    orgId: "123456789",
    role: "roles/browser",
    members: ["user:alice@gmail.com"],
});
Copy
import pulumi
import pulumi_gcp as gcp

binding = gcp.organizations.IAMBinding("binding",
    org_id="123456789",
    role="roles/browser",
    members=["user:alice@gmail.com"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := organizations.NewIAMBinding(ctx, "binding", &organizations.IAMBindingArgs{
			OrgId: pulumi.String("123456789"),
			Role:  pulumi.String("roles/browser"),
			Members: pulumi.StringArray{
				pulumi.String("user:alice@gmail.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Organizations.IAMBinding("binding", new()
    {
        OrgId = "123456789",
        Role = "roles/browser",
        Members = new[]
        {
            "user:alice@gmail.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.IAMBinding;
import com.pulumi.gcp.organizations.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 binding = new IAMBinding("binding", IAMBindingArgs.builder()
            .orgId("123456789")
            .role("roles/browser")
            .members("user:alice@gmail.com")
            .build());

    }
}
Copy
resources:
  binding:
    type: gcp:organizations:IAMBinding
    properties:
      orgId: '123456789'
      role: roles/browser
      members:
        - user:alice@gmail.com
Copy

Create IAMBinding Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IAMBinding(name: string, args: IAMBindingArgs, opts?: CustomResourceOptions);
@overload
def IAMBinding(resource_name: str,
               args: IAMBindingArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def IAMBinding(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               members: Optional[Sequence[str]] = None,
               org_id: Optional[str] = None,
               role: Optional[str] = None,
               condition: Optional[IAMBindingConditionArgs] = 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:organizations:IAMBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. IAMBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IAMBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gcpIAMBindingResource = new Gcp.Organizations.IAMBinding("gcpIAMBindingResource", new()
{
    Members = new[]
    {
        "string",
    },
    OrgId = "string",
    Role = "string",
    Condition = new Gcp.Organizations.Inputs.IAMBindingConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
});
Copy
example, err := organizations.NewIAMBinding(ctx, "gcpIAMBindingResource", &organizations.IAMBindingArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	OrgId: pulumi.String("string"),
	Role:  pulumi.String("string"),
	Condition: &organizations.IAMBindingConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
})
Copy
var gcpIAMBindingResource = new IAMBinding("gcpIAMBindingResource", IAMBindingArgs.builder()
    .members("string")
    .orgId("string")
    .role("string")
    .condition(IAMBindingConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .build());
Copy
gcp_iam_binding_resource = gcp.organizations.IAMBinding("gcpIAMBindingResource",
    members=["string"],
    org_id="string",
    role="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    })
Copy
const gcpIAMBindingResource = new gcp.organizations.IAMBinding("gcpIAMBindingResource", {
    members: ["string"],
    orgId: "string",
    role: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
});
Copy
type: gcp:organizations:IAMBinding
properties:
    condition:
        description: string
        expression: string
        title: string
    members:
        - string
    orgId: string
    role: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IAMBinding resource accepts the following input properties:

Members This property is required. List<string>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The numeric ID of the organization in which you want to create a custom role.
Role
This property is required.
Changes to this property will trigger replacement.
string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition Changes to this property will trigger replacement. IAMBindingCondition
Members This property is required. []string
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The numeric ID of the organization in which you want to create a custom role.
Role
This property is required.
Changes to this property will trigger replacement.
string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition Changes to this property will trigger replacement. IAMBindingConditionArgs
members This property is required. List<String>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId
This property is required.
Changes to this property will trigger replacement.
String
The numeric ID of the organization in which you want to create a custom role.
role
This property is required.
Changes to this property will trigger replacement.
String
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingCondition
members This property is required. string[]
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId
This property is required.
Changes to this property will trigger replacement.
string
The numeric ID of the organization in which you want to create a custom role.
role
This property is required.
Changes to this property will trigger replacement.
string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingCondition
members This property is required. Sequence[str]
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
org_id
This property is required.
Changes to this property will trigger replacement.
str
The numeric ID of the organization in which you want to create a custom role.
role
This property is required.
Changes to this property will trigger replacement.
str
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingConditionArgs
members This property is required. List<String>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId
This property is required.
Changes to this property will trigger replacement.
String
The numeric ID of the organization in which you want to create a custom role.
role
This property is required.
Changes to this property will trigger replacement.
String
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. 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 organization's IAM policy.
Id string
The provider-assigned unique ID for this managed resource.
Etag string
(Computed) The etag of the organization's IAM policy.
Id string
The provider-assigned unique ID for this managed resource.
etag String
(Computed) The etag of the organization's IAM policy.
id String
The provider-assigned unique ID for this managed resource.
etag string
(Computed) The etag of the organization's IAM policy.
id string
The provider-assigned unique ID for this managed resource.
etag str
(Computed) The etag of the organization's IAM policy.
id str
The provider-assigned unique ID for this managed resource.
etag String
(Computed) The etag of the organization'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,
        members: Optional[Sequence[str]] = None,
        org_id: Optional[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)
resources:  _:    type: gcp:organizations:IAMBinding    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. IAMBindingCondition
Etag string
(Computed) The etag of the organization's IAM policy.
Members List<string>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
OrgId Changes to this property will trigger replacement. string
The numeric ID of the organization in which you want to create a custom role.
Role Changes to this property will trigger replacement. string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition Changes to this property will trigger replacement. IAMBindingConditionArgs
Etag string
(Computed) The etag of the organization's IAM policy.
Members []string
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
OrgId Changes to this property will trigger replacement. string
The numeric ID of the organization in which you want to create a custom role.
Role Changes to this property will trigger replacement. string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingCondition
etag String
(Computed) The etag of the organization's IAM policy.
members List<String>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId Changes to this property will trigger replacement. String
The numeric ID of the organization in which you want to create a custom role.
role Changes to this property will trigger replacement. String
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingCondition
etag string
(Computed) The etag of the organization's IAM policy.
members string[]
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId Changes to this property will trigger replacement. string
The numeric ID of the organization in which you want to create a custom role.
role Changes to this property will trigger replacement. string
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. IAMBindingConditionArgs
etag str
(Computed) The etag of the organization's IAM policy.
members Sequence[str]
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
org_id Changes to this property will trigger replacement. str
The numeric ID of the organization in which you want to create a custom role.
role Changes to this property will trigger replacement. str
The role that should be applied. Only one gcp.organizations.IAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Changes to this property will trigger replacement. Property Map
etag String
(Computed) The etag of the organization's IAM policy.
members List<String>
A list of users that the role should apply to. For more details on format and restrictions see https://cloud.google.com/billing/reference/rest/v1/Policy#Binding
orgId Changes to this property will trigger replacement. String
The numeric ID of the organization in which you want to create a custom role.
role Changes to this property will trigger replacement. String
The role that should be applied. Only one gcp.organizations.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
, IAMBindingConditionArgs

Expression
This property is required.
Changes to this property will trigger replacement.
string
Title
This property is required.
Changes to this property will trigger replacement.
string
Description Changes to this property will trigger replacement. string
Expression
This property is required.
Changes to this property will trigger replacement.
string
Title
This property is required.
Changes to this property will trigger replacement.
string
Description Changes to this property will trigger replacement. string
expression
This property is required.
Changes to this property will trigger replacement.
String
title
This property is required.
Changes to this property will trigger replacement.
String
description Changes to this property will trigger replacement. String
expression
This property is required.
Changes to this property will trigger replacement.
string
title
This property is required.
Changes to this property will trigger replacement.
string
description Changes to this property will trigger replacement. string
expression
This property is required.
Changes to this property will trigger replacement.
str
title
This property is required.
Changes to this property will trigger replacement.
str
description Changes to this property will trigger replacement. str
expression
This property is required.
Changes to this property will trigger replacement.
String
title
This property is required.
Changes to this property will trigger replacement.
String
description Changes to this property will trigger replacement. 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 org_id and role, e.g.

$ pulumi import gcp:organizations/iAMBinding:IAMBinding my_org "your-org-id roles/viewer"
Copy

-> 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. [projects/my-project|organizations/my-org]/roles/my-custom-role.

To learn more about importing existing cloud resources, see Importing resources.

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.
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp