You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
terraform/website/docs/language/functions/index_function.mdx

41 lines
1.2 KiB

---
page_title: index - Functions - Configuration Language
description: The index function finds the element index for a given value in a list.
---
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
# `index` Function
`index` finds the first element index for a given value in a list.
```hcl
index(list, value)
```
The returned index is zero-based. This function produces an error if the given
value is not present in the list.
## Examples
```
> index(["a", "b", "c"], "b")
1
```
In this example, the index of the first occurence of `"two"` is returned.
```
> index(["one", "two", "two"], "two")
1
```
## Related Functions
* [`element`](/terraform/language/functions/element) retrieves a particular element from a list given
its index.