IAMBinding

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.

Create a IAMBinding Resource

new IAMBinding(name: string, args: IAMBindingArgs, opts?: CustomResourceOptions);

def IAMBinding(resource_name, opts=None, condition=None, folder=None, members=None, role=None, __props__=None);

func NewIAMBinding(ctx *Context, name string, args IAMBindingArgs, opts ...ResourceOption) (*IAMBinding, error)

public IAMBinding(string name, IAMBindingArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

IAMBinding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 IAMBindingCondition

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 IAMBindingCondition

folder str: The resource name of the folder the policy is attached to. Its format is folders/{folder_id}.
members List[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 Dict[IAMBindingCondition]

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 str: (Computed) The etag of the folder’s IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, condition=None, etag=None, folder=None, members=None, role=None, __props__=None);

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)

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.

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 IAMBindingCondition
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 IAMBindingCondition
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 Dict[IAMBindingCondition]
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 List[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}.

Supporting Types

IAMBindingCondition

See the input and output API doc for this type.

Expression string
Title string
Description string

Expression string
Title string
Description string

expression string
title string
description string

expression str
title str
description str

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud