terraform/website/docs/configuration/functions/lookup.html.md

1.0 KiB

layout page_title sidebar_current description
language lookup - Functions - Configuration Language docs-funcs-collection-lookup The lookup function retrieves an element value from a map given its key.

lookup Function

-> Note: This page is about Terraform 0.12 and later. For Terraform 0.11 and earlier, see 0.11 Configuration Language: Interpolation Syntax.

lookup retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead.

lookup(map, key, default)

-> For historical reasons, the default parameter is actually optional. However, omitting default is deprecated since v0.7 because that would then be equivalent to the native index syntax, map[key].

Examples

> lookup({a="ay", b="bee"}, "a", "what?")
ay
> lookup({a="ay", b="bee"}, "c", "what?")
what?
  • element retrieves a value from a list given its index.