Three different resources help you manage your IAM policy for a Spanner database. Each of these resources serves a different use case:
google_spanner_database_iam_policy
: Authoritative. Sets the IAM policy for the database and replaces any existing policy already attached.google_spanner_database_iam_binding
: 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.google_spanner_database_iam_member
: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the database are preserved.data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:jane@example.com",
]
}
}
resource "google_spanner_database_iam_policy" "database" {
instance = "your-instance-name"
database = "your-database-name"
policy_data = data.google_iam_policy.admin.policy_data
}
With IAM Conditions:
data "google_iam_policy" "admin" {
binding {
role = "roles/editor"
members = [
"user:jane@example.com",
]
condition {
title = "My Role"
description = "Grant permissions on my_role"
expression = "(resource.type == \"spanner.googleapis.com/DatabaseRole\" && (resource.name.endsWith(\"/myrole\")))"
}
}
}
resource "google_spanner_database_iam_policy" "database" {
instance = "your-instance-name"
database = "your-database-name"
policy_data = data.google_iam_policy.admin.policy_data
}
resource "google_spanner_database_iam_binding" "database" {
instance = "your-instance-name"
database = "your-database-name"
role = "roles/compute.networkUser"
members = [
"user:jane@example.com",
]
}
With IAM Conditions:
resource "google_spanner_database_iam_binding" "database" {
instance = "your-instance-name"
database = "your-database-name"
role = "roles/compute.networkUser"
members = [
"user:jane@example.com",
]
condition {
title = "My Role"
description = "Grant permissions on my_role"
expression = "(resource.type == \"spanner.googleapis.com/DatabaseRole\" && (resource.name.endsWith(\"/myrole\")))"
}
}
resource "google_spanner_database_iam_member" "database" {
instance = "your-instance-name"
database = "your-database-name"
role = "roles/compute.networkUser"
member = "user:jane@example.com"
}
With IAM Conditions:
resource "google_spanner_database_iam_member" "database" {
instance = "your-instance-name"
database = "your-database-name"
role = "roles/compute.networkUser"
member = "user:jane@example.com"
condition {
title = "My Role"
description = "Grant permissions on my_role"
expression = "(resource.type == \"spanner.googleapis.com/DatabaseRole\" && (resource.name.endsWith(\"/myrole\")))"
}
}
The following arguments are supported:
database
- (Required) The name of the Spanner database.
instance
- (Required) The name of the Spanner instance the database belongs to.
member/members
- (Required) Identities that will be granted the privilege in role
.
Each entry can have one of the following values:
role
- (Required) The role that should be applied. Only one
google_spanner_database_iam_binding
can be used per role. Note that custom roles must be of the format
[projects|organizations]/{parent-name}/roles/{role-name}
.
policy_data
- (Required only by google_spanner_database_iam_policy
) The policy data generated by
a google_iam_policy
data source.
project
- (Optional) The ID of the project in which the resource belongs. If it
is not provided, the provider project is used.
condition
- (Optional) An IAM Condition for a given binding.
Structure is documented below.
expression
- (Required) Textual representation of an expression in Common Expression Language syntax.
title
- (Required) A title for the expression, i.e. a short string describing its purpose.
description
- (Optional) An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
In addition to the arguments listed above, the following computed attributes are exported:
etag
- (Computed) The etag of the database's IAM policy.For all import syntaxes, the "resource in question" can take any of the following forms:
IAM member imports use space-delimited identifiers that contains the database
, role
, and member
. For example:
"{{project}}/{{instance}}/{{database}} roles/viewer user:foo@example.com"
An import
block (Terraform v1.5.0 and later) can be used to import IAM members:
import {
id = "{{project}}/{{instance}}/{{database}} roles/viewer user:foo@example.com"
to = google_spanner_database_iam_member.default
}
The terraform import
command can also be used:
$ terraform import google_spanner_database_iam_member.default "{{project}}/{{instance}}/{{database}} roles/viewer user:foo@example.com"
IAM binding imports use space-delimited identifiers that contain the resource's database
and role
. For example:
"{{project}}/{{instance}}/{{database}} roles/viewer"
An import
block (Terraform v1.5.0 and later) can be used to import IAM bindings:
import {
id = "{{project}}/{{instance}}/{{database}} roles/viewer"
to = google_spanner_database_iam_binding.default
}
The terraform import
command can also be used:
$ terraform import google_spanner_database_iam_binding.default "{{project}}/{{instance}}/{{database}} roles/viewer"
IAM policy imports use the identifier of the Spanner Database resource in question. For example:
{{project}}/{{instance}}/{{database}}
An import
block (Terraform v1.5.0 and later) can be used to import IAM policies:
import {
id = {{project}}/{{instance}}/{{database}}
to = google_spanner_database_iam_policy.default
}
The terraform import
command can also be used:
$ terraform import google_spanner_database_iam_policy.default {{project}}/{{instance}}/{{database}}