Back to Packer

`element` Function

website/content/docs/templates/hcl_templates/functions/collection/element.mdx

1.15.31.4 KB
Original Source

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

[!IMPORTANT]
Documentation Update: Product documentation previously located in /website has moved to the 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. ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

element Function

element retrieves a single element from a list.

hcl
element(list, index)

The index is zero-based. This function produces an error if used with an empty list.

Use the built-in index syntax list[index] in most cases. Use this function only for the special additional "wrap-around" behavior described below.

Examples

shell-session
> element(["a", "b", "c"], 1)
b

If the given index is greater than the length of the list then the index is "wrapped around" by taking the index modulo the length of the list:

shell-session
> element(["a", "b", "c"], 3)
a
  • index finds the index for a particular element value.
  • lookup retrieves a value from a map given its key.