Skip to content

Commit

Permalink
feat(vertexai): Add IAM resources for Vertex AI FeatureStore EntityTy…
Browse files Browse the repository at this point in the history
…pe (beta) (#6789) (#13126)

* feat: add the iam resources for featurestore entitytype

* fix: fix the unit test errors

Signed-off-by: Modular Magician <magic-modules@google.com>

Signed-off-by: Modular Magician <magic-modules@google.com>
  • Loading branch information
modular-magician committed Nov 28, 2022
1 parent cb42c19 commit d02c5c7
Show file tree
Hide file tree
Showing 3 changed files with 147 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changelog/6789.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```release-note:new-resource
google_vertex_ai_featurestore_entitytype_iam_binding (beta)
google_vertex_ai_featurestore_entitytype_iam_member (beta)
google_vertex_ai_featurestore_entitytype_iam_policy (beta)
```
4 changes: 2 additions & 2 deletions google/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -927,8 +927,8 @@ func Provider() *schema.Provider {
}

// Generated resources: 247
// Generated IAM resources: 150
// Total generated resources: 397
// Generated IAM resources: 153
// Total generated resources: 400
func ResourceMap() map[string]*schema.Resource {
resourceMap, _ := ResourceMapWithErrors()
return resourceMap
Expand Down
140 changes: 140 additions & 0 deletions website/docs/r/vertex_ai_featurestore_entitytype_iam.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** Type: MMv1 ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Vertex AI"
page_title: "Google: google_vertex_ai_featurestore_entitytype_iam"
description: |-
Collection of resources to manage IAM policy for Vertex AI FeaturestoreEntitytype
---

# IAM policy for Vertex AI FeaturestoreEntitytype
Three different resources help you manage your IAM policy for Vertex AI FeaturestoreEntitytype. Each of these resources serves a different use case:

* `google_vertex_ai_featurestore_entitytype_iam_policy`: Authoritative. Sets the IAM policy for the featurestoreentitytype and replaces any existing policy already attached.
* `google_vertex_ai_featurestore_entitytype_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 featurestoreentitytype are preserved.
* `google_vertex_ai_featurestore_entitytype_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the featurestoreentitytype are preserved.

~> **Note:** `google_vertex_ai_featurestore_entitytype_iam_policy` **cannot** be used in conjunction with `google_vertex_ai_featurestore_entitytype_iam_binding` and `google_vertex_ai_featurestore_entitytype_iam_member` or they will fight over what your policy should be.

~> **Note:** `google_vertex_ai_featurestore_entitytype_iam_binding` resources **can be** used in conjunction with `google_vertex_ai_featurestore_entitytype_iam_member` resources **only if** they do not grant privilege to the same role.


~> **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/providers/google/guides/provider_versions.html) for more details on beta resources.


## google\_vertex\_ai\_featurestore\_entitytype\_iam\_policy

```hcl
data "google_iam_policy" "admin" {
binding {
role = "roles/viewer"
members = [
"user:jane@example.com",
]
}
}
resource "google_vertex_ai_featurestore_entitytype_iam_policy" "policy" {
featurestore = google_vertex_ai_featurestore_entitytype.entity.featurestore
entitytype = google_vertex_ai_featurestore_entitytype.entity.name
policy_data = data.google_iam_policy.admin.policy_data
}
```

## google\_vertex\_ai\_featurestore\_entitytype\_iam\_binding

```hcl
resource "google_vertex_ai_featurestore_entitytype_iam_binding" "binding" {
featurestore = google_vertex_ai_featurestore_entitytype.entity.featurestore
entitytype = google_vertex_ai_featurestore_entitytype.entity.name
role = "roles/viewer"
members = [
"user:jane@example.com",
]
}
```

## google\_vertex\_ai\_featurestore\_entitytype\_iam\_member

```hcl
resource "google_vertex_ai_featurestore_entitytype_iam_member" "member" {
featurestore = google_vertex_ai_featurestore_entitytype.entity.featurestore
entitytype = google_vertex_ai_featurestore_entitytype.entity.name
role = "roles/viewer"
member = "user:jane@example.com"
}
```

## Argument Reference

The following arguments are supported:

* `entitytype` - (Required) Used to find the parent resource to bind the IAM policy to
* `featurestore` - (Required) The name of the Featurestore to use, in the format projects/{project}/locations/{location}/featurestores/{featurestore}. Used to find the parent resource to bind the IAM policy to

* `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.
* **projectOwner:projectid**: Owners of the given project. For example, "projectOwner:my-example-project"
* **projectEditor:projectid**: Editors of the given project. For example, "projectEditor:my-example-project"
* **projectViewer:projectid**: Viewers of the given project. For example, "projectViewer:my-example-project"

* `role` - (Required) The role that should be applied. Only one
`google_vertex_ai_featurestore_entitytype_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_vertex_ai_featurestore_entitytype_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 IAM policy.

## Import

For all import syntaxes, the "resource in question" can take any of the following forms:

* {{featurestore}}/entityTypes/{{name}}
* {{name}}

Any variables not passed in the import command will be taken from the provider configuration.

Vertex AI featurestoreentitytype IAM resources can be imported using the resource identifiers, role, and member.

IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
```
$ terraform import google_vertex_ai_featurestore_entitytype_iam_member.editor "{{featurestore}}/entityTypes/{{featurestore_entitytype}} roles/viewer user:jane@example.com"
```

IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
```
$ terraform import google_vertex_ai_featurestore_entitytype_iam_binding.editor "{{featurestore}}/entityTypes/{{featurestore_entitytype}} roles/viewer"
```

IAM policy imports use the identifier of the resource in question, e.g.
```
$ terraform import google_vertex_ai_featurestore_entitytype_iam_policy.editor {{featurestore}}/entityTypes/{{featurestore_entitytype}}
```

-> **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`.

0 comments on commit d02c5c7

Please sign in to comment.