You're looking at documentation for Terraform v1.1 and earlier. Click here to view the latest content.
A new platform for documentation and tutorials is launching soon.
We are migrating Terraform documentation into HashiCorp Developer, our new developer experience.
regexall applies a
to a string and returns a list of all matches.
regexall is a variant of
regex and uses the same pattern
syntax. For any given input to
regexall returns a list of whatever
regex would've returned, with one element per match. That is:
- If the pattern has no capture groups at all, the result is a list of strings.
- If the pattern has one or more unnamed capture groups, the result is a list of lists.
- If the pattern has one or more named capture groups, the result is a list of maps.
regexall can also be used to test whether a particular string matches a
given pattern, by testing whether the length of the resulting list of matches
is greater than zero.
> regexall("[a-z]+", "1234abcd5678efgh9") [ "abcd", "efgh", ] > length(regexall("[a-z]+", "1234abcd5678efgh9")) 2 > length(regexall("[a-z]+", "123456789")) > 0 false
regexsearches for a single match of a given pattern, and returns an error if no match is found.
If Terraform already has a more specialized function to parse the syntax you are trying to match, prefer to use that function instead. Regular expressions can be hard to read and can obscure your intent, making a configuration harder to read and understand.