TableIamBinding

Three different resources help you manage IAM policies on bigtable tables. Each of these resources serves a different use case:

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

Note: gcp.bigtable.TableIamPolicy cannot be used in conjunction with gcp.bigtable.TableIamBinding and gcp.bigtable.TableIamMember or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the table as gcp.bigtable.TableIamPolicy replaces the entire policy.

Note: gcp.bigtable.TableIamBinding resources can be used in conjunction with gcp.bigtable.TableIamMember resources only if they do not grant privilege to the same role.

google_bigtable_instance_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/bigtable.user",
        members: ["user:jane@example.com"],
    }],
});
const editor = new gcp.bigtable.TableIamPolicy("editor", {
    project: "your-project",
    instance: "your-bigtable-instance",
    table: "your-bigtable-table",
    policyData: admin.then(admin => admin.policyData),
});
import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[gcp.organizations.GetIAMPolicyBindingArgs(
    role="roles/bigtable.user",
    members=["user:jane@example.com"],
)])
editor = gcp.bigtable.TableIamPolicy("editor",
    project="your-project",
    instance="your-bigtable-instance",
    table="your-bigtable-table",
    policy_data=admin.policy_data)
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var admin = Output.Create(Gcp.Organizations.GetIAMPolicy.InvokeAsync(new Gcp.Organizations.GetIAMPolicyArgs
        {
            Bindings = 
            {
                new Gcp.Organizations.Inputs.GetIAMPolicyBindingArgs
                {
                    Role = "roles/bigtable.user",
                    Members = 
                    {
                        "user:jane@example.com",
                    },
                },
            },
        }));
        var editor = new Gcp.BigTable.TableIamPolicy("editor", new Gcp.BigTable.TableIamPolicyArgs
        {
            Project = "your-project",
            Instance = "your-bigtable-instance",
            Table = "your-bigtable-table",
            PolicyData = admin.Apply(admin => admin.PolicyData),
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/bigtable"
	"github.com/pulumi/pulumi-gcp/sdk/v5/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{
				organizations.GetIAMPolicyBinding{
					Role: "roles/bigtable.user",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = bigtable.NewTableIamPolicy(ctx, "editor", &bigtable.TableIamPolicyArgs{
			Project:    pulumi.String("your-project"),
			Instance:   pulumi.String("your-bigtable-instance"),
			Table:      pulumi.String("your-bigtable-table"),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

google_bigtable_instance_iam_binding

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

const editor = new gcp.bigtable.TableIamBinding("editor", {
    instance: "your-bigtable-instance",
    members: ["user:jane@example.com"],
    role: "roles/bigtable.user",
    table: "your-bigtable-table",
});
import pulumi
import pulumi_gcp as gcp

editor = gcp.bigtable.TableIamBinding("editor",
    instance="your-bigtable-instance",
    members=["user:jane@example.com"],
    role="roles/bigtable.user",
    table="your-bigtable-table")
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var editor = new Gcp.BigTable.TableIamBinding("editor", new Gcp.BigTable.TableIamBindingArgs
        {
            Instance = "your-bigtable-instance",
            Members = 
            {
                "user:jane@example.com",
            },
            Role = "roles/bigtable.user",
            Table = "your-bigtable-table",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/bigtable"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigtable.NewTableIamBinding(ctx, "editor", &bigtable.TableIamBindingArgs{
			Instance: pulumi.String("your-bigtable-instance"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
			Role:  pulumi.String("roles/bigtable.user"),
			Table: pulumi.String("your-bigtable-table"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

google_bigtable_instance_iam_member

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

const editor = new gcp.bigtable.TableIamMember("editor", {
    instance: "your-bigtable-instance",
    member: "user:jane@example.com",
    role: "roles/bigtable.user",
    table: "your-bigtable-table",
});
import pulumi
import pulumi_gcp as gcp

editor = gcp.bigtable.TableIamMember("editor",
    instance="your-bigtable-instance",
    member="user:jane@example.com",
    role="roles/bigtable.user",
    table="your-bigtable-table")
using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var editor = new Gcp.BigTable.TableIamMember("editor", new Gcp.BigTable.TableIamMemberArgs
        {
            Instance = "your-bigtable-instance",
            Member = "user:jane@example.com",
            Role = "roles/bigtable.user",
            Table = "your-bigtable-table",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/bigtable"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigtable.NewTableIamMember(ctx, "editor", &bigtable.TableIamMemberArgs{
			Instance: pulumi.String("your-bigtable-instance"),
			Member:   pulumi.String("user:jane@example.com"),
			Role:     pulumi.String("roles/bigtable.user"),
			Table:    pulumi.String("your-bigtable-table"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Create a TableIamBinding Resource

new TableIamBinding(name: string, args: TableIamBindingArgs, opts?: CustomResourceOptions);
@overload
def TableIamBinding(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    condition: Optional[TableIamBindingConditionArgs] = None,
                    instance: Optional[str] = None,
                    members: Optional[Sequence[str]] = None,
                    project: Optional[str] = None,
                    role: Optional[str] = None,
                    table: Optional[str] = None)
@overload
def TableIamBinding(resource_name: str,
                    args: TableIamBindingArgs,
                    opts: Optional[ResourceOptions] = None)
func NewTableIamBinding(ctx *Context, name string, args TableIamBindingArgs, opts ...ResourceOption) (*TableIamBinding, error)
public TableIamBinding(string name, TableIamBindingArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args TableIamBindingArgs
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 TableIamBindingArgs
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 TableIamBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TableIamBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

TableIamBinding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TableIamBinding resource accepts the following input properties:

Instance string
The name or relative resource id of the instance that owns the table.
Members List<string>
Role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
Table string
The name or relative resource id of the table to manage IAM policies for.
Condition TableIamBindingConditionArgs
Project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
Instance string
The name or relative resource id of the instance that owns the table.
Members []string
Role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
Table string
The name or relative resource id of the table to manage IAM policies for.
Condition TableIamBindingCondition
Project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
instance string
The name or relative resource id of the instance that owns the table.
members string[]
role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
table string
The name or relative resource id of the table to manage IAM policies for.
condition TableIamBindingConditionArgs
project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
instance str
The name or relative resource id of the instance that owns the table.
members Sequence[str]
role str
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
table str
The name or relative resource id of the table to manage IAM policies for.
condition TableIamBindingConditionArgs
project str
The project in which the table belongs. If it is not provided, this provider will use the provider default.

Outputs

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

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

Look up an Existing TableIamBinding Resource

Get an existing TableIamBinding 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?: TableIamBindingState, opts?: CustomResourceOptions): TableIamBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[TableIamBindingConditionArgs] = None,
        etag: Optional[str] = None,
        instance: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        project: Optional[str] = None,
        role: Optional[str] = None,
        table: Optional[str] = None) -> TableIamBinding
func GetTableIamBinding(ctx *Context, name string, id IDInput, state *TableIamBindingState, opts ...ResourceOption) (*TableIamBinding, error)
public static TableIamBinding Get(string name, Input<string> id, TableIamBindingState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Condition TableIamBindingConditionArgs
Etag string
(Computed) The etag of the tables’s IAM policy.
Instance string
The name or relative resource id of the instance that owns the table.
Members List<string>
Project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
Role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
Table string
The name or relative resource id of the table to manage IAM policies for.
Condition TableIamBindingCondition
Etag string
(Computed) The etag of the tables’s IAM policy.
Instance string
The name or relative resource id of the instance that owns the table.
Members []string
Project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
Role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
Table string
The name or relative resource id of the table to manage IAM policies for.
condition TableIamBindingConditionArgs
etag string
(Computed) The etag of the tables’s IAM policy.
instance string
The name or relative resource id of the instance that owns the table.
members string[]
project string
The project in which the table belongs. If it is not provided, this provider will use the provider default.
role string
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
table string
The name or relative resource id of the table to manage IAM policies for.
condition TableIamBindingConditionArgs
etag str
(Computed) The etag of the tables’s IAM policy.
instance str
The name or relative resource id of the instance that owns the table.
members Sequence[str]
project str
The project in which the table belongs. If it is not provided, this provider will use the provider default.
role str
The role that should be applied. Only one gcp.bigtable.TableIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}. Read more about roles here.
table str
The name or relative resource id of the table to manage IAM policies for.

Supporting Types

TableIamBindingCondition

Expression string
Title string
Description string
Expression string
Title string
Description string
expression string
title string
description string

Import

Instance IAM resources can be imported using the project, table name, role and/or member.

 $ pulumi import gcp:bigtable/tableIamBinding:TableIamBinding editor "projects/{project}/tables/{table}"
 $ pulumi import gcp:bigtable/tableIamBinding:TableIamBinding editor "projects/{project}/tables/{table} roles/editor"
 $ pulumi import gcp:bigtable/tableIamBinding:TableIamBinding editor "projects/{project}/tables/{table} roles/editor user:jane@example.com"

-> Custom RolesIf 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.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.