The gcp:dataplex/zoneIamBinding:ZoneIamBinding resource, part of the Pulumi GCP provider, manages IAM role bindings for Dataplex zones by granting a specific role to a list of members. This guide focuses on two capabilities: authoritative role binding for multiple members and non-authoritative member addition.
ZoneIamBinding is one of three IAM resources for Dataplex zones. It’s authoritative for a given role, meaning it replaces all members for that role while preserving other roles. ZoneIamMember is non-authoritative, adding individual members without affecting others. ZoneIamPolicy is fully authoritative and cannot be used alongside ZoneIamBinding or ZoneIamMember. The examples are intentionally small. Combine them with your own Dataplex zones and access requirements.
Grant a role to multiple members
Teams managing zones often need to assign the same role to multiple users or service accounts at once, such as giving viewer access to a data team.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.dataplex.ZoneIamBinding("binding", {
project: example.project,
location: example.location,
lake: example.lake,
dataplexZone: example.name,
role: "roles/viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.dataplex.ZoneIamBinding("binding",
project=example["project"],
location=example["location"],
lake=example["lake"],
dataplex_zone=example["name"],
role="roles/viewer",
members=["user:jane@example.com"])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataplex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dataplex.NewZoneIamBinding(ctx, "binding", &dataplex.ZoneIamBindingArgs{
Project: pulumi.Any(example.Project),
Location: pulumi.Any(example.Location),
Lake: pulumi.Any(example.Lake),
DataplexZone: pulumi.Any(example.Name),
Role: pulumi.String("roles/viewer"),
Members: pulumi.StringArray{
pulumi.String("user:jane@example.com"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var binding = new Gcp.DataPlex.ZoneIamBinding("binding", new()
{
Project = example.Project,
Location = example.Location,
Lake = example.Lake,
DataplexZone = example.Name,
Role = "roles/viewer",
Members = new[]
{
"user:jane@example.com",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.ZoneIamBinding;
import com.pulumi.gcp.dataplex.ZoneIamBindingArgs;
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 ZoneIamBinding("binding", ZoneIamBindingArgs.builder()
.project(example.project())
.location(example.location())
.lake(example.lake())
.dataplexZone(example.name())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:dataplex:ZoneIamBinding
properties:
project: ${example.project}
location: ${example.location}
lake: ${example.lake}
dataplexZone: ${example.name}
role: roles/viewer
members:
- user:jane@example.com
The role property specifies which IAM role to grant (e.g., “roles/viewer”). The members array lists all identities that receive this role; ZoneIamBinding replaces any existing members for this role. The dataplexZone, lake, location, and project properties identify which zone to configure.
Add a single member to a role
When onboarding individual users or granting access to specific service accounts, you can add members one at a time without affecting others.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.dataplex.ZoneIamMember("member", {
project: example.project,
location: example.location,
lake: example.lake,
dataplexZone: example.name,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.dataplex.ZoneIamMember("member",
project=example["project"],
location=example["location"],
lake=example["lake"],
dataplex_zone=example["name"],
role="roles/viewer",
member="user:jane@example.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataplex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dataplex.NewZoneIamMember(ctx, "member", &dataplex.ZoneIamMemberArgs{
Project: pulumi.Any(example.Project),
Location: pulumi.Any(example.Location),
Lake: pulumi.Any(example.Lake),
DataplexZone: pulumi.Any(example.Name),
Role: pulumi.String("roles/viewer"),
Member: pulumi.String("user:jane@example.com"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var member = new Gcp.DataPlex.ZoneIamMember("member", new()
{
Project = example.Project,
Location = example.Location,
Lake = example.Lake,
DataplexZone = example.Name,
Role = "roles/viewer",
Member = "user:jane@example.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.ZoneIamMember;
import com.pulumi.gcp.dataplex.ZoneIamMemberArgs;
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 ZoneIamMember("member", ZoneIamMemberArgs.builder()
.project(example.project())
.location(example.location())
.lake(example.lake())
.dataplexZone(example.name())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:dataplex:ZoneIamMember
properties:
project: ${example.project}
location: ${example.location}
lake: ${example.lake}
dataplexZone: ${example.name}
role: roles/viewer
member: user:jane@example.com
ZoneIamMember is non-authoritative: it adds a single member to a role without removing existing members. Use member (singular) instead of members (array). This approach works well when multiple teams manage access independently, but avoid using ZoneIamMember and ZoneIamBinding for the same role, as they will conflict.
Beyond these examples
These snippets focus on specific IAM binding features: role-based access control and authoritative vs non-authoritative member management. They’re intentionally minimal rather than full access control configurations.
The examples reference pre-existing infrastructure such as Dataplex zones and lakes, and a GCP project with Dataplex API enabled. They focus on configuring IAM bindings rather than provisioning the underlying Dataplex resources.
To keep things focused, common IAM patterns are omitted, including:
- Conditional IAM bindings (condition property)
- Policy-level management (ZoneIamPolicy resource)
- Custom role definitions
- Federated identity configuration
These omissions are intentional: the goal is to illustrate how IAM bindings are wired, not provide drop-in access control modules. See the Dataplex ZoneIamBinding resource reference for all available configuration options.
Let's manage GCP Dataplex Zone IAM Bindings
Get started with Pulumi Cloud, then follow our quick setup guide to deploy this infrastructure.
Try Pulumi Cloud for FREEFrequently Asked Questions
Resource Selection & Conflicts
gcp.dataplex.ZoneIamPolicy cannot be used with gcp.dataplex.ZoneIamBinding or gcp.dataplex.ZoneIamMember because they will conflict over the policy. Use ZoneIamPolicy alone for full control, or use ZoneIamBinding and ZoneIamMember together.gcp.dataplex.ZoneIamBinding manages all members for a specific role, so mixing with ZoneIamMember for that same role will cause conflicts.gcp.dataplex.ZoneIamPolicy replaces the entire policy (authoritative), gcp.dataplex.ZoneIamBinding manages all members for a specific role (preserves other roles), and gcp.dataplex.ZoneIamMember adds individual members (preserves other members for the role).Configuration & Formats
[projects|organizations]/{parent-name}/roles/{role-name}. For example, projects/my-project/roles/customRole or organizations/my-org/roles/customRole.members array supports: allUsers, allAuthenticatedUsers, user:{email}, serviceAccount:{email}, group:{email}, domain:{domain}, projectOwner:projectid, projectEditor:projectid, projectViewer:projectid, and federated identities like principal://iam.googleapis.com/....Resource Properties
role, dataplexZone, lake, location, project, and condition properties are all immutable. You must recreate the resource to change any of these values.