gcp.bigquery.DatasetIamBinding
Explore with Pulumi AI
Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:
gcp.bigquery.DatasetIamPolicy
: Authoritative. Sets the IAM policy for the dataset and replaces any existing policy already attached.gcp.bigquery.DatasetIamBinding
: 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 dataset are preserved.gcp.bigquery.DatasetIamMember
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the dataset are preserved.
These resources are intended to convert the permissions system for BigQuery datasets to the standard IAM interface. For advanced usages, including creating authorized views, please use either gcp.bigquery.DatasetAccess
or the access
field on gcp.bigquery.Dataset
.
Note: These resources cannot be used with
gcp.bigquery.DatasetAccess
resources or theaccess
field ongcp.bigquery.Dataset
or they will fight over what the policy should be.
Note: Using any of these resources will remove any authorized view permissions from the dataset. To assign and preserve authorized view permissions use the
gcp.bigquery.DatasetAccess
instead.
Note: Legacy BigQuery roles
OWNER
WRITER
andREADER
cannot be used with any of these IAM resources. Instead use the full role form of:roles/bigquery.dataOwner
roles/bigquery.dataEditor
androles/bigquery.dataViewer
.
Note:
gcp.bigquery.DatasetIamPolicy
cannot be used in conjunction withgcp.bigquery.DatasetIamBinding
andgcp.bigquery.DatasetIamMember
or they will fight over what your policy should be.
Note:
gcp.bigquery.DatasetIamBinding
resources can be used in conjunction withgcp.bigquery.DatasetIamMember
resources only if they do not grant privilege to the same role.
gcp.bigquery.DatasetIamPolicy
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const owner = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/bigquery.dataOwner",
members: ["user:jane@example.com"],
}],
});
const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
datasetId: datasetDataset.datasetId,
policyData: owner.then(owner => owner.policyData),
});
import pulumi
import pulumi_gcp as gcp
owner = gcp.organizations.get_iam_policy(bindings=[gcp.organizations.GetIAMPolicyBindingArgs(
role="roles/bigquery.dataOwner",
members=["user:jane@example.com"],
)])
dataset_dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
dataset = gcp.bigquery.DatasetIamPolicy("dataset",
dataset_id=dataset_dataset.dataset_id,
policy_data=owner.policy_data)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
owner, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
Bindings: []organizations.GetIAMPolicyBinding{
{
Role: "roles/bigquery.dataOwner",
Members: []string{
"user:jane@example.com",
},
},
},
}, nil)
if err != nil {
return err
}
datasetDataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamPolicy(ctx, "dataset", &bigquery.DatasetIamPolicyArgs{
DatasetId: datasetDataset.DatasetId,
PolicyData: pulumi.String(owner.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 owner = Gcp.Organizations.GetIAMPolicy.Invoke(new()
{
Bindings = new[]
{
new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
{
Role = "roles/bigquery.dataOwner",
Members = new[]
{
"user:jane@example.com",
},
},
},
});
var datasetDataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var dataset = new Gcp.BigQuery.DatasetIamPolicy("dataset", new()
{
DatasetId = datasetDataset.DatasetId,
PolicyData = owner.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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamPolicy;
import com.pulumi.gcp.bigquery.DatasetIamPolicyArgs;
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 owner = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
.bindings(GetIAMPolicyBindingArgs.builder()
.role("roles/bigquery.dataOwner")
.members("user:jane@example.com")
.build())
.build());
var datasetDataset = new Dataset("datasetDataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var dataset = new DatasetIamPolicy("dataset", DatasetIamPolicyArgs.builder()
.datasetId(datasetDataset.datasetId())
.policyData(owner.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
dataset:
type: gcp:bigquery:DatasetIamPolicy
properties:
datasetId: ${datasetDataset.datasetId}
policyData: ${owner.policyData}
datasetDataset:
type: gcp:bigquery:Dataset
name: dataset
properties:
datasetId: example_dataset
variables:
owner:
fn::invoke:
Function: gcp:organizations:getIAMPolicy
Arguments:
bindings:
- role: roles/bigquery.dataOwner
members:
- user:jane@example.com
gcp.bigquery.DatasetIamBinding
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const reader = new gcp.bigquery.DatasetIamBinding("reader", {
datasetId: dataset.datasetId,
role: "roles/bigquery.dataViewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
reader = gcp.bigquery.DatasetIamBinding("reader",
dataset_id=dataset.dataset_id,
role="roles/bigquery.dataViewer",
members=["user:jane@example.com"])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamBinding(ctx, "reader", &bigquery.DatasetIamBindingArgs{
DatasetId: dataset.DatasetId,
Role: pulumi.String("roles/bigquery.dataViewer"),
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 dataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var reader = new Gcp.BigQuery.DatasetIamBinding("reader", new()
{
DatasetId = dataset.DatasetId,
Role = "roles/bigquery.dataViewer",
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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamBinding;
import com.pulumi.gcp.bigquery.DatasetIamBindingArgs;
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 dataset = new Dataset("dataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var reader = new DatasetIamBinding("reader", DatasetIamBindingArgs.builder()
.datasetId(dataset.datasetId())
.role("roles/bigquery.dataViewer")
.members("user:jane@example.com")
.build());
}
}
resources:
reader:
type: gcp:bigquery:DatasetIamBinding
properties:
datasetId: ${dataset.datasetId}
role: roles/bigquery.dataViewer
members:
- user:jane@example.com
dataset:
type: gcp:bigquery:Dataset
properties:
datasetId: example_dataset
gcp.bigquery.DatasetIamMember
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const editor = new gcp.bigquery.DatasetIamMember("editor", {
datasetId: dataset.datasetId,
role: "roles/bigquery.dataEditor",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
editor = gcp.bigquery.DatasetIamMember("editor",
dataset_id=dataset.dataset_id,
role="roles/bigquery.dataEditor",
member="user:jane@example.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamMember(ctx, "editor", &bigquery.DatasetIamMemberArgs{
DatasetId: dataset.DatasetId,
Role: pulumi.String("roles/bigquery.dataEditor"),
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 dataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var editor = new Gcp.BigQuery.DatasetIamMember("editor", new()
{
DatasetId = dataset.DatasetId,
Role = "roles/bigquery.dataEditor",
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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamMember;
import com.pulumi.gcp.bigquery.DatasetIamMemberArgs;
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 dataset = new Dataset("dataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var editor = new DatasetIamMember("editor", DatasetIamMemberArgs.builder()
.datasetId(dataset.datasetId())
.role("roles/bigquery.dataEditor")
.member("user:jane@example.com")
.build());
}
}
resources:
editor:
type: gcp:bigquery:DatasetIamMember
properties:
datasetId: ${dataset.datasetId}
role: roles/bigquery.dataEditor
member: user:jane@example.com
dataset:
type: gcp:bigquery:Dataset
properties:
datasetId: example_dataset
gcp.bigquery.DatasetIamPolicy
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const owner = gcp.organizations.getIAMPolicy({
bindings: [{
role: "roles/bigquery.dataOwner",
members: ["user:jane@example.com"],
}],
});
const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
datasetId: datasetDataset.datasetId,
policyData: owner.then(owner => owner.policyData),
});
import pulumi
import pulumi_gcp as gcp
owner = gcp.organizations.get_iam_policy(bindings=[gcp.organizations.GetIAMPolicyBindingArgs(
role="roles/bigquery.dataOwner",
members=["user:jane@example.com"],
)])
dataset_dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
dataset = gcp.bigquery.DatasetIamPolicy("dataset",
dataset_id=dataset_dataset.dataset_id,
policy_data=owner.policy_data)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
owner, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
Bindings: []organizations.GetIAMPolicyBinding{
{
Role: "roles/bigquery.dataOwner",
Members: []string{
"user:jane@example.com",
},
},
},
}, nil)
if err != nil {
return err
}
datasetDataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamPolicy(ctx, "dataset", &bigquery.DatasetIamPolicyArgs{
DatasetId: datasetDataset.DatasetId,
PolicyData: pulumi.String(owner.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 owner = Gcp.Organizations.GetIAMPolicy.Invoke(new()
{
Bindings = new[]
{
new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
{
Role = "roles/bigquery.dataOwner",
Members = new[]
{
"user:jane@example.com",
},
},
},
});
var datasetDataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var dataset = new Gcp.BigQuery.DatasetIamPolicy("dataset", new()
{
DatasetId = datasetDataset.DatasetId,
PolicyData = owner.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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamPolicy;
import com.pulumi.gcp.bigquery.DatasetIamPolicyArgs;
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 owner = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
.bindings(GetIAMPolicyBindingArgs.builder()
.role("roles/bigquery.dataOwner")
.members("user:jane@example.com")
.build())
.build());
var datasetDataset = new Dataset("datasetDataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var dataset = new DatasetIamPolicy("dataset", DatasetIamPolicyArgs.builder()
.datasetId(datasetDataset.datasetId())
.policyData(owner.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
.build());
}
}
resources:
dataset:
type: gcp:bigquery:DatasetIamPolicy
properties:
datasetId: ${datasetDataset.datasetId}
policyData: ${owner.policyData}
datasetDataset:
type: gcp:bigquery:Dataset
name: dataset
properties:
datasetId: example_dataset
variables:
owner:
fn::invoke:
Function: gcp:organizations:getIAMPolicy
Arguments:
bindings:
- role: roles/bigquery.dataOwner
members:
- user:jane@example.com
gcp.bigquery.DatasetIamBinding
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const reader = new gcp.bigquery.DatasetIamBinding("reader", {
datasetId: dataset.datasetId,
role: "roles/bigquery.dataViewer",
members: ["user:jane@example.com"],
});
import pulumi
import pulumi_gcp as gcp
dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
reader = gcp.bigquery.DatasetIamBinding("reader",
dataset_id=dataset.dataset_id,
role="roles/bigquery.dataViewer",
members=["user:jane@example.com"])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamBinding(ctx, "reader", &bigquery.DatasetIamBindingArgs{
DatasetId: dataset.DatasetId,
Role: pulumi.String("roles/bigquery.dataViewer"),
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 dataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var reader = new Gcp.BigQuery.DatasetIamBinding("reader", new()
{
DatasetId = dataset.DatasetId,
Role = "roles/bigquery.dataViewer",
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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamBinding;
import com.pulumi.gcp.bigquery.DatasetIamBindingArgs;
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 dataset = new Dataset("dataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var reader = new DatasetIamBinding("reader", DatasetIamBindingArgs.builder()
.datasetId(dataset.datasetId())
.role("roles/bigquery.dataViewer")
.members("user:jane@example.com")
.build());
}
}
resources:
reader:
type: gcp:bigquery:DatasetIamBinding
properties:
datasetId: ${dataset.datasetId}
role: roles/bigquery.dataViewer
members:
- user:jane@example.com
dataset:
type: gcp:bigquery:Dataset
properties:
datasetId: example_dataset
gcp.bigquery.DatasetIamMember
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
const editor = new gcp.bigquery.DatasetIamMember("editor", {
datasetId: dataset.datasetId,
role: "roles/bigquery.dataEditor",
member: "user:jane@example.com",
});
import pulumi
import pulumi_gcp as gcp
dataset = gcp.bigquery.Dataset("dataset", dataset_id="example_dataset")
editor = gcp.bigquery.DatasetIamMember("editor",
dataset_id=dataset.dataset_id,
role="roles/bigquery.dataEditor",
member="user:jane@example.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataset, err := bigquery.NewDataset(ctx, "dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("example_dataset"),
})
if err != nil {
return err
}
_, err = bigquery.NewDatasetIamMember(ctx, "editor", &bigquery.DatasetIamMemberArgs{
DatasetId: dataset.DatasetId,
Role: pulumi.String("roles/bigquery.dataEditor"),
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 dataset = new Gcp.BigQuery.Dataset("dataset", new()
{
DatasetId = "example_dataset",
});
var editor = new Gcp.BigQuery.DatasetIamMember("editor", new()
{
DatasetId = dataset.DatasetId,
Role = "roles/bigquery.dataEditor",
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.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.DatasetIamMember;
import com.pulumi.gcp.bigquery.DatasetIamMemberArgs;
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 dataset = new Dataset("dataset", DatasetArgs.builder()
.datasetId("example_dataset")
.build());
var editor = new DatasetIamMember("editor", DatasetIamMemberArgs.builder()
.datasetId(dataset.datasetId())
.role("roles/bigquery.dataEditor")
.member("user:jane@example.com")
.build());
}
}
resources:
editor:
type: gcp:bigquery:DatasetIamMember
properties:
datasetId: ${dataset.datasetId}
role: roles/bigquery.dataEditor
member: user:jane@example.com
dataset:
type: gcp:bigquery:Dataset
properties:
datasetId: example_dataset
Create DatasetIamBinding Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatasetIamBinding(name: string, args: DatasetIamBindingArgs, opts?: CustomResourceOptions);
@overload
def DatasetIamBinding(resource_name: str,
args: DatasetIamBindingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DatasetIamBinding(resource_name: str,
opts: Optional[ResourceOptions] = None,
dataset_id: Optional[str] = None,
members: Optional[Sequence[str]] = None,
role: Optional[str] = None,
condition: Optional[DatasetIamBindingConditionArgs] = None,
project: Optional[str] = None)
func NewDatasetIamBinding(ctx *Context, name string, args DatasetIamBindingArgs, opts ...ResourceOption) (*DatasetIamBinding, error)
public DatasetIamBinding(string name, DatasetIamBindingArgs args, CustomResourceOptions? opts = null)
public DatasetIamBinding(String name, DatasetIamBindingArgs args)
public DatasetIamBinding(String name, DatasetIamBindingArgs args, CustomResourceOptions options)
type: gcp:bigquery:DatasetIamBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DatasetIamBindingArgs
- 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 DatasetIamBindingArgs
- 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 DatasetIamBindingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatasetIamBindingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatasetIamBindingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var datasetIamBindingResource = new Gcp.BigQuery.DatasetIamBinding("datasetIamBindingResource", new()
{
DatasetId = "string",
Members = new[]
{
"string",
},
Role = "string",
Condition = new Gcp.BigQuery.Inputs.DatasetIamBindingConditionArgs
{
Expression = "string",
Title = "string",
Description = "string",
},
Project = "string",
});
example, err := bigquery.NewDatasetIamBinding(ctx, "datasetIamBindingResource", &bigquery.DatasetIamBindingArgs{
DatasetId: pulumi.String("string"),
Members: pulumi.StringArray{
pulumi.String("string"),
},
Role: pulumi.String("string"),
Condition: &bigquery.DatasetIamBindingConditionArgs{
Expression: pulumi.String("string"),
Title: pulumi.String("string"),
Description: pulumi.String("string"),
},
Project: pulumi.String("string"),
})
var datasetIamBindingResource = new DatasetIamBinding("datasetIamBindingResource", DatasetIamBindingArgs.builder()
.datasetId("string")
.members("string")
.role("string")
.condition(DatasetIamBindingConditionArgs.builder()
.expression("string")
.title("string")
.description("string")
.build())
.project("string")
.build());
dataset_iam_binding_resource = gcp.bigquery.DatasetIamBinding("datasetIamBindingResource",
dataset_id="string",
members=["string"],
role="string",
condition=gcp.bigquery.DatasetIamBindingConditionArgs(
expression="string",
title="string",
description="string",
),
project="string")
const datasetIamBindingResource = new gcp.bigquery.DatasetIamBinding("datasetIamBindingResource", {
datasetId: "string",
members: ["string"],
role: "string",
condition: {
expression: "string",
title: "string",
description: "string",
},
project: "string",
});
type: gcp:bigquery:DatasetIamBinding
properties:
condition:
description: string
expression: string
title: string
datasetId: string
members:
- string
project: string
role: string
DatasetIamBinding 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 DatasetIamBinding resource accepts the following input properties:
- Dataset
Id string - The dataset ID.
- Members List<string>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- Role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - Condition
Dataset
Iam Binding Condition - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Dataset
Id string - The dataset ID.
- Members []string
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- Role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - Condition
Dataset
Iam Binding Condition Args - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- dataset
Id String - The dataset ID.
- members List<String>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- role String
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Dataset
Iam Binding Condition - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- dataset
Id string - The dataset ID.
- members string[]
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Dataset
Iam Binding Condition - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- dataset_
id str - The dataset ID.
- members Sequence[str]
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- role str
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
. - condition
Dataset
Iam Binding Condition Args - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- dataset
Id String - The dataset ID.
- members List<String>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- role String
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
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 ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the DatasetIamBinding resource produces the following output properties:
Look up Existing DatasetIamBinding Resource
Get an existing DatasetIamBinding 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?: DatasetIamBindingState, opts?: CustomResourceOptions): DatasetIamBinding
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
condition: Optional[DatasetIamBindingConditionArgs] = None,
dataset_id: Optional[str] = None,
etag: Optional[str] = None,
members: Optional[Sequence[str]] = None,
project: Optional[str] = None,
role: Optional[str] = None) -> DatasetIamBinding
func GetDatasetIamBinding(ctx *Context, name string, id IDInput, state *DatasetIamBindingState, opts ...ResourceOption) (*DatasetIamBinding, error)
public static DatasetIamBinding Get(string name, Input<string> id, DatasetIamBindingState? state, CustomResourceOptions? opts = null)
public static DatasetIamBinding get(String name, Output<String> id, DatasetIamBindingState 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.
- Condition
Dataset
Iam Binding Condition - Dataset
Id string - The dataset ID.
- Etag string
- (Computed) The etag of the dataset's IAM policy.
- Members List<string>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- Condition
Dataset
Iam Binding Condition Args - Dataset
Id string - The dataset ID.
- Etag string
- (Computed) The etag of the dataset's IAM policy.
- Members []string
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- condition
Dataset
Iam Binding Condition - dataset
Id String - The dataset ID.
- etag String
- (Computed) The etag of the dataset's IAM policy.
- members List<String>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role String
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- condition
Dataset
Iam Binding Condition - dataset
Id string - The dataset ID.
- etag string
- (Computed) The etag of the dataset's IAM policy.
- members string[]
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role string
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- condition
Dataset
Iam Binding Condition Args - dataset_
id str - The dataset ID.
- etag str
- (Computed) The etag of the dataset's IAM policy.
- members Sequence[str]
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role str
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
- condition Property Map
- dataset
Id String - The dataset ID.
- etag String
- (Computed) The etag of the dataset's IAM policy.
- members List<String>
- Identities that will be granted the privilege in
role
. Each entry can have one of the following values:- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- 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.
- group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
- iamMember:{principal}: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
- serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- role String
- The role that should be applied. Only one
gcp.bigquery.DatasetIamBinding
can be used per role. Note that custom roles must be of the format[projects|organizations]/{parent-name}/roles/{role-name}
.
Supporting Types
DatasetIamBindingCondition, DatasetIamBindingConditionArgs
- 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 str
- title str
- description str
- expression String
- title String
- description String
Import
Importing IAM policies
IAM policy imports use the identifier of the BigQuery Dataset resource. For example:
projects/{{project_id}}/datasets/{{dataset_id}}
An import
block (Terraform v1.5.0 and later) can be used to import IAM policies:
tf
import {
id = projects/{{project_id}}/datasets/{{dataset_id}}
to = google_bigquery_dataset_iam_policy.default
}
The pulumi import
command can also be used:
$ pulumi import gcp:bigquery/datasetIamBinding:DatasetIamBinding default projects/{{project_id}}/datasets/{{dataset_id}}
To learn more about importing existing cloud resources, see Importing resources.
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.