InstanceIamMember

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

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

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

Note: gcp.bigtable.InstanceIamBinding resources can be used in conjunction with gcp.bigtable.InstanceIamMember 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.InstanceIamPolicy("editor", {
    project: "your-project",
    instance: "your-bigtable-instance",
    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.InstanceIamPolicy("editor",
    project="your-project",
    instance="your-bigtable-instance",
    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.InstanceIamPolicy("editor", new Gcp.BigTable.InstanceIamPolicyArgs
        {
            Project = "your-project",
            Instance = "your-bigtable-instance",
            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.NewInstanceIamPolicy(ctx, "editor", &bigtable.InstanceIamPolicyArgs{
			Project:    pulumi.String("your-project"),
			Instance:   pulumi.String("your-bigtable-instance"),
			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.InstanceIamBinding("editor", {
    instance: "your-bigtable-instance",
    members: ["user:jane@example.com"],
    role: "roles/bigtable.user",
});
import pulumi
import pulumi_gcp as gcp

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

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

}
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.NewInstanceIamBinding(ctx, "editor", &bigtable.InstanceIamBindingArgs{
			Instance: pulumi.String("your-bigtable-instance"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
			Role: pulumi.String("roles/bigtable.user"),
		})
		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.InstanceIamMember("editor", {
    instance: "your-bigtable-instance",
    member: "user:jane@example.com",
    role: "roles/bigtable.user",
});
import pulumi
import pulumi_gcp as gcp

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

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

}
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.NewInstanceIamMember(ctx, "editor", &bigtable.InstanceIamMemberArgs{
			Instance: pulumi.String("your-bigtable-instance"),
			Member:   pulumi.String("user:jane@example.com"),
			Role:     pulumi.String("roles/bigtable.user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Create a InstanceIamMember Resource

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

InstanceIamMember Resource Properties

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

Inputs

The InstanceIamMember resource accepts the following input properties:

Instance string
The name or relative resource id of the instance to manage IAM policies for.
Member string
Role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
Condition InstanceIamMemberConditionArgs
Project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
Instance string
The name or relative resource id of the instance to manage IAM policies for.
Member string
Role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
Condition InstanceIamMemberCondition
Project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
instance string
The name or relative resource id of the instance to manage IAM policies for.
member string
role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
condition InstanceIamMemberConditionArgs
project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
instance str
The name or relative resource id of the instance to manage IAM policies for.
member str
role str
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
condition InstanceIamMemberConditionArgs
project str
The project in which the instance belongs. If it is not provided, a default will be supplied.

Outputs

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

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

Look up an Existing InstanceIamMember Resource

Get an existing InstanceIamMember 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?: InstanceIamMemberState, opts?: CustomResourceOptions): InstanceIamMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[InstanceIamMemberConditionArgs] = None,
        etag: Optional[str] = None,
        instance: Optional[str] = None,
        member: Optional[str] = None,
        project: Optional[str] = None,
        role: Optional[str] = None) -> InstanceIamMember
func GetInstanceIamMember(ctx *Context, name string, id IDInput, state *InstanceIamMemberState, opts ...ResourceOption) (*InstanceIamMember, error)
public static InstanceIamMember Get(string name, Input<string> id, InstanceIamMemberState? 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 InstanceIamMemberConditionArgs
Etag string
(Computed) The etag of the instances’s IAM policy.
Instance string
The name or relative resource id of the instance to manage IAM policies for.
Member string
Project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
Role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
Condition InstanceIamMemberCondition
Etag string
(Computed) The etag of the instances’s IAM policy.
Instance string
The name or relative resource id of the instance to manage IAM policies for.
Member string
Project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
Role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
condition InstanceIamMemberConditionArgs
etag string
(Computed) The etag of the instances’s IAM policy.
instance string
The name or relative resource id of the instance to manage IAM policies for.
member string
project string
The project in which the instance belongs. If it is not provided, a default will be supplied.
role string
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.
condition InstanceIamMemberConditionArgs
etag str
(Computed) The etag of the instances’s IAM policy.
instance str
The name or relative resource id of the instance to manage IAM policies for.
member str
project str
The project in which the instance belongs. If it is not provided, a default will be supplied.
role str
The role that should be applied. Only one gcp.bigtable.InstanceIamBinding 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.

Supporting Types

InstanceIamMemberCondition

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, instance name, role and/or member.

 $ pulumi import gcp:bigtable/instanceIamMember:InstanceIamMember editor "projects/{project}/instances/{instance}"
 $ pulumi import gcp:bigtable/instanceIamMember:InstanceIamMember editor "projects/{project}/instances/{instance} roles/editor"
 $ pulumi import gcp:bigtable/instanceIamMember:InstanceIamMember editor "projects/{project}/instances/{instance} 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.