v5.18.0/website/docs/r/iam_workload_identity_pool.html.markdown

---
# ----------------------------------------------------------------------------
#
#     ***     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: "Cloud IAM"
description: |-
  Represents a collection of external workload identities.
---

# google\_iam\_workload\_identity\_pool

Represents a collection of external workload identities. You can define IAM policies to
grant these identities access to Google Cloud resources.


To get more information about WorkloadIdentityPool, see:

* [API documentation](https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools)
* How-to Guides
    * [Managing workload identity pools](https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers#pools)

<div class = "oics-button" style="float: right; margin: 0 0 -15px">
  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_basic&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
  </a>
</div>
## Example Usage - Iam Workload Identity Pool Basic


```hcl
resource "google_iam_workload_identity_pool" "example" {
  workload_identity_pool_id = "example-pool"
}
```
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=iam_workload_identity_pool_full&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
  </a>
</div>
## Example Usage - Iam Workload Identity Pool Full


```hcl
resource "google_iam_workload_identity_pool" "example" {
  workload_identity_pool_id = "example-pool"
  display_name              = "Name of pool"
  description               = "Identity pool for automated test"
  disabled                  = true
}
```

## Argument Reference

The following arguments are supported:


* `workload_identity_pool_id` -
  (Required)
  The ID to use for the pool, which becomes the final component of the resource name. This
  value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix
  `gcp-` is reserved for use by Google, and may not be specified.


- - -


* `display_name` -
  (Optional)
  A display name for the pool. Cannot exceed 32 characters.

* `description` -
  (Optional)
  A description of the pool. Cannot exceed 256 characters.

* `disabled` -
  (Optional)
  Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use
  existing tokens to access resources. If the pool is re-enabled, existing tokens grant
  access again.

* `project` - (Optional) The ID of the project in which the resource belongs.
    If it is not provided, the provider project is used.


## Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

* `id` - an identifier for the resource with format `projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}`

* `state` -
  The state of the pool.
  * STATE_UNSPECIFIED: State unspecified.
  * ACTIVE: The pool is active, and may be used in Google Cloud policies.
  * DELETED: The pool is soft-deleted. Soft-deleted pools are permanently deleted after
    approximately 30 days. You can restore a soft-deleted pool using
    UndeleteWorkloadIdentityPool. You cannot reuse the ID of a soft-deleted pool until it is
    permanently deleted. While a pool is deleted, you cannot use it to exchange tokens, or
    use existing tokens to access resources. If the pool is undeleted, existing tokens grant
    access again.

* `name` -
  The resource name of the pool as
  `projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}`.


## Timeouts

This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

- `create` - Default is 20 minutes.
- `update` - Default is 20 minutes.
- `delete` - Default is 20 minutes.

## Import


WorkloadIdentityPool can be imported using any of these accepted formats:

* `projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}`
* `{{project}}/{{workload_identity_pool_id}}`
* `{{workload_identity_pool_id}}`


In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkloadIdentityPool using one of the formats above. For example:

```tf
import {
  id = "projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}"
  to = google_iam_workload_identity_pool.default
}
```

When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), WorkloadIdentityPool can be imported using one of the formats above. For example:

```
$ terraform import google_iam_workload_identity_pool.default projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}
$ terraform import google_iam_workload_identity_pool.default {{project}}/{{workload_identity_pool_id}}
$ terraform import google_iam_workload_identity_pool.default {{workload_identity_pool_id}}
```

## User Project Overrides

This resource supports [User Project Overrides](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#user_project_override).