terraform/website/docs/language/functions/jsonencode.mdx

51 lines
1.6 KiB
Plaintext
Raw Normal View History

---
2021-12-15 03:41:17 +01:00
page_title: jsonencode - Functions - Configuration Language
description: The jsonencode function encodes a given value as a JSON string.
---
# `jsonencode` Function
`jsonencode` encodes a given value to a string using JSON syntax.
The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159).
2019-03-21 20:20:29 +01:00
This function maps
2021-12-15 03:41:17 +01:00
[Terraform language values](/language/expressions/types)
to JSON values in the following way:
| Terraform type | JSON type |
| -------------- | --------- |
| `string` | String |
| `number` | Number |
| `bool` | Bool |
| `list(...)` | Array |
| `set(...)` | Array |
| `tuple(...)` | Array |
| `map(...)` | Object |
| `object(...)` | Object |
| Null value | `null` |
Since the JSON format cannot fully represent all of the Terraform language
types, passing the `jsonencode` result to `jsondecode` will not produce an
identical value, but the automatic type conversion rules mean that this is
rarely a problem in practice.
When encoding strings, this function escapes some characters using
Unicode escape sequences: replacing `<`, `>`, `&`, `U+2028`, and `U+2029` with
`\u003c`, `\u003e`, `\u0026`, `\u2028`, and `\u2029`. This is to preserve
compatibility with Terraform 0.11 behavior.
2021-08-23 21:01:38 +02:00
The `jsonencode` command outputs a minified representation of the input.
## Examples
```
> jsonencode({"hello"="world"})
{"hello":"world"}
```
## Related Functions
2021-12-15 03:41:17 +01:00
* [`jsondecode`](/language/functions/jsondecode) performs the opposite operation, _decoding_
a JSON string to obtain its represented value.