github.com/iaas-resource-provision/iaas-rpc@v1.0.7-0.20211021023331-ed21f798c408/website/docs/language/functions/tobool.html.md (about)

     1  ---
     2  layout: "language"
     3  page_title: "tobool - Functions - Configuration Language"
     4  sidebar_current: "docs-funcs-conversion-tobool"
     5  description: |-
     6    The tobool function converts a value to boolean.
     7  ---
     8  
     9  # `tobool` Function
    10  
    11  `tobool` converts its argument to a boolean value.
    12  
    13  Explicit type conversions are rarely necessary in Terraform because it will
    14  convert types automatically where required. Use the explicit type conversion
    15  functions only to normalize types returned in module outputs.
    16  
    17  Only boolean values and the exact strings `"true"` and `"false"` can be
    18  converted to boolean. All other values will produce an error.
    19  
    20  ## Examples
    21  
    22  ```
    23  > tobool(true)
    24  true
    25  > tobool("true")
    26  true
    27  > tobool("no")
    28  Error: Invalid function argument
    29  
    30  Invalid value for "v" parameter: cannot convert "no" to bool: only the strings
    31  "true" or "false" are allowed.
    32  
    33  > tobool(1)
    34  Error: Invalid function argument
    35  
    36  Invalid value for "v" parameter: cannot convert number to bool.
    37  ```