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

gcp.dataproc.ClusterIAMBinding

Explore with Pulumi AI

Three different resources help you manage IAM policies on dataproc clusters. Each of these resources serves a different use case:

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

Note: gcp.dataproc.ClusterIAMPolicy cannot be used in conjunction with gcp.dataproc.ClusterIAMBinding and gcp.dataproc.ClusterIAMMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the cluster as gcp.dataproc.ClusterIAMPolicy replaces the entire policy.

Note: gcp.dataproc.ClusterIAMBinding resources can be used in conjunction with gcp.dataproc.ClusterIAMMember resources only if they do not grant privilege to the same role.

google_dataproc_cluster_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/editor",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.dataproc.ClusterIAMPolicy("editor", {
    project: "your-project",
    region: "your-region",
    cluster: "your-dataproc-cluster",
    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/editor",
    members=["user:jane@example.com"],
)])
editor = gcp.dataproc.ClusterIAMPolicy("editor",
    project="your-project",
    region="your-region",
    cluster="your-dataproc-cluster",
    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/editor",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var editor = new Gcp.Dataproc.ClusterIAMPolicy("editor", new()
    {
        Project = "your-project",
        Region = "your-region",
        Cluster = "your-dataproc-cluster",
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/dataproc"
	"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/editor",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = dataproc.NewClusterIAMPolicy(ctx, "editor", &dataproc.ClusterIAMPolicyArgs{
			Project:    pulumi.String("your-project"),
			Region:     pulumi.String("your-region"),
			Cluster:    pulumi.String("your-dataproc-cluster"),
			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.dataproc.ClusterIAMPolicy;
import com.pulumi.gcp.dataproc.ClusterIAMPolicyArgs;
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/editor")
                .members("user:jane@example.com")
                .build())
            .build());

        var editor = new ClusterIAMPolicy("editor", ClusterIAMPolicyArgs.builder()        
            .project("your-project")
            .region("your-region")
            .cluster("your-dataproc-cluster")
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

resources:
  editor:
    type: gcp:dataproc:ClusterIAMPolicy
    properties:
      project: your-project
      region: your-region
      cluster: your-dataproc-cluster
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/editor
            members:
              - user:jane@example.com

google_dataproc_cluster_iam_binding

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

const editor = new gcp.dataproc.ClusterIAMBinding("editor", {
    cluster: "your-dataproc-cluster",
    members: ["user:jane@example.com"],
    role: "roles/editor",
});

import pulumi
import pulumi_gcp as gcp

editor = gcp.dataproc.ClusterIAMBinding("editor",
    cluster="your-dataproc-cluster",
    members=["user:jane@example.com"],
    role="roles/editor")

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

return await Deployment.RunAsync(() => 
{
    var editor = new Gcp.Dataproc.ClusterIAMBinding("editor", new()
    {
        Cluster = "your-dataproc-cluster",
        Members = new[]
        {
            "user:jane@example.com",
        },
        Role = "roles/editor",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataproc.NewClusterIAMBinding(ctx, "editor", &dataproc.ClusterIAMBindingArgs{
			Cluster: pulumi.String("your-dataproc-cluster"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
			Role: pulumi.String("roles/editor"),
		})
		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.dataproc.ClusterIAMBinding;
import com.pulumi.gcp.dataproc.ClusterIAMBindingArgs;
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 editor = new ClusterIAMBinding("editor", ClusterIAMBindingArgs.builder()        
            .cluster("your-dataproc-cluster")
            .members("user:jane@example.com")
            .role("roles/editor")
            .build());

    }
}

resources:
  editor:
    type: gcp:dataproc:ClusterIAMBinding
    properties:
      cluster: your-dataproc-cluster
      members:
        - user:jane@example.com
      role: roles/editor

google_dataproc_cluster_iam_member

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

const editor = new gcp.dataproc.ClusterIAMMember("editor", {
    cluster: "your-dataproc-cluster",
    member: "user:jane@example.com",
    role: "roles/editor",
});

import pulumi
import pulumi_gcp as gcp

editor = gcp.dataproc.ClusterIAMMember("editor",
    cluster="your-dataproc-cluster",
    member="user:jane@example.com",
    role="roles/editor")

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

return await Deployment.RunAsync(() => 
{
    var editor = new Gcp.Dataproc.ClusterIAMMember("editor", new()
    {
        Cluster = "your-dataproc-cluster",
        Member = "user:jane@example.com",
        Role = "roles/editor",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataproc.NewClusterIAMMember(ctx, "editor", &dataproc.ClusterIAMMemberArgs{
			Cluster: pulumi.String("your-dataproc-cluster"),
			Member:  pulumi.String("user:jane@example.com"),
			Role:    pulumi.String("roles/editor"),
		})
		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.dataproc.ClusterIAMMember;
import com.pulumi.gcp.dataproc.ClusterIAMMemberArgs;
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 editor = new ClusterIAMMember("editor", ClusterIAMMemberArgs.builder()        
            .cluster("your-dataproc-cluster")
            .member("user:jane@example.com")
            .role("roles/editor")
            .build());

    }
}

resources:
  editor:
    type: gcp:dataproc:ClusterIAMMember
    properties:
      cluster: your-dataproc-cluster
      member: user:jane@example.com
      role: roles/editor

Create ClusterIAMBinding Resource

new ClusterIAMBinding(name: string, args: ClusterIAMBindingArgs, opts?: CustomResourceOptions);
@overload
def ClusterIAMBinding(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster: Optional[str] = None,
                      condition: Optional[ClusterIAMBindingConditionArgs] = None,
                      members: Optional[Sequence[str]] = None,
                      project: Optional[str] = None,
                      region: Optional[str] = None,
                      role: Optional[str] = None)
@overload
def ClusterIAMBinding(resource_name: str,
                      args: ClusterIAMBindingArgs,
                      opts: Optional[ResourceOptions] = None)
func NewClusterIAMBinding(ctx *Context, name string, args ClusterIAMBindingArgs, opts ...ResourceOption) (*ClusterIAMBinding, error)
public ClusterIAMBinding(string name, ClusterIAMBindingArgs args, CustomResourceOptions? opts = null)
public ClusterIAMBinding(String name, ClusterIAMBindingArgs args)
public ClusterIAMBinding(String name, ClusterIAMBindingArgs args, CustomResourceOptions options)

type: gcp:dataproc:ClusterIAMBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterIAMBindingArgs
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 ClusterIAMBindingArgs
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 ClusterIAMBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterIAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterIAMBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ClusterIAMBinding 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 ClusterIAMBinding resource accepts the following input properties:

Cluster string

The name or relative resource id of the cluster to manage IAM policies for.

Members List<string>
Role string

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

Condition ClusterIAMBindingConditionArgs
Project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

Region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

Cluster string

The name or relative resource id of the cluster to manage IAM policies for.

Members []string
Role string

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

Condition ClusterIAMBindingConditionArgs
Project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

Region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

cluster String

The name or relative resource id of the cluster to manage IAM policies for.

members List<String>
role String

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

condition ClusterIAMBindingConditionArgs
project String

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region String

The region in which the cluster belongs. If it is not provided, the provider will use a default.

cluster string

The name or relative resource id of the cluster to manage IAM policies for.

members string[]
role string

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

condition ClusterIAMBindingConditionArgs
project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

cluster str

The name or relative resource id of the cluster to manage IAM policies for.

members Sequence[str]
role str

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

condition ClusterIAMBindingConditionArgs
project str

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region str

The region in which the cluster belongs. If it is not provided, the provider will use a default.

cluster String

The name or relative resource id of the cluster to manage IAM policies for.

members List<String>
role String

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

condition Property Map
project String

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region String

The region in which the cluster belongs. If it is not provided, the provider will use a default.

Outputs

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

Etag string

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

Id string

The provider-assigned unique ID for this managed resource.

Etag string

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

Id string

The provider-assigned unique ID for this managed resource.

etag String

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

id String

The provider-assigned unique ID for this managed resource.

etag string

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

id string

The provider-assigned unique ID for this managed resource.

etag str

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

id str

The provider-assigned unique ID for this managed resource.

etag String

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

id String

The provider-assigned unique ID for this managed resource.

Look up Existing ClusterIAMBinding Resource

Get an existing ClusterIAMBinding 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?: ClusterIAMBindingState, opts?: CustomResourceOptions): ClusterIAMBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster: Optional[str] = None,
        condition: Optional[ClusterIAMBindingConditionArgs] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        role: Optional[str] = None) -> ClusterIAMBinding
func GetClusterIAMBinding(ctx *Context, name string, id IDInput, state *ClusterIAMBindingState, opts ...ResourceOption) (*ClusterIAMBinding, error)
public static ClusterIAMBinding Get(string name, Input<string> id, ClusterIAMBindingState? state, CustomResourceOptions? opts = null)
public static ClusterIAMBinding get(String name, Output<String> id, ClusterIAMBindingState 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:
Cluster string

The name or relative resource id of the cluster to manage IAM policies for.

Condition ClusterIAMBindingConditionArgs
Etag string

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

Members List<string>
Project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

Region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

Role string

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

Cluster string

The name or relative resource id of the cluster to manage IAM policies for.

Condition ClusterIAMBindingConditionArgs
Etag string

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

Members []string
Project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

Region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

Role string

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

cluster String

The name or relative resource id of the cluster to manage IAM policies for.

condition ClusterIAMBindingConditionArgs
etag String

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

members List<String>
project String

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region String

The region in which the cluster belongs. If it is not provided, the provider will use a default.

role String

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

cluster string

The name or relative resource id of the cluster to manage IAM policies for.

condition ClusterIAMBindingConditionArgs
etag string

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

members string[]
project string

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region string

The region in which the cluster belongs. If it is not provided, the provider will use a default.

role string

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

cluster str

The name or relative resource id of the cluster to manage IAM policies for.

condition ClusterIAMBindingConditionArgs
etag str

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

members Sequence[str]
project str

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region str

The region in which the cluster belongs. If it is not provided, the provider will use a default.

role str

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

cluster String

The name or relative resource id of the cluster to manage IAM policies for.

condition Property Map
etag String

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

members List<String>
project String

The project in which the cluster belongs. If it is not provided, the provider will use a default.

region String

The region in which the cluster belongs. If it is not provided, the provider will use a default.

role String

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

Supporting Types

ClusterIAMBindingCondition

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

Cluster IAM resources can be imported using the project, region, cluster name, role and/or member.

 $ pulumi import gcp:dataproc/clusterIAMBinding:ClusterIAMBinding editor "projects/{project}/regions/{region}/clusters/{cluster}"

 $ pulumi import gcp:dataproc/clusterIAMBinding:ClusterIAMBinding editor "projects/{project}/regions/{region}/clusters/{cluster} roles/editor"

 $ pulumi import gcp:dataproc/clusterIAMBinding:ClusterIAMBinding editor "projects/{project}/regions/{region}/clusters/{cluster} roles/editor user:jane@example.com"

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