The gcp:bigquery/connectionIamPolicy:ConnectionIamPolicy resource, part of the Pulumi GCP provider, manages IAM policies for BigQuery connections, controlling who can access and use connection resources. This guide focuses on three approaches: authoritative policy replacement, role-based member binding, and incremental member addition.
BigQuery connection IAM resources reference an existing connection and follow strict compatibility rules. ConnectionIamPolicy replaces the entire policy and cannot coexist with ConnectionIamBinding or ConnectionIamMember. ConnectionIamBinding and ConnectionIamMember can work together if they manage different roles. The examples are intentionally small. Combine them with your own connection resources and organizational access patterns.
Replace the entire IAM policy for a connection
When you need complete control over connection access, you can set the entire IAM policy at once, replacing any existing permissions.
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.bigquery.ConnectionIamPolicy("policy", {
project: connection.project,
location: connection.location,
connectionId: connection.connectionId,
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.bigquery.ConnectionIamPolicy("policy",
project=connection["project"],
location=connection["location"],
connection_id=connection["connectionId"],
policy_data=admin.policy_data)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigquery"
"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 = bigquery.NewConnectionIamPolicy(ctx, "policy", &bigquery.ConnectionIamPolicyArgs{
Project: pulumi.Any(connection.Project),
Location: pulumi.Any(connection.Location),
ConnectionId: pulumi.Any(connection.ConnectionId),
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.BigQuery.ConnectionIamPolicy("policy", new()
{
Project = connection.Project,
Location = connection.Location,
ConnectionId = connection.ConnectionId,
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.bigquery.ConnectionIamPolicy;
import com.pulumi.gcp.bigquery.ConnectionIamPolicyArgs;
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 ConnectionIamPolicy("policy", ConnectionIamPolicyArgs.builder()
.project(connection.project())
.location(connection.location())
.connectionId(connection.connectionId())
.policyData(admin.policyData())
.build());
}
}
resources:
policy:
type: gcp:bigquery:ConnectionIamPolicy
properties:
project: ${connection.project}
location: ${connection.location}
connectionId: ${connection.connectionId}
policyData: ${admin.policyData}
variables:
admin:
fn::invoke:
function: gcp:organizations:getIAMPolicy
arguments:
bindings:
- role: roles/viewer
members:
- user:jane@example.com
The ConnectionIamPolicy resource sets the complete IAM policy using policyData from the getIAMPolicy data source. This approach is authoritative: it replaces any existing policy on the connection. The bindings array in getIAMPolicy defines all roles and members; anything not listed is removed.
Grant a role to multiple members at once
Teams often need to grant the same role to several users or service accounts without affecting other roles already assigned.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const binding = new gcp.bigquery.ConnectionIamBinding("binding", {
project: connection.project,
location: connection.location,
connectionId: connection.connectionId,
role: "roles/viewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
binding = gcp.bigquery.ConnectionIamBinding("binding",
project=connection["project"],
location=connection["location"],
connection_id=connection["connectionId"],
role="roles/viewer",
members=["user:jane@example.com"])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bigquery.NewConnectionIamBinding(ctx, "binding", &bigquery.ConnectionIamBindingArgs{
Project: pulumi.Any(connection.Project),
Location: pulumi.Any(connection.Location),
ConnectionId: pulumi.Any(connection.ConnectionId),
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.BigQuery.ConnectionIamBinding("binding", new()
{
Project = connection.Project,
Location = connection.Location,
ConnectionId = connection.ConnectionId,
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.bigquery.ConnectionIamBinding;
import com.pulumi.gcp.bigquery.ConnectionIamBindingArgs;
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 ConnectionIamBinding("binding", ConnectionIamBindingArgs.builder()
.project(connection.project())
.location(connection.location())
.connectionId(connection.connectionId())
.role("roles/viewer")
.members("user:jane@example.com")
.build());
}
}
resources:
binding:
type: gcp:bigquery:ConnectionIamBinding
properties:
project: ${connection.project}
location: ${connection.location}
connectionId: ${connection.connectionId}
role: roles/viewer
members:
- user:jane@example.com
The ConnectionIamBinding resource controls all members for a specific role. The members array lists everyone who should have that role; other roles on the connection remain unchanged. This is authoritative for the specified role but preserves other roles.
Add a single member to a role incrementally
When you want to grant access to one user without managing the full member list for a role, you can add members individually.
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const member = new gcp.bigquery.ConnectionIamMember("member", {
project: connection.project,
location: connection.location,
connectionId: connection.connectionId,
role: "roles/viewer",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
member = gcp.bigquery.ConnectionIamMember("member",
project=connection["project"],
location=connection["location"],
connection_id=connection["connectionId"],
role="roles/viewer",
member="user:jane@example.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bigquery.NewConnectionIamMember(ctx, "member", &bigquery.ConnectionIamMemberArgs{
Project: pulumi.Any(connection.Project),
Location: pulumi.Any(connection.Location),
ConnectionId: pulumi.Any(connection.ConnectionId),
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.BigQuery.ConnectionIamMember("member", new()
{
Project = connection.Project,
Location = connection.Location,
ConnectionId = connection.ConnectionId,
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.bigquery.ConnectionIamMember;
import com.pulumi.gcp.bigquery.ConnectionIamMemberArgs;
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 ConnectionIamMember("member", ConnectionIamMemberArgs.builder()
.project(connection.project())
.location(connection.location())
.connectionId(connection.connectionId())
.role("roles/viewer")
.member("user:jane@example.com")
.build());
}
}
resources:
member:
type: gcp:bigquery:ConnectionIamMember
properties:
project: ${connection.project}
location: ${connection.location}
connectionId: ${connection.connectionId}
role: roles/viewer
member: user:jane@example.com
The ConnectionIamMember resource adds a single member to a role without affecting existing members. This is non-authoritative: other members for the same role are preserved. Use this when you want to grant access incrementally rather than managing complete member lists.
Beyond these examples
These snippets focus on specific IAM management patterns: authoritative vs non-authoritative IAM management, role-based access control, and policy data sourcing from getIAMPolicy. They’re intentionally minimal rather than full access control configurations.
The examples reference pre-existing infrastructure such as BigQuery connections (via connectionId) and GCP projects and locations. They focus on IAM policy configuration rather than provisioning the underlying connection resources.
To keep things focused, common IAM patterns are omitted, including:
- Conditional IAM bindings (condition blocks)
- Custom role definitions
- Audit logging configuration
- Policy etag handling for concurrent updates
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 BigQuery ConnectionIamPolicy resource reference for all available configuration options.
Let's manage GCP BigQuery Connection 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 Selection & Conflicts
ConnectionIamPolicy is authoritative and replaces the entire IAM policy. ConnectionIamBinding is authoritative for a single role, preserving other roles. ConnectionIamMember is non-authoritative, adding one member while preserving existing members for that role.ConnectionIamPolicy cannot be used with ConnectionIamBinding or ConnectionIamMember because they will conflict over the policy. Choose one approach: use ConnectionIamPolicy alone, or use ConnectionIamBinding and ConnectionIamMember together.Configuration & Setup
gcp.organizations.getIAMPolicy data source to generate policyData, as shown in the examples.US, EU, asia-northeast1, us-central1, europe-west1. Cloud SQL has special mappings: us-central1 maps to BigQuery US, europe-west1 maps to BigQuery EU. Spanner uses the same region. AWS allows aws-us-east-1. Azure allows azure-eastus2.Properties & Constraints
connectionId, location, and project properties cannot be changed after the resource is created.