forked from hashicorp/terraform-provider-google
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add google_kms_key_ring_iam_policy resource and improve iam docs (has…
…hicorp#814) * Add google_kms_key_ring_iam_policy resource and improve iam docs * Delete iam_binding and iam_member specific doc page for key ring
- Loading branch information
Showing
6 changed files
with
98 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
layout: "google" | ||
page_title: "Google: google_kms_key_ring_iam" | ||
sidebar_current: "docs-google-kms-key-ring-iam" | ||
description: |- | ||
Collection of resources to manage IAM policy for a Google Cloud KMS key ring. | ||
--- | ||
|
||
# IAM policy for Google Cloud KMS key ring | ||
|
||
Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case: | ||
|
||
* `google_kms_key_ring_iam_policy`: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached. | ||
* `google_kms_key_ring_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 key ring are preserved. | ||
* `google_kms_key_ring_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the key ring are preserved. | ||
|
||
~> **Note:** `google_kms_key_ring_iam_policy` **cannot** be used in conjunction with `google_kms_key_ring_iam_binding` and `google_kms_key_ring_iam_member` or they will fight over what your policy should be. | ||
|
||
~> **Note:** `google_kms_key_ring_iam_binding` resources **can be** used in conjunction with `google_kms_key_ring_iam_member` resources **only if** they do not grant privilege to the same role. | ||
|
||
## google\_kms\_key\_ring\_iam\_policy | ||
|
||
```hcl | ||
data "google_iam_policy" "admin" { | ||
binding { | ||
role = "roles/editor" | ||
members = [ | ||
"user:[email protected]", | ||
] | ||
} | ||
} | ||
resource "google_kms_key_ring_iam_policy" "key_ring" { | ||
key_ring_id = "your-key-ring-id" | ||
policy_data = "${data.google_iam_policy.admin.policy_data}" | ||
} | ||
``` | ||
|
||
## google\_kms\_key\_ring\_iam\_binding | ||
|
||
```hcl | ||
resource "google_kms_key_ring_binding" "key_ring" { | ||
key_ring_id = "your-key-ring-id" | ||
role = "roles/editor" | ||
members = [ | ||
"user:[email protected]", | ||
] | ||
} | ||
``` | ||
|
||
## google\_kms\_key\_ring\_iam\_member | ||
|
||
```hcl | ||
resource "google_kms_key_ring_iam_member" "key_ring" { | ||
key_ring_id = "your-key-ring-id" | ||
role = "roles/editor" | ||
member = "user:[email protected]" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `key_ring_id` - (Required) The key ring ID, in the form | ||
`{project_id}/{location_name}/{key_ring_name}` or | ||
`{location_name}/{key_ring_name}`. In the second form, the provider's | ||
project setting will be used as a fallback. | ||
|
||
* `member/members` - (Required) Identities that will be granted the privilege in `role`. | ||
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, [email protected] or [email protected]. | ||
* **serviceAccount:{emailid}**: An email address that represents a service account. For example, [email protected]. | ||
* **group:{emailid}**: An email address that represents a Google group. For example, [email protected]. | ||
* **domain:{domain}**: A Google Apps domain 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 one | ||
`google_kms_key_ring_iam_binding` can be used per role. | ||
|
||
* `policy_data` - (Required only by `google_kms_key_ring_iam_policy`) The policy data generated by | ||
a `google_iam_policy` data source. | ||
|
||
## Attributes Reference | ||
|
||
In addition to the arguments listed above, the following computed attributes are | ||
exported: | ||
|
||
* `etag` - (Computed) The etag of the key ring's IAM policy. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters