ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/docs/language/functions/index.mdx

40 lines
1.4 KiB
Plaintext
Raw Normal View History

website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
---
migrate docs to mdx
2021-12-15 03:41:17 +01:00
page_title: Functions - Configuration Language
description: >-
An introduction to the built-in functions that you can use to transform and
combine values in expressions.
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
---
# Built-in Functions
website: link to functions tutorial where applicable
2020-12-01 22:10:05 +01:00
> **Hands-on:** Try the [Perform Dynamic Operations with Functions](https://learn.hashicorp.com/tutorials/terraform/functions?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn.
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
The Terraform language includes a number of built-in functions that you can
call from within expressions to transform and combine values. The general
syntax for function calls is a function name followed by comma-separated
arguments in parentheses:
```hcl
max(5, 12, 9)
```
For more details on syntax, see
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[_Function Calls_](/language/expressions/function-calls)
website: Update all links to {expressions,modules,resources}.html ...as well as to the standard module structure section in module development.
2020-11-13 03:30:52 +01:00
in the Expressions section.
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
The Terraform language does not support user-defined functions, and so only
the functions built in to the language are available for use. The navigation
website: Structural edit of configuration language docs This commit is a wide-ranging set of edits to the pages under /docs/configuration. Among other things, it - Separates style conventions out into their own page. - Separates type constraints and conversion info into their own page. - Conflates similar complex types a little more freely, since the distinction is only relevant when restricting inputs for a reusable module or resource. - Clarifies several concepts that confused me during edits.
2018-12-11 01:14:33 +01:00
for this section includes a list of all of the available built-in functions.
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
You can experiment with the behavior of Terraform's built-in functions from
the Terraform expression console, by running
migrate docs to mdx
2021-12-15 03:41:17 +01:00
[the `terraform console` command](/cli/commands/console):
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
```
> max(5, 12, 9)
12
```
The examples in the documentation for each function use console output to
illustrate the result of calling the function with different parameters.