Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigquery
  5. IamBinding
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.bigquery.IamBinding

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

    • gcp.bigquery.IamPolicy: Authoritative. Sets the IAM policy for the table and replaces any existing policy already attached.
    • gcp.bigquery.IamBinding: 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 table are preserved.
    • gcp.bigquery.IamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the table are preserved.

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.bigquery.IamPolicy: Retrieves the IAM policy for the table

    Note: gcp.bigquery.IamPolicy cannot be used in conjunction with gcp.bigquery.IamBinding and gcp.bigquery.IamMember or they will fight over what your policy should be.

    Note: gcp.bigquery.IamBinding resources can be used in conjunction with gcp.bigquery.IamMember resources only if they do not grant privilege to the same role.

    gcp.bigquery.IamPolicy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/bigquery.dataOwner",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.bigquery.IamPolicy("policy", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    policyData: admin.then(admin => admin.policyData),
});

    import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/bigquery.dataOwner",
    "members": ["user:jane@example.com"],
}])
policy = gcp.bigquery.IamPolicy("policy",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    policy_data=admin.policy_data)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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/bigquery.dataOwner",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = bigquery.NewIamPolicy(ctx, "policy", &bigquery.IamPolicyArgs{
			Project:    pulumi.Any(test.Project),
			DatasetId:  pulumi.Any(test.DatasetId),
			TableId:    pulumi.Any(test.TableId),
			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/bigquery.dataOwner",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.BigQuery.IamPolicy("policy", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        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.IamPolicy;
import com.pulumi.gcp.bigquery.IamPolicyArgs;
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/bigquery.dataOwner")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new IamPolicy("policy", IamPolicyArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

    resources:
  policy:
    type: gcp:bigquery:IamPolicy
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/bigquery.dataOwner
            members:
              - user:jane@example.com

    gcp.bigquery.IamBinding

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

const binding = new gcp.bigquery.IamBinding("binding", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    role: "roles/bigquery.dataOwner",
    members: ["user:jane@example.com"],
});

    import pulumi
import pulumi_gcp as gcp

binding = gcp.bigquery.IamBinding("binding",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    role="roles/bigquery.dataOwner",
    members=["user:jane@example.com"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewIamBinding(ctx, "binding", &bigquery.IamBindingArgs{
			Project:   pulumi.Any(test.Project),
			DatasetId: pulumi.Any(test.DatasetId),
			TableId:   pulumi.Any(test.TableId),
			Role:      pulumi.String("roles/bigquery.dataOwner"),
			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.IamBinding("binding", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        Role = "roles/bigquery.dataOwner",
        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.IamBinding;
import com.pulumi.gcp.bigquery.IamBindingArgs;
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 IamBinding("binding", IamBindingArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .role("roles/bigquery.dataOwner")
            .members("user:jane@example.com")
            .build());

    }
}

    resources:
  binding:
    type: gcp:bigquery:IamBinding
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      role: roles/bigquery.dataOwner
      members:
        - user:jane@example.com

    gcp.bigquery.IamMember

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

const member = new gcp.bigquery.IamMember("member", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    role: "roles/bigquery.dataOwner",
    member: "user:jane@example.com",
});

    import pulumi
import pulumi_gcp as gcp

member = gcp.bigquery.IamMember("member",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    role="roles/bigquery.dataOwner",
    member="user:jane@example.com")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewIamMember(ctx, "member", &bigquery.IamMemberArgs{
			Project:   pulumi.Any(test.Project),
			DatasetId: pulumi.Any(test.DatasetId),
			TableId:   pulumi.Any(test.TableId),
			Role:      pulumi.String("roles/bigquery.dataOwner"),
			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.IamMember("member", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        Role = "roles/bigquery.dataOwner",
        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.IamMember;
import com.pulumi.gcp.bigquery.IamMemberArgs;
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 IamMember("member", IamMemberArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .role("roles/bigquery.dataOwner")
            .member("user:jane@example.com")
            .build());

    }
}

    resources:
  member:
    type: gcp:bigquery:IamMember
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      role: roles/bigquery.dataOwner
      member: user:jane@example.com

    This resource supports User Project Overrides.

    IAM policy for BigQuery Table

    Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:

    • gcp.bigquery.IamPolicy: Authoritative. Sets the IAM policy for the table and replaces any existing policy already attached.
    • gcp.bigquery.IamBinding: 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 table are preserved.
    • gcp.bigquery.IamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the table are preserved.

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.bigquery.IamPolicy: Retrieves the IAM policy for the table

    Note: gcp.bigquery.IamPolicy cannot be used in conjunction with gcp.bigquery.IamBinding and gcp.bigquery.IamMember or they will fight over what your policy should be.

    Note: gcp.bigquery.IamBinding resources can be used in conjunction with gcp.bigquery.IamMember resources only if they do not grant privilege to the same role.

    gcp.bigquery.IamPolicy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/bigquery.dataOwner",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.bigquery.IamPolicy("policy", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    policyData: admin.then(admin => admin.policyData),
});

    import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/bigquery.dataOwner",
    "members": ["user:jane@example.com"],
}])
policy = gcp.bigquery.IamPolicy("policy",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    policy_data=admin.policy_data)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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/bigquery.dataOwner",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = bigquery.NewIamPolicy(ctx, "policy", &bigquery.IamPolicyArgs{
			Project:    pulumi.Any(test.Project),
			DatasetId:  pulumi.Any(test.DatasetId),
			TableId:    pulumi.Any(test.TableId),
			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/bigquery.dataOwner",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.BigQuery.IamPolicy("policy", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        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.IamPolicy;
