Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. cloudfunctionsv2
  5. FunctionIamBinding
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.cloudfunctionsv2.FunctionIamBinding

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi
pulumi/pulumi-gcp

    Three different resources help you manage your IAM policy for Cloud Functions (2nd gen) function. Each of these resources serves a different use case:

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

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.cloudfunctionsv2.FunctionIamPolicy: Retrieves the IAM policy for the function

    Note: gcp.cloudfunctionsv2.FunctionIamPolicy cannot be used in conjunction with gcp.cloudfunctionsv2.FunctionIamBinding and gcp.cloudfunctionsv2.FunctionIamMember or they will fight over what your policy should be.

    Note: gcp.cloudfunctionsv2.FunctionIamBinding resources can be used in conjunction with gcp.cloudfunctionsv2.FunctionIamMember resources only if they do not grant privilege to the same role.

    google_cloudfunctions2_function_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.cloudfunctionsv2.FunctionIamPolicy("policy", {
    project: google_cloudfunctions2_function["function"].project,
    location: google_cloudfunctions2_function["function"].location,
    cloudFunction: google_cloudfunctions2_function["function"].name,
    policyData: admin.then(admin => admin.policyData),
});

    import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[gcp.organizations.GetIAMPolicyBindingArgs(
    role="roles/viewer",
    members=["user:jane@example.com"],
)])
policy = gcp.cloudfunctionsv2.FunctionIamPolicy("policy",
    project=google_cloudfunctions2_function["function"]["project"],
    location=google_cloudfunctions2_function["function"]["location"],
    cloud_function=google_cloudfunctions2_function["function"]["name"],
    policy_data=admin.policy_data)

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

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.CloudFunctionsV2.FunctionIamPolicy("policy", new()
    {
        Project = google_cloudfunctions2_function.Function.Project,
        Location = google_cloudfunctions2_function.Function.Location,
        CloudFunction = google_cloudfunctions2_function.Function.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/cloudfunctionsv2"
	"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 {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudfunctionsv2.NewFunctionIamPolicy(ctx, "policy", &cloudfunctionsv2.FunctionIamPolicyArgs{
			Project:       pulumi.Any(google_cloudfunctions2_function.Function.Project),
			Location:      pulumi.Any(google_cloudfunctions2_function.Function.Location),
			CloudFunction: pulumi.Any(google_cloudfunctions2_function.Function.Name),
			PolicyData:    *pulumi.String(admin.PolicyData),
		})
		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.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.cloudfunctionsv2.FunctionIamPolicy;
import com.pulumi.gcp.cloudfunctionsv2.FunctionIamPolicyArgs;
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) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new FunctionIamPolicy("policy", FunctionIamPolicyArgs.builder()        
            .project(google_cloudfunctions2_function.function().project())
            .location(google_cloudfunctions2_function.function().location())
            .cloudFunction(google_cloudfunctions2_function.function().name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

    resources:
  policy:
    type: gcp:cloudfunctionsv2:FunctionIamPolicy
    properties:
      project: ${google_cloudfunctions2_function.function.project}
      location: ${google_cloudfunctions2_function.function.location}
      cloudFunction: ${google_cloudfunctions2_function.function.name}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

    google_cloudfunctions2_function_iam_binding

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

const binding = new gcp.cloudfunctionsv2.FunctionIamBinding("binding", {
    project: google_cloudfunctions2_function["function"].project,
    location: google_cloudfunctions2_function["function"].location,
    cloudFunction: google_cloudfunctions2_function["function"].name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

    import pulumi
import pulumi_gcp as gcp

binding = gcp.cloudfunctionsv2.FunctionIamBinding("binding",
    project=google_cloudfunctions2_function["function"]["project"],
    location=google_cloudfunctions2_function["function"]["location"],
    cloud_function=google_cloudfunctions2_function["function"]["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

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

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.CloudFunctionsV2.FunctionIamBinding("binding", new()
    {
        Project = google_cloudfunctions2_function.Function.Project,
        Location = google_cloudfunctions2_function.Function.Location,
        CloudFunction = google_cloudfunctions2_function.Function.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfunctionsv2.NewFunctionIamBinding(ctx, "binding", &cloudfunctionsv2.FunctionIamBindingArgs{
			Project:       pulumi.Any(google_cloudfunctions2_function.Function.Project),
			Location:      pulumi.Any(google_cloudfunctions2_function.Function.Location),
			CloudFunction: pulumi.Any(google_cloudfunctions2_function.Function.Name),
			Role:          pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.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.cloudfunctionsv2.FunctionIamBinding;
import com.pulumi.gcp.cloudfunctionsv2.FunctionIamBindingArgs;
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 FunctionIamBinding("binding", FunctionIamBindingArgs.builder()        
            .project(google_cloudfunctions2_function.function().project())
            .location(google_cloudfunctions2_function.function().location())
            .cloudFunction(google_cloudfunctions2_function.function().name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

    resources:
  binding:
    type: gcp:cloudfunctionsv2:FunctionIamBinding
    properties:
      project: ${google_cloudfunctions2_function.function.project}
      location: ${google_cloudfunctions2_function.function.location}
      cloudFunction: ${google_cloudfunctions2_function.function.name}
      role: roles/viewer
      members:
        - user:jane@example.com

    google_cloudfunctions2_function_iam_member

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

const member = new gcp.cloudfunctionsv2.FunctionIamMember("member", {
    project: google_cloudfunctions2_function["function"].project,
    location: google_cloudfunctions2_function["function"].location,
    cloudFunction: google_cloudfunctions2_function["function"].name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

    import pulumi
import pulumi_gcp as gcp

member = gcp.cloudfunctionsv2.FunctionIamMember("member",
    project=google_cloudfunctions2_function["function"]["project"],
    location=google_cloudfunctions2_function["function"]["location"],
    cloud_function=google_cloudfunctions2_function["function"]["name"],
    role="roles/viewer",
    member="user:jane@example.com")

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

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.CloudFunctionsV2.FunctionIamMember("member", new()
    {
        Project = google_cloudfunctions2_function.Function.Project,
        Location = google_cloudfunctions2_function.Function.Location,
        CloudFunction = google_cloudfunctions2_function.Function.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfunctionsv2.NewFunctionIamMember(ctx, "member", &cloudfunctionsv2.FunctionIamMemberArgs{
			Project:       pulumi.Any(google_cloudfunctions2_function.Function.Project),
			Location:      pulumi.Any(google_cloudfunctions2_function.Function.Location),
			CloudFunction: pulumi.Any(google_cloudfunctions2_function.Function.Name),
			Role:          pulumi.String("roles/viewer"),
			Member:        pulumi.String("user:jane@example.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.cloudfunctionsv2.FunctionIamMember;
import com.pulumi.gcp.cloudfunctionsv2.FunctionIamMemberArgs;
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 member = new FunctionIamMember("member", FunctionIamMemberArgs.builder()        
            .project(google_cloudfunctions2_function.function().project())
            .location(google_cloudfunctions2_function.function().location())
            .cloudFunction(google_cloudfunctions2_function.function().name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

    resources:
  member:
    type: gcp:cloudfunctionsv2:FunctionIamMember
    properties:
      project: ${google_cloudfunctions2_function.function.project}
      location: ${google_cloudfunctions2_function.function.location}
      cloudFunction: ${google_cloudfunctions2_function.function.name}
      role: roles/viewer
      member: user:jane@example.com

    Create FunctionIamBinding Resource

    new FunctionIamBinding(name: string, args: FunctionIamBindingArgs, opts?: CustomResourceOptions);
    @overload
def FunctionIamBinding(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cloud_function: Optional[str] = None,
                       condition: Optional[FunctionIamBindingConditionArgs] = None,
                       location: Optional[str] = None,
                       members: Optional[Sequence[str]] = None,
                       project: Optional[str] = None,
                       role: Optional[str] = None)
@overload
def FunctionIamBinding(resource_name: str,
                       args: FunctionIamBindingArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewFunctionIamBinding(ctx *Context, name string, args FunctionIamBindingArgs, opts ...ResourceOption) (*FunctionIamBinding, error)
    public FunctionIamBinding(string name, FunctionIamBindingArgs args, CustomResourceOptions? opts = null)
    public FunctionIamBinding(String name, FunctionIamBindingArgs args)
public FunctionIamBinding(String name, FunctionIamBindingArgs args, CustomResourceOptions options)

    type: gcp:cloudfunctionsv2:FunctionIamBinding
properties: # The arguments to resource properties.
options: # 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.
    resource_name str
    The unique name of the resource.
    args FunctionIamBindingArgs
    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 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.
    name String
    The unique name of the resource.
    args FunctionIamBindingArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts 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.cloudfunctionsv2.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    Condition FunctionIamBindingConditionArgs
    Location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    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.cloudfunctionsv2.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    Condition FunctionIamBindingConditionArgs
    Location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    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.cloudfunctionsv2.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    condition FunctionIamBindingConditionArgs
    location String

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    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.cloudfunctionsv2.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    condition FunctionIamBindingConditionArgs
    location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    cloud_function str

    Used to find the parent resource to bind the IAM policy to

    members Sequence[str]
    role str

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

    condition FunctionIamBindingConditionArgs
    location str

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    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.cloudfunctionsv2.FunctionIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

    condition Property Map
    location String

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

    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 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.

    etag String

    (Computed) The etag of the IAM policy.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_function: Optional[str] = None,
        condition: Optional[FunctionIamBindingConditionArgs] = None,
        etag: Optional[str] = None,
        location: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        role: Optional[str] = None) -> FunctionIamBinding
    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)
    public static FunctionIamBinding get(String name, Output<String> id, FunctionIamBindingState 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:
    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.

    Location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Role string

    The role that should be applied. Only one gcp.cloudfunctionsv2.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 FunctionIamBindingConditionArgs
    Etag string

    (Computed) The etag of the IAM policy.

    Location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Role string

    The role that should be applied. Only one gcp.cloudfunctionsv2.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 FunctionIamBindingConditionArgs
    etag String

    (Computed) The etag of the IAM policy.

    location String

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role String

    The role that should be applied. Only one gcp.cloudfunctionsv2.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 FunctionIamBindingConditionArgs
    etag string

    (Computed) The etag of the IAM policy.

    location string

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role string

    The role that should be applied. Only one gcp.cloudfunctionsv2.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 FunctionIamBindingConditionArgs
    etag str

    (Computed) The etag of the IAM policy.

    location str

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    members Sequence[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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role str

    The role that should be applied. Only one gcp.cloudfunctionsv2.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 Property Map
    etag String

    (Computed) The etag of the IAM policy.

    location String

    The location of this cloud function. Used to find the parent resource to bind the IAM policy to

    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role String

    The role that should be applied. Only one gcp.cloudfunctionsv2.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

    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

    For all import syntaxes, the “resource in question” can take any of the following forms* projects/{{project}}/locations/{{location}}/functions/{{cloud_function}} * {{project}}/{{location}}/{{cloud_function}} * {{location}}/{{cloud_function}} * {{cloud_function}} Any variables not passed in the import command will be taken from the provider configuration. Cloud Functions (2nd gen) function IAM resources can be imported using the resource identifiers, role, and member. IAM member imports use space-delimited identifiersthe resource in question, the role, and the member identity, e.g.

     $ pulumi import gcp:cloudfunctionsv2/functionIamBinding:FunctionIamBinding editor "projects/{{project}}/locations/{{location}}/functions/{{cloud_function}} roles/viewer user:jane@example.com"

    IAM binding imports use space-delimited identifiersthe resource in question and the role, e.g.

     $ pulumi import gcp:cloudfunctionsv2/functionIamBinding:FunctionIamBinding editor "projects/{{project}}/locations/{{location}}/functions/{{cloud_function}} roles/viewer"

    IAM policy imports use the identifier of the resource in question, e.g.

     $ pulumi import gcp:cloudfunctionsv2/functionIamBinding:FunctionIamBinding editor projects/{{project}}/locations/{{location}}/functions/{{cloud_function}}

    -> Custom RolesIf 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.

    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.

    gcp logo
    Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi
    pulumi/pulumi-gcp