The gcp:dataplex/datascanIamPolicy:DatascanIamPolicy resource, part of the Pulumi GCP provider, controls IAM permissions for Dataplex datascans using three distinct approaches: authoritative policy replacement (DatascanIamPolicy), role-based binding (DatascanIamBinding), and incremental member addition (DatascanIamMember). This guide focuses on three capabilities: authoritative policy replacement, role-based member binding, and incremental member addition.
These resources reference existing Dataplex datascan resources by dataScanId, project, and location. The examples are intentionally small. Combine them with your own datascan infrastructure and IAM policies. Note that DatascanIamPolicy cannot be used alongside DatascanIamBinding or DatascanIamMember, as they will conflict over policy ownership.
Replace the entire IAM policy for a datascan
When you need complete control over datascan permissions, you can set the entire IAM policy at once, replacing any existing assignments.
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.dataplex.DatascanIamPolicy("policy", {
project: basicProfile.project,
location: basicProfile.location,
dataScanId: basicProfile.dataScanId,
policyData: admin.then(admin => admin.policyData),
});
import pulumi
import pulumi_gcp as gcp
admin = gcp.organizations.get_iam_policy(bindings=[{
"role": "roles/viewer",
"members": ["user:jane@example.com"],
}])
policy = gcp.dataplex.DatascanIamPolicy("policy",
project=basic_profile["project"],
location=basic_profile["location"],
data_scan_id=basic_profile["dataScanId"],
policy_data=admin.policy_data)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataplex"
"github.com/pulumi/pulumi-gcp/sdk/v9/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 = dataplex.NewDatascanIamPolicy(ctx, "policy", &dataplex.DatascanIamPolicyArgs{
Project: pulumi.Any(basicProfile.Project),
Location: pulumi.Any(basicProfile.Location),
DataScanId: pulumi.Any(basicProfile.DataScanId),
PolicyData: pulumi.String(admin.PolicyData),
})
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 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.DataPlex.DatascanIamPolicy("policy", new()
{
Project = basicProfile.Project,
Location = basicProfile.Location,
DataScanId = basicProfile.DataScanId,
PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
});
});
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.dataplex.DatascanIamPolicy;
import com.pulumi.gcp.dataplex.DatascanIamPolicyArgs;
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 DatascanIamPolicy("policy", DatascanIamPolicyArgs.builder()
.project(basicProfile.project())
.location(basicProfile.location())
.dataScanId(basicProfile.dataScanId())
.policyData(admin.policyData())
.build());
}
}
resources:
policy:
type: gcp:dataplex:DatascanIamPolicy
properties:
project: ${basicProfile.project}
location: ${basicProfile.location}
dataScanId: ${basicProfile.dataScanId}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/viewer
members:
- user:jane@example.com
The DatascanIamPolicy resource is authoritative: it replaces the entire IAM policy for the datascan. The policyData property accepts output from the getIAMPolicy data source, which defines bindings between roles and members. This approach gives you full control but removes any permissions not explicitly listed.
Grant a role to multiple members at once
When multiple users or service accounts need the same access level, you can bind them all to a single role without affecting other role assignments.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.dataplex.DatascanIamBinding("binding", {
project: basicProfile.project,
location: basicProfile.location,
dataScanId: basicProfile.dataScanId,
role: "roles/viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.dataplex.DatascanIamBinding("binding",
project=basic_profile["project"],
location=basic_profile["location"],
data_scan_id=basic_profile["dataScanId"],
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.NewDatascanIamBinding(ctx, "binding", &dataplex.DatascanIamBindingArgs{
Project: pulumi.Any(basicProfile.Project),
Location: pulumi.Any(basicProfile.Location),
DataScanId: pulumi.Any(basicProfile.DataScanId),
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.DatascanIamBinding("binding", new()
{
Project = basicProfile.Project,
Location = basicProfile.Location,
DataScanId = basicProfile.DataScanId,
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.DatascanIamBinding;
import com.pulumi.gcp.dataplex.DatascanIamBindingArgs;
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 DatascanIamBinding("binding", DatascanIamBindingArgs.builder()
.project(basicProfile.project())
.location(basicProfile.location())
.dataScanId(basicProfile.dataScanId())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:dataplex:DatascanIamBinding
properties:
project: ${basicProfile.project}
location: ${basicProfile.location}
dataScanId: ${basicProfile.dataScanId}
role: roles/viewer
members:
- user:jane@example.com
The DatascanIamBinding resource is authoritative for a specific role: it sets the complete member list for that role while preserving other roles. The members property accepts a list of identities (users, service accounts, groups). You can use multiple DatascanIamBinding resources for different roles on the same datascan.
Add a single member to a role incrementally
When you need to grant access to one additional user without modifying existing permissions, you can add individual members to roles.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.dataplex.DatascanIamMember("member", {
project: basicProfile.project,
location: basicProfile.location,
dataScanId: basicProfile.dataScanId,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.dataplex.DatascanIamMember("member",
project=basic_profile["project"],
location=basic_profile["location"],
data_scan_id=basic_profile["dataScanId"],
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.NewDatascanIamMember(ctx, "member", &dataplex.DatascanIamMemberArgs{
Project: pulumi.Any(basicProfile.Project),
Location: pulumi.Any(basicProfile.Location),
DataScanId: pulumi.Any(basicProfile.DataScanId),
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.DatascanIamMember("member", new()
{
Project = basicProfile.Project,
Location = basicProfile.Location,
DataScanId = basicProfile.DataScanId,
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.DatascanIamMember;
import com.pulumi.gcp.dataplex.DatascanIamMemberArgs;
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 DatascanIamMember("member", DatascanIamMemberArgs.builder()
.project(basicProfile.project())
.location(basicProfile.location())
.dataScanId(basicProfile.dataScanId())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:dataplex:DatascanIamMember
properties:
project: ${basicProfile.project}
location: ${basicProfile.location}
dataScanId: ${basicProfile.dataScanId}
role: roles/viewer
member: user:jane@example.com
The DatascanIamMember resource is non-authoritative: it adds one member to a role without affecting other members. The member property accepts a single identity. This approach is useful when multiple teams manage access independently, as each can add members without coordinating changes.
Beyond these examples
These snippets focus on specific IAM management approaches: authoritative policy replacement, role-based binding, and incremental member addition. They’re intentionally minimal rather than full access control configurations.
The examples reference pre-existing infrastructure such as Dataplex datascan resources (referenced by dataScanId). They focus on IAM policy configuration rather than provisioning the underlying datascans.
To keep things focused, common IAM patterns are omitted, including:
- Conditional IAM bindings (condition blocks)
- Custom role definitions
- Service account impersonation
- Policy retrieval using data sources
These omissions are intentional: the goal is to illustrate how each IAM resource type is wired, not provide drop-in access control modules. See the Datascan IAM Policy resource reference for all available configuration options.
Let's manage GCP Dataplex Datascan IAM Policies
Get started with Pulumi Cloud, then follow our quick setup guide to deploy this infrastructure.
Try Pulumi Cloud for FREEFrequently Asked Questions
Resource Conflicts & Compatibility
DatascanIamPolicy cannot be used alongside DatascanIamBinding or DatascanIamMember because they will conflict over the policy state.Choosing the Right Resource
Three levels of control:
- DatascanIamPolicy: Authoritative, replaces the entire IAM policy
- DatascanIamBinding: Authoritative for a specific role, preserves other roles
- DatascanIamMember: Non-authoritative, adds a single member to a role, preserves other members
DatascanIamPolicy when you want complete control over all IAM permissions. Use DatascanIamBinding when you only need to manage specific roles while preserving others.DatascanIamMember when you need to add individual members to a role without affecting other members, such as when multiple teams manage different users for the same role.Configuration & Setup
gcp.organizations.getIAMPolicy data source with bindings, then pass the policyData output to your DatascanIamPolicy resource.dataScanId, location, and project. If location or project aren’t specified, they’re parsed from the parent resource identifier or provider configuration.Import & Migration
Four formats are supported:
projects/{{project}}/locations/{{location}}/dataScans/{{data_scan_id}}{{project}}/{{location}}/{{data_scan_id}}{{location}}/{{data_scan_id}}{{data_scan_id}}
Missing variables are taken from the provider configuration.