import com.pulumi.gcp.bigquery.IamPolicyArgs;
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/bigquery.dataOwner")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new IamPolicy("policy", IamPolicyArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

    resources:
  policy:
    type: gcp:bigquery:IamPolicy
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/bigquery.dataOwner
            members:
              - user:jane@example.com

    gcp.bigquery.IamBinding

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

const binding = new gcp.bigquery.IamBinding("binding", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    role: "roles/bigquery.dataOwner",
    members: ["user:jane@example.com"],
});

    import pulumi
import pulumi_gcp as gcp

binding = gcp.bigquery.IamBinding("binding",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    role="roles/bigquery.dataOwner",
    members=["user:jane@example.com"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewIamBinding(ctx, "binding", &bigquery.IamBindingArgs{
			Project:   pulumi.Any(test.Project),
			DatasetId: pulumi.Any(test.DatasetId),
			TableId:   pulumi.Any(test.TableId),
			Role:      pulumi.String("roles/bigquery.dataOwner"),
			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.IamBinding("binding", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        Role = "roles/bigquery.dataOwner",
        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.IamBinding;
import com.pulumi.gcp.bigquery.IamBindingArgs;
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 IamBinding("binding", IamBindingArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .role("roles/bigquery.dataOwner")
            .members("user:jane@example.com")
            .build());

    }
}

    resources:
  binding:
    type: gcp:bigquery:IamBinding
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      role: roles/bigquery.dataOwner
      members:
        - user:jane@example.com

    gcp.bigquery.IamMember

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

const member = new gcp.bigquery.IamMember("member", {
    project: test.project,
    datasetId: test.datasetId,
    tableId: test.tableId,
    role: "roles/bigquery.dataOwner",
    member: "user:jane@example.com",
});

    import pulumi
import pulumi_gcp as gcp

member = gcp.bigquery.IamMember("member",
    project=test["project"],
    dataset_id=test["datasetId"],
    table_id=test["tableId"],
    role="roles/bigquery.dataOwner",
    member="user:jane@example.com")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewIamMember(ctx, "member", &bigquery.IamMemberArgs{
			Project:   pulumi.Any(test.Project),
			DatasetId: pulumi.Any(test.DatasetId),
			TableId:   pulumi.Any(test.TableId),
			Role:      pulumi.String("roles/bigquery.dataOwner"),
			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.IamMember("member", new()
    {
        Project = test.Project,
        DatasetId = test.DatasetId,
        TableId = test.TableId,
        Role = "roles/bigquery.dataOwner",
        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.IamMember;
import com.pulumi.gcp.bigquery.IamMemberArgs;
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 IamMember("member", IamMemberArgs.builder()
            .project(test.project())
            .datasetId(test.datasetId())
            .tableId(test.tableId())
            .role("roles/bigquery.dataOwner")
            .member("user:jane@example.com")
            .build());

    }
}

    resources:
  member:
    type: gcp:bigquery:IamMember
    properties:
      project: ${test.project}
      datasetId: ${test.datasetId}
      tableId: ${test.tableId}
      role: roles/bigquery.dataOwner
      member: user:jane@example.com

    Create IamBinding Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IamBinding(name: string, args: IamBindingArgs, opts?: CustomResourceOptions);
    @overload
def IamBinding(resource_name: str,
               args: IamBindingArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def IamBinding(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               dataset_id: Optional[str] = None,
               members: Optional[Sequence[str]] = None,
               role: Optional[str] = None,
               table_id: Optional[str] = None,
               condition: Optional[IamBindingConditionArgs] = None,
               project: Optional[str] = None)
    func NewIamBinding(ctx *Context, name string, args IamBindingArgs, opts ...ResourceOption) (*IamBinding, error)
    public IamBinding(string name, IamBindingArgs args, CustomResourceOptions? opts = null)
    public IamBinding(String name, IamBindingArgs args)
public IamBinding(String name, IamBindingArgs args, CustomResourceOptions options)

    type: gcp:bigquery:IamBinding
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 IamBindingArgs
    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 IamBindingArgs
    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 IamBindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamBindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamBindingArgs
    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 iamBindingResource = new Gcp.BigQuery.IamBinding("iamBindingResource", new()
{
    DatasetId = "string",
    Members = new[]
    {
        "string",
    },
    Role = "string",
    TableId = "string",
    Condition = new Gcp.BigQuery.Inputs.IamBindingConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
    Project = "string",
});

    example, err := bigquery.NewIamBinding(ctx, "iamBindingResource", &bigquery.IamBindingArgs{
	DatasetId: pulumi.String("string"),
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Role:    pulumi.String("string"),
	TableId: pulumi.String("string"),
	Condition: &bigquery.IamBindingConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var iamBindingResource = new IamBinding("iamBindingResource", IamBindingArgs.builder()
    .datasetId("string")
    .members("string")
    .role("string")
    .tableId("string")
    .condition(IamBindingConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .project("string")
    .build());

    iam_binding_resource = gcp.bigquery.IamBinding("iamBindingResource",
    dataset_id="string",
    members=["string"],
    role="string",
    table_id="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    },
    project="string")

    const iamBindingResource = new gcp.bigquery.IamBinding("iamBindingResource", {
    datasetId: "string",
    members: ["string"],
    role: "string",
    tableId: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
    project: "string",
});

    type: gcp:bigquery:IamBinding
properties:
    condition:
        description: string
        expression: string
        title: string
    datasetId: string
    members:
        - string
    project: string
    role: string
    tableId: string

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

    DatasetId string
    Members List<string>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    TableId string
    Condition IamBindingCondition
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    DatasetId string
    Members []string
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    TableId string
    Condition IamBindingConditionArgs
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    datasetId String
    members List<String>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role String
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId String
    condition IamBindingCondition
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    datasetId string
    members string[]
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId string
    condition IamBindingCondition
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    dataset_id str
    members Sequence[str]
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role str
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    table_id str
    condition IamBindingConditionArgs
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    datasetId String
    members List<String>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    role String
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId String
    condition Property Map
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Outputs

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

    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    (Computed) The etag of the IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    (Computed) The etag of the IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IamBinding Resource

    Get an existing IamBinding 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?: IamBindingState, opts?: CustomResourceOptions): IamBinding
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[IamBindingConditionArgs] = None,
        dataset_id: Optional[str] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        role: Optional[str] = None,
        table_id: Optional[str] = None) -> IamBinding
    func GetIamBinding(ctx *Context, name string, id IDInput, state *IamBindingState, opts ...ResourceOption) (*IamBinding, error)
    public static IamBinding Get(string name, Input<string> id, IamBindingState? state, CustomResourceOptions? opts = null)
    public static IamBinding get(String name, Output<String> id, IamBindingState 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:
    Condition IamBindingCondition
    DatasetId string
    Etag string
    (Computed) The etag of the IAM policy.
    Members List<string>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    Role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    TableId string
    Condition IamBindingConditionArgs
    DatasetId string
    Etag string
    (Computed) The etag of the IAM policy.
    Members []string
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    Role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    TableId string
    condition IamBindingCondition
    datasetId String
    etag String
    (Computed) The etag of the IAM policy.
    members List<String>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    role String
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId String
    condition IamBindingCondition
    datasetId string
    etag string
    (Computed) The etag of the IAM policy.
    members string[]
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    role string
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId string
    condition IamBindingConditionArgs
    dataset_id str
    etag str
    (Computed) The etag of the IAM policy.
    members Sequence[str]
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    project str
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    role str
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    table_id str
    condition Property Map
    datasetId String
    etag String
    (Computed) The etag of the IAM policy.
    members List<String>
    Identities that will be granted the privilege in role. Each entry can have one of the following values:

    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    role String
    The role that should be applied. Only one gcp.bigquery.IamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
    tableId String

    Supporting Types

    IamBindingCondition, IamBindingConditionArgs

    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

    For all import syntaxes, the “resource in question” can take any of the following forms:

    • projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}

    • {{project}}/{{dataset_id}}/{{table_id}}

    • {{dataset_id}}/{{table_id}}

    • {{table_id}}

    Any variables not passed in the import command will be taken from the provider configuration.

    BigQuery table IAM resources can be imported using the resource identifiers, role, and member.

    IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.

    $ pulumi import gcp:bigquery/iamBinding:IamBinding editor "projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} roles/bigquery.dataOwner user:jane@example.com"

    IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

    $ pulumi import gcp:bigquery/iamBinding:IamBinding editor "projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} roles/bigquery.dataOwner"

    IAM policy imports use the identifier of the resource in question, e.g.

    $ pulumi import gcp:bigquery/iamBinding:IamBinding editor projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}

    -> Custom Roles: If 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.

    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.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp