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.

Create a DatabaseIAMBinding Resource

new DatabaseIAMBinding(name: string, args: DatabaseIAMBindingArgs, opts?: CustomResourceOptions);

def DatabaseIAMBinding(resource_name, opts=None, condition=None, database=None, instance=None, members=None, project=None, role=None, __props__=None);

func NewDatabaseIAMBinding(ctx *Context, name string, args DatabaseIAMBindingArgs, opts ...ResourceOption) (*DatabaseIAMBinding, error)

public DatabaseIAMBinding(string name, DatabaseIAMBindingArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

DatabaseIAMBinding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 DatabaseIAMBindingCondition
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 DatabaseIAMBindingCondition
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 List[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 Dict[DatabaseIAMBindingCondition]
project str: 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 str: (Computed) The etag of the database’s IAM policy.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, condition=None, database=None, etag=None, instance=None, members=None, project=None, role=None, __props__=None);

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)

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 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 DatabaseIAMBindingCondition
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 DatabaseIAMBindingCondition
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 Dict[DatabaseIAMBindingCondition]
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 List[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}.

Supporting Types

DatabaseIAMBindingCondition

See the input and output API doc for this type.

Expression string
Title string
Description string

Expression string
Title string
Description string

expression string
title string
description string

expression str
title str
description str

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud