FunctionIamBinding

Three different resources help you manage your IAM policy for Cloud Functions CloudFunction. Each of these resources serves a different use case:

gcp.cloudfunctions.FunctionIamPolicy: Authoritative. Sets the IAM policy for the cloudfunction and replaces any existing policy already attached.
gcp.cloudfunctions.FunctionIamBinding: 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 cloudfunction are preserved.
gcp.cloudfunctions.FunctionIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the cloudfunction are preserved.

Note: gcp.cloudfunctions.FunctionIamPolicy cannot be used in conjunction with gcp.cloudfunctions.FunctionIamBinding and gcp.cloudfunctions.FunctionIamMember or they will fight over what your policy should be.
Note: gcp.cloudfunctions.FunctionIamBinding resources can be used in conjunction with gcp.cloudfunctions.FunctionIamMember resources only if they do not grant privilege to the same role.

Create a FunctionIamBinding Resource

new FunctionIamBinding(name: string, args: FunctionIamBindingArgs, opts?: CustomResourceOptions);

def FunctionIamBinding(resource_name, opts=None, cloud_function=None, condition=None, members=None, project=None, region=None, role=None, __props__=None);

func NewFunctionIamBinding(ctx *Context, name string, args FunctionIamBindingArgs, opts ...ResourceOption) (*FunctionIamBinding, error)

public FunctionIamBinding(string name, FunctionIamBindingArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args FunctionIamBindingArgs: 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 FunctionIamBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FunctionIamBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

FunctionIamBinding Resource Properties

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

Inputs

The FunctionIamBinding resource accepts the following input properties:

CloudFunction string: Used to find the parent resource to bind the IAM policy to
Members List<string>
Role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition FunctionIamBindingConditionArgs
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

CloudFunction string: Used to find the parent resource to bind the IAM policy to
Members []string
Role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
Condition FunctionIamBindingCondition
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

cloudFunction string: Used to find the parent resource to bind the IAM policy to
members string[]
role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition FunctionIamBindingCondition
project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

cloud_function str: Used to find the parent resource to bind the IAM policy to
members List[str]
role str: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
condition Dict[FunctionIamBindingCondition]
project str: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
region str: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.

Outputs

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

Etag string: (Computed) The etag of the IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

Etag string: (Computed) The etag of the IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

etag string: (Computed) The etag of the IAM policy.
id string: The provider-assigned unique ID for this managed resource.

etag str: (Computed) The etag of the IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing FunctionIamBinding Resource

Get an existing FunctionIamBinding 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?: FunctionIamBindingState, opts?: CustomResourceOptions): FunctionIamBinding

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

func GetFunctionIamBinding(ctx *Context, name string, id IDInput, state *FunctionIamBindingState, opts ...ResourceOption) (*FunctionIamBinding, error)

public static FunctionIamBinding Get(string name, Input<string> id, FunctionIamBindingState? 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:

CloudFunction string: Used to find the parent resource to bind the IAM policy to
Condition FunctionIamBindingConditionArgs
Etag string: (Computed) The etag of the IAM policy.
Members List<string>
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

CloudFunction string: Used to find the parent resource to bind the IAM policy to
Condition FunctionIamBindingCondition
Etag string: (Computed) The etag of the IAM policy.
Members []string
Project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
Region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
Role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

cloudFunction string: Used to find the parent resource to bind the IAM policy to
condition FunctionIamBindingCondition
etag string: (Computed) The etag of the IAM policy.
members string[]
project string: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
region string: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role string: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

cloud_function str: Used to find the parent resource to bind the IAM policy to
condition Dict[FunctionIamBindingCondition]
etag str: (Computed) The etag of the IAM policy.
members List[str]
project str: The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
region str: The location of this cloud function. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no region is provided in the parent identifier and no region is specified, it is taken from the provider configuration.
role str: The role that should be applied. Only one gcp.cloudfunctions.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Supporting Types

FunctionIamBindingCondition

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