As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Referência de sintaxe de esquema de configuração de hook
<a name="hook-configuration-schema"></a>

Esta seção descreve a sintaxe do esquema usada para configurar Hooks. CloudFormation usa esse esquema de configuração em tempo de execução ao invocar um Hook em um. Conta da AWS

Para permitir que seu Hook inspecione proativamente a configuração de sua pilha, `HookInvocationStatus` defina como `ENABLED` após o Hook ter sido registrado e ativado em sua conta. 

**Topics**
+ [Propriedades do esquema de configuração do gancho](#hook-configuration-schema-properties)
+ [Exemplos de configuração de ganchos](#hook-configuration-examples)
+ [CloudFormation Filtros de nível de pilha de ganchos](hooks-stack-level-filtering.md)
+ [CloudFormation Filtros de destino de ganchos](hooks-target-filtering.md)
+ [Usando curingas com nomes de destino de Hook](wildcard-hook-targets.md)

**nota**  
A quantidade máxima de dados que a configuração de um Hook pode armazenar é 300 KB. Isso é um acréscimo a todas as restrições impostas ao parâmetro de operação da `Configuration` [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)solicitação.

## Propriedades do esquema de configuração do gancho
<a name="hook-configuration-schema-properties"></a>

O esquema a seguir é a estrutura de um esquema de configuração do Hook.

```
{
    "CloudFormationConfiguration": {
        "HookConfiguration": {
            "HookInvocationStatus": "ENABLED",
            "TargetOperations": ["STACK"],
            "FailureMode": "FAIL",
            "EncryptionConfiguration": {
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abc-123"
            },
            "Properties": {
                ...
            }
        }
    }
}
```

`HookConfiguration`  <a name="hooks-hook-configuration"></a>
A configuração do gancho suporta a ativação ou desativação de ganchos no nível da pilha, nos modos de falha e nos valores das propriedades do gancho.  
A configuração do Hook suporta as seguintes propriedades.    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
Especifica se o gancho é `ENABLED` ou`DISABLED`.  
*Valores válidos*: `ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
Especifica a lista de operações nas quais o Hook é executado. Para obter mais informações, consulte [Alvos de gancho](hooks-concepts.md#hook-terms-hook-target).  
*Valores válidos*: `STACK` \$1 `RESOURCE` \$1 `CHANGE_SET` \$1 `CLOUD_CONTROL`   
`TargetStacks`  <a name="hooks-targetstacks"></a>
*Disponível para compatibilidade com versões anteriores. Use `HookInvocationStatus` em vez disso.*  
Se o modo estiver definido como`ALL`, o Hook se aplica a todas as pilhas da sua conta durante uma operação de `CREATE``UPDATE`,, ou `DELETE` recurso.  
Se o modo estiver definido como`NONE`, o Hook não se aplicará às pilhas da sua conta.  
*Valores válidos*: `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
Esse campo informa ao serviço como tratar as falhas do Hook.  
+ Se o modo estiver definido como e o Hook falhar, a configuração de falha interromperá o provisionamento de recursos e reverterá a pilha. `FAIL`
+ Se o modo estiver definido como `WARN` e o Hook falhar, a configuração de aviso permitirá que o provisionamento continue com uma mensagem de aviso.
*Valores válidos*: `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
Especifica as configurações de criptografia para dados de anotações do Hook.    
`KmsKeyId`  
O alias, o ARN do alias, o ID da chave ou o ARN da chave de criptografia AWS KMS simétrica usada para criptografar os dados das anotações do Hook. Para obter mais informações, consulte [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)nos AWS KMS documentos.  
Antes de criar Hooks com AWS KMS chaves gerenciadas pelo cliente, seu usuário ou função deve ter AWS KMS permissões para `DescribeKey` e. `GenerateDataKey` Para obter mais informações, consulte [AWS KMS principais políticas e permissões para criptografar resultados de CloudFormation Hooks em repouso](hooks-kms-key-policy.md).   
`Properties`  <a name="hooks-properties"></a>
Especifica as propriedades de tempo de execução do Hook. Eles devem corresponder à forma das propriedades suportadas pelo esquema Hooks.

## Exemplos de configuração de ganchos
<a name="hook-configuration-examples"></a>

Para obter exemplos de configuração de Hooks a partir do AWS CLI, consulte as seções a seguir:
+ [Ative um Hook proativo baseado em controle ()AWS CLI](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [Ativar um gancho de proteção (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [Ativar um gancho Lambda ()AWS CLI](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)