Google Cloud Spanner Database IAM
This page shows how to write Terraform for Cloud Spanner Database IAM and write them securely.
google_spanner_database_iam (Terraform)
The Database IAM in Cloud Spanner can be configured in Terraform with the resource name google_spanner_database_iam
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
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 inrole
. Each entry can have one of the following values:- allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
- allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
- user:[emailid]: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
- serviceAccount:[emailid]: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
- group:[emailid]: An email address that represents a Google group. For example, admins@example.com.
- domain:[domain]: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
role
- (Required) The role that should be applied. Only onegoogle_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 bygoogle_spanner_database_iam_policy
) The policy data generated by agoogle_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.
In addition to the arguments listed above, the following computed attributes are exported:
etag
- (Computed) The etag of the database's IAM policy.
Explanation in Terraform Registry
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.Warning: It's entirely possibly to lock yourself out of your database using
google_spanner_database_iam_policy
. Any permissions granted by default will be removed unless you include them in your config.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.Note:
google_spanner_database_iam_policy
cannot be used in conjunction withgoogle_spanner_database_iam_binding
andgoogle_spanner_database_iam_member
or they will fight over what your policy should be.Note:
google_spanner_database_iam_binding
resources can be used in conjunction withgoogle_spanner_database_iam_member
resources only if they do not grant privilege to the same role.