

Este é o novo *Guia de referência de modelos do CloudFormation*. Atualize seus favoritos e links. Para obter ajuda para começar a usar o CloudFormation, consulte o [Guia do usuário do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# `Fn::ToJsonString`
<a name="intrinsic-function-reference-ToJsonString"></a>

A função intrínseca `Fn::ToJsonString` converte um objeto ou matriz na string JSON correspondente.

**Importante**  
Você deve usar o [`AWS::LanguageExtensions`Transformação](transform-aws-languageextensions.md) para usar a função intrínseca `Fn::ToJsonString`.

## Declaração
<a name="tojsonstring-declaration"></a>

### JSON
<a name="intrinsic-function-reference-tojsonstring-syntax.json"></a>

```
{ "Fn::ToJsonString": Object }
```

```
{ "Fn::ToJsonString": Array }
```

### YAML
<a name="intrinsic-function-reference-tojsonstring-syntax.yaml"></a>

```
Fn::ToJsonString: Object
```

```
Fn::ToJsonString: Array
```

## Parâmetros
<a name="tojsonstring-parameters"></a>

`Object`  
O objeto que você deseja converter em uma string JSON.

`Array`  
A matriz que você deseja converter em uma string JSON.

## Valor de retorno
<a name="intrinsic-function-reference-tojsonstring-return"></a>

O objeto ou a matriz convertidos em uma string JSON. 

## Exemplos
<a name="intrinsic-function-reference-tojsonstring-examples"></a>

### Converter um objeto em uma string JSON
<a name="intrinsic-function-reference-tojsonstring-example-subsection"></a>

Esse exemplo de trecho converte o objeto passado para a função intrínseca em uma string JSON.

#### JSON
<a name="intrinsic-function-reference-tojsonstring-example.json"></a>

```
{
//...
    "Transform": "AWS::LanguageExtensions"
    //...
        "Fn::ToJsonString": {
            "key1": "value1",
            "key2": { 
                "Ref": "ParameterName"
            }
        }
//...
}
```

#### YAML
<a name="intrinsic-function-reference-tojsonstring-example.yaml"></a>

```
Transform: 'AWS::LanguageExtensions'
#...
  Fn::ToJsonString: 
    key1: value1
    key2: !Ref ParameterName
#...
```

Em ambos os exemplos, se a `Ref` para `ParameterName` for resolvida como `resolvedValue`, a função será resolvida como a seguinte string JSON:

```
"{\"key1\":\"value1\",\"key2\":\"resolvedValue\"}"
```

### Converter uma matriz em uma string JSON
<a name="intrinsic-function-reference-tojsonstring-example2"></a>

Esse exemplo de trecho converte a matriz passada para a função intrínseca em uma string JSON.

#### JSON
<a name="intrinsic-function-reference-tojsonstring-example2.json"></a>

```
{
//...
    "Transform": "AWS::LanguageExtensions"
    //...
        "Fn::ToJsonString": [{
            "key1": "value1",
            "key2": { 
                "Ref": "ParameterName" 
            }
        }]
//...
}
```

#### YAML
<a name="intrinsic-function-reference-tojsonstring-example2.yaml"></a>

```
Transform: 'AWS::LanguageExtensions'
#...
  Fn::ToJsonString: 
    - key1: value1
      key2: !Ref ParameterName
#...
```

Em ambos os exemplos, se a `Ref` para `ParameterName` for resolvida como `resolvedValue`, a função será resolvida como a seguinte string JSON:

```
"[{\"key1\":\"value1\"},{\"key2\":\"resolvedValue\"}]"
```

## Funções compatíveis
<a name="tojsonstring-supported-functions"></a>

Você pode usar as funções a seguir na função intrínseca `Fn::ToJsonString` ou na matriz:
+ `Fn::Base64`
+ `Fn::FindInMap`
+ `Fn::GetAtt`
+ `Fn::GetAZs`
+ `Fn::If`
+ `Fn::ImportValue`
+ `Fn::Join`
+ `Fn::Length`
+ `Fn::Select`
+ `Fn::Split`
+ `Fn::Sub`
+ `Fn::ToJsonString`
+ `Ref`