DatabaseIAMPolicy

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

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/databaseIAMPolicy:DatabaseIAMPolicy 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/databaseIAMPolicy:DatabaseIAMPolicy 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/databaseIAMPolicy:DatabaseIAMPolicy 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.

Properties

Link copied to clipboard
val database: Output<String>

The name of the Spanner database.

Link copied to clipboard
val etag: Output<String>

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instance: Output<String>

The name of the Spanner instance the database belongs to.

Link copied to clipboard
val policyData: Output<String>

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Link copied to clipboard
val project: Output<String>

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>