1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. spanner
  5. DatabaseIAMBinding
gcp logo
Google Cloud Classic v6.51.0, Mar 7 23

gcp.spanner.DatabaseIAMBinding

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

  • gcp.spanner.DatabaseIAMPolicy: Authoritative. Sets the IAM policy for the database and replaces any existing policy already attached.

Warning: It’s entirely possibly to lock yourself out of your database using gcp.spanner.DatabaseIAMPolicy. Any permissions granted by default will be removed unless you include them in your config.

  • gcp.spanner.DatabaseIAMBinding: 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 database are preserved.
  • gcp.spanner.DatabaseIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the database are preserved.

Note: gcp.spanner.DatabaseIAMPolicy cannot be used in conjunction with gcp.spanner.DatabaseIAMBinding and gcp.spanner.DatabaseIAMMember or they will fight over what your policy should be.

Note: gcp.spanner.DatabaseIAMBinding resources can be used in conjunction with gcp.spanner.DatabaseIAMMember resources only if they do not grant privilege to the same role.

google_spanner_database_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/editor",
        members: ["user:jane@example.com"],
    }],
});
const database = new gcp.spanner.DatabaseIAMPolicy("database", {
    instance: "your-instance-name",
    database: "your-database-name",
    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/editor",
    members=["user:jane@example.com"],
)])
database = gcp.spanner.DatabaseIAMPolicy("database",
    instance="your-instance-name",
    database="your-database-name",
    policy_data=admin.policy_data)

using System.Collections.Generic;
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/editor",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var database = new Gcp.Spanner.DatabaseIAMPolicy("database", new()
    {
        Instance = "your-instance-name",
        Database = "your-database-name",
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/spanner"
	"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/editor",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = spanner.NewDatabaseIAMPolicy(ctx, "database", &spanner.DatabaseIAMPolicyArgs{
			Instance:   pulumi.String("your-instance-name"),
			Database:   pulumi.String("your-database-name"),
			PolicyData: *pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.spanner.DatabaseIAMPolicy;
import com.pulumi.gcp.spanner.DatabaseIAMPolicyArgs;
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/editor")
                .members("user:jane@example.com")
                .build())
            .build());

        var database = new DatabaseIAMPolicy("database", DatabaseIAMPolicyArgs.builder()        
            .instance("your-instance-name")
            .database("your-database-name")
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

resources:
  database:
    type: gcp:spanner:DatabaseIAMPolicy
    properties:
      instance: your-instance-name
      database: your-database-name
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/editor
            members:
              - user:jane@example.com

google_spanner_database_iam_binding

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

const database = new gcp.spanner.DatabaseIAMBinding("database", {
    database: "your-database-name",
    instance: "your-instance-name",
    members: ["user:jane@example.com"],
    role: "roles/compute.networkUser",
});

import pulumi
import pulumi_gcp as gcp

database = gcp.spanner.DatabaseIAMBinding("database",
    database="your-database-name",
    instance="your-instance-name",
    members=["user:jane@example.com"],
    role="roles/compute.networkUser")

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var database = new Gcp.Spanner.DatabaseIAMBinding("database", new()
    {
        Database = "your-database-name",
        Instance = "your-instance-name",
        Members = new[]
        {
            "user:jane@example.com",
        },
        Role = "roles/compute.networkUser",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/spanner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := spanner.NewDatabaseIAMBinding(ctx, "database", &spanner.DatabaseIAMBindingArgs{
			Database: pulumi.String("your-database-name"),
			Instance: pulumi.String("your-instance-name"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
			Role: pulumi.String("roles/compute.networkUser"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.spanner.DatabaseIAMBinding;
import com.pulumi.gcp.spanner.DatabaseIAMBindingArgs;
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 database = new DatabaseIAMBinding("database", DatabaseIAMBindingArgs.builder()        
            .database("your-database-name")
            .instance("your-instance-name")
            .members("user:jane@example.com")
            .role("roles/compute.networkUser")
            .build());

    }
}

resources:
  database:
    type: gcp:spanner:DatabaseIAMBinding
    properties:
      database: your-database-name
      instance: your-instance-name
      members:
        - user:jane@example.com
      role: roles/compute.networkUser

google_spanner_database_iam_member

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

const database = new gcp.spanner.DatabaseIAMMember("database", {
    database: "your-database-name",
    instance: "your-instance-name",
    member: "user:jane@example.com",
    role: "roles/compute.networkUser",
});

import pulumi
import pulumi_gcp as gcp

database = gcp.spanner.DatabaseIAMMember("database",
    database="your-database-name",
    instance="your-instance-name",
    member="user:jane@example.com",
    role="roles/compute.networkUser")

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var database = new Gcp.Spanner.DatabaseIAMMember("database", new()
    {
        Database = "your-database-name",
        Instance = "your-instance-name",
        Member = "user:jane@example.com",
        Role = "roles/compute.networkUser",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/spanner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := spanner.NewDatabaseIAMMember(ctx, "database", &spanner.DatabaseIAMMemberArgs{
			Database: pulumi.String("your-database-name"),
			Instance: pulumi.String("your-instance-name"),
			Member:   pulumi.String("user:jane@example.com"),
			Role:     pulumi.String("roles/compute.networkUser"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.spanner.DatabaseIAMMember;
import com.pulumi.gcp.spanner.DatabaseIAMMemberArgs;
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 database = new DatabaseIAMMember("database", DatabaseIAMMemberArgs.builder()        
            .database("your-database-name")
            .instance("your-instance-name")
            .member("user:jane@example.com")
            .role("roles/compute.networkUser")
            .build());

    }
}

resources:
  database:
    type: gcp:spanner:DatabaseIAMMember
    properties:
      database: your-database-name
      instance: your-instance-name
      member: user:jane@example.com
      role: roles/compute.networkUser

Create DatabaseIAMBinding Resource

new DatabaseIAMBinding(name: string, args: DatabaseIAMBindingArgs, opts?: CustomResourceOptions);
@overload
def DatabaseIAMBinding(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       condition: Optional[DatabaseIAMBindingConditionArgs] = None,
                       database: Optional[str] = None,
                       instance: Optional[str] = None,
                       members: Optional[Sequence[str]] = None,
                       project: Optional[str] = None,
                       role: Optional[str] = None)
@overload
def DatabaseIAMBinding(resource_name: str,
                       args: DatabaseIAMBindingArgs,
                       opts: Optional[ResourceOptions] = None)
func NewDatabaseIAMBinding(ctx *Context, name string, args DatabaseIAMBindingArgs, opts ...ResourceOption) (*DatabaseIAMBinding, error)
public DatabaseIAMBinding(string name, DatabaseIAMBindingArgs args, CustomResourceOptions? opts = null)
public DatabaseIAMBinding(String name, DatabaseIAMBindingArgs args)
public DatabaseIAMBinding(String name, DatabaseIAMBindingArgs args, CustomResourceOptions options)

type: gcp:spanner:DatabaseIAMBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseIAMBindingArgs
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 DatabaseIAMBindingArgs
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 DatabaseIAMBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseIAMBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatabaseIAMBindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Database string

The name of the Spanner database.

Instance string

The name of the Spanner instance the database belongs to.

Members List<string>
Role string

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition DatabaseIAMBindingConditionArgs
Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Database string

The name of the Spanner database.

Instance string

The name of the Spanner instance the database belongs to.

Members []string
Role string

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition DatabaseIAMBindingConditionArgs
Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

database String

The name of the Spanner database.

instance String

The name of the Spanner instance the database belongs to.

members List<String>
role String

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

database string

The name of the Spanner database.

instance string

The name of the Spanner instance the database belongs to.

members string[]
role string

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

database str

The name of the Spanner database.

instance str

The name of the Spanner instance the database belongs to.

members Sequence[str]
role str

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

database String

The name of the Spanner database.

instance String

The name of the Spanner instance the database belongs to.

members List<String>
role String

The role that should be applied. Only one gcp.spanner.DatabaseIAMBinding 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 DatabaseIAMBinding resource produces the following output properties:

Etag string

(Computed) The etag of the database's IAM policy.

Id string

The provider-assigned unique ID for this managed resource.

Etag string

(Computed) The etag of the database's IAM policy.

Id string

The provider-assigned unique ID for this managed resource.

etag String

(Computed) The etag of the database's IAM policy.

id String

The provider-assigned unique ID for this managed resource.

etag string

(Computed) The etag of the database's IAM policy.

id string

The provider-assigned unique ID for this managed resource.

etag str

(Computed) The etag of the database's IAM policy.

id str

The provider-assigned unique ID for this managed resource.

etag String

(Computed) The etag of the database's IAM policy.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing DatabaseIAMBinding Resource

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

The name of the Spanner database.

Etag string

(Computed) The etag of the database's IAM policy.

Instance string

The name of the Spanner instance the database belongs to.

Members List<string>
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Condition DatabaseIAMBindingConditionArgs
Database string

The name of the Spanner database.

Etag string

(Computed) The etag of the database's IAM policy.

Instance string

The name of the Spanner instance the database belongs to.

Members []string
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
database String

The name of the Spanner database.

etag String

(Computed) The etag of the database's IAM policy.

instance String

The name of the Spanner instance the database belongs to.

members List<String>
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
database string

The name of the Spanner database.

etag string

(Computed) The etag of the database's IAM policy.

instance string

The name of the Spanner instance the database belongs to.

members string[]
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition DatabaseIAMBindingConditionArgs
database str

The name of the Spanner database.

etag str

(Computed) The etag of the database's IAM policy.

instance str

The name of the Spanner instance the database belongs to.

members Sequence[str]
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

condition Property Map
database String

The name of the Spanner database.

etag String

(Computed) The etag of the database's IAM policy.

instance String

The name of the Spanner instance the database belongs to.

members List<String>
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.spanner.DatabaseIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

Supporting Types

DatabaseIAMBindingCondition

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* {{project}}/{{instance}}/{{database}} * {{instance}}/{{database}} (project is taken from provider project) IAM member imports use space-delimited identifiers; the resource in question, the role, and the member identity, e.g.

 $ pulumi import gcp:spanner/databaseIAMBinding:DatabaseIAMBinding database "project-name/instance-name/database-name roles/viewer user:foo@example.com"

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

 $ pulumi import gcp:spanner/databaseIAMBinding:DatabaseIAMBinding database "project-name/instance-name/database-name roles/viewer"

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

 $ pulumi import gcp:spanner/databaseIAMBinding:DatabaseIAMBinding database project-name/instance-name/database-name

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

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.