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::Transform`
<a name="intrinsic-function-reference-transform"></a>

A função intrínseca `Fn::Transform` especifica uma macro para realizar o processamento personalizado em parte de um modelo de pilha. Macros permitem realizar o processamento personalizado em modelos, desde ações simples, como operações de localizar e substituir, até transformações extensas de modelos inteiros. Para obter mais informações, consulte [Usar macros do CloudFormation para executar processamento personalizado em modelos](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) no *Guia do usuário do AWS CloudFormation*.

Você também pode usar `Fn::Transform` para chamar a transformação [`AWS::Include`Transformação](transform-aws-include.md), que é uma macro hospedado pelo CloudFormation.

## Declaração
<a name="intrinsic-function-reference-transform-declaration"></a>

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

Sintaxe para o nome da função completo:

```
{
    "Fn::Transform": {
        "Name": "macro name",
        "Parameters": {
            "Key": "value"
        }
    }
}
```

Sintaxe para a forma resumida:

```
{
    "Transform": {
        "Name": "macro name",
        "Parameters": {
            "Key": "value"
        }
    }
}
```

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

Sintaxe para o nome da função completo:

```
Fn::Transform:
  Name : macro name
  Parameters :
    Key : value
```

Sintaxe para a forma resumida:

```
!Transform
  Name: macro name
  Parameters:
    Key: value
```

## Parâmetros
<a name="intrinsic-function-reference-transform-parameters"></a>

`Name`  
O nome da macro da qual você deseja realizar o processamento.

`Parameters`  
Os parâmetros de lista, especificados como pares de chave/valor a serem transferidos para a macro.

## Valor de retorno
<a name="intrinsic-function-reference-transform-returnvalue"></a>

O trecho de modelo processado a ser incluído no modelo de pilha.

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

O exemplo a seguir chama a transformação `AWS::Include`, especificando que o local de onde recuperar um trecho de modelo é transmitido no parâmetro `InputValue`.

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

```
{
    "Fn::Transform": {
        "Name": "AWS::Include",
        "Parameters": {
            "Location": {
                "Ref": "InputValue"
            }
        }
    }
}
```

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

```
Fn::Transform:
  Name: AWS::Include
  Parameters:
    Location: !Ref InputValue
```

## Funções compatíveis
<a name="intrinsic-function-reference-transform-supported-functions"></a>

Nenhum.

O CloudFormation transmite qualquer chamada de função intrínseca incluída em `Fn::Transform` à macro especificada como strings de literal.