mirror of
https://github.com/letic/terraform-provider-google.git
synced 2024-09-07 09:36:44 +00:00
129 lines
5.3 KiB
Markdown
129 lines
5.3 KiB
Markdown
---
|
|
layout: "google"
|
|
page_title: "Google: google_compute_subnetwork_iam"
|
|
sidebar_current: "docs-google-compute-subnetwork-iam"
|
|
description: |-
|
|
Collection of resources to manage IAM policy for a GCE subnetwork.
|
|
---
|
|
|
|
# IAM policy for GCE subnetwork
|
|
|
|
~> **Warning:** These resources are in beta, and should be used with the terraform-provider-google-beta provider.
|
|
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta resources.
|
|
|
|
Three different resources help you manage your IAM policy for GCE subnetwork. Each of these resources serves a different use case:
|
|
|
|
* `google_compute_subnetwork_iam_policy`: Authoritative. Sets the IAM policy for the subnetwork and replaces any existing policy already attached.
|
|
* `google_compute_subnetwork_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 subnetwork are preserved.
|
|
* `google_compute_subnetwork_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subnetwork are preserved.
|
|
|
|
~> **Note:** `google_compute_subnetwork_iam_policy` **cannot** be used in conjunction with `google_compute_subnetwork_iam_binding` and `google_compute_subnetwork_iam_member` or they will fight over what your policy should be.
|
|
|
|
~> **Note:** `google_compute_subnetwork_iam_binding` resources **can be** used in conjunction with `google_compute_subnetwork_iam_member` resources **only if** they do not grant privilege to the same role.
|
|
|
|
~> **Note:** These entire resources are in [Beta](/docs/providers/google/index.html#beta-features)
|
|
|
|
## google\_compute\_subnetwork\_iam\_policy
|
|
|
|
```hcl
|
|
data "google_iam_policy" "admin" {
|
|
binding {
|
|
role = "roles/editor"
|
|
|
|
members = [
|
|
"user:jane@example.com",
|
|
]
|
|
}
|
|
}
|
|
|
|
resource "google_compute_subnetwork_iam_policy" "subnet" {
|
|
subnetwork = "your-subnetwork-id"
|
|
policy_data = "${data.google_iam_policy.admin.policy_data}"
|
|
}
|
|
```
|
|
|
|
## google\_compute\_subnetwork\_iam\_binding
|
|
|
|
```hcl
|
|
resource "google_compute_subnetwork_iam_binding" "subnet" {
|
|
subnetwork = "your-subnetwork-id"
|
|
role = "roles/compute.networkUser"
|
|
|
|
members = [
|
|
"user:jane@example.com",
|
|
]
|
|
}
|
|
```
|
|
|
|
## google\compute\_subnetwork\_iam\_member
|
|
|
|
```hcl
|
|
resource "google_compute_subnetwork_iam_member" "subnet" {
|
|
subnetwork = "your-subnetwork-id"
|
|
role = "roles/compute.networkUser"
|
|
member = "user:jane@example.com"
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
* `subnetwork` - (Required) The name of the subnetwork.
|
|
|
|
* `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, 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 one
|
|
`google_compute_subnetwork_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_compute_subnetwork_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.
|
|
|
|
* `region` - (Optional) The region of the subnetwork. If
|
|
unspecified, this defaults to the region configured in the provider.
|
|
|
|
## Attributes Reference
|
|
|
|
In addition to the arguments listed above, the following computed attributes are
|
|
exported:
|
|
|
|
* `etag` - (Computed) The etag of the subnetwork's IAM policy.
|
|
|
|
## Import
|
|
|
|
For all import syntaxes, the "resource in question" can take any of the following forms:
|
|
|
|
* full self link or relative link (projects/{{project}}/region/{{region}}/subnetworks/{{name}})
|
|
* {{project}}/{{region}}/{{name}}
|
|
* {{region}}/{{name}} (project is taken from provider project)
|
|
* {{name}} (project and region are taken from provider project)
|
|
|
|
IAM member imports use space-delimited identifiers; the resource in question, the role, and the account, e.g.
|
|
|
|
```
|
|
$ terraform import google_compute_subnetwork_iam_member.subnet "project-name/region-name/subnetwork-name roles/compute.networkUser foo@example.com"
|
|
```
|
|
|
|
IAM binding imports use space-delimited identifiers; the resource in question and the role, e.g.
|
|
|
|
```
|
|
$ terraform import google_compute_subnetwork_iam_binding.subnet "project-name/region-name/subnetwork-name roles/compute.networkUser"
|
|
```
|
|
|
|
IAM policy imports use the identifier of the resource in question, e.g.
|
|
|
|
```
|
|
$ terraform import google_compute_subnetwork_iam_policy.subnet project-name/region-name/subnetwork-name
|
|
```
|