tobool Function

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

[!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. ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

tobool converts its argument to a boolean value.

Explicit type conversions are rarely necessary in Terraform because it will convert types automatically where required. Use the explicit type conversion functions only to normalize types returned in module outputs.

Only boolean values, null, and the exact strings "true" and "false" can be converted to boolean. All other values will produce an error.

Examples

> tobool(true)
true
> tobool("true")
true
> tobool(null)
null
> tobool("no")
Error: Invalid function argument
 
Invalid value for "v" parameter: cannot convert "no" to bool: only the strings
"true" or "false" are allowed.
 
> tobool(1)
Error: Invalid function argument
 
Invalid value for "v" parameter: cannot convert number to bool.