Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Référence syntaxique du schéma de configuration Hook
<a name="hook-configuration-schema"></a>

Cette section décrit la syntaxe du schéma utilisée pour configurer les Hooks. CloudFormation utilise ce schéma de configuration au moment de l'exécution lors de l'appel d'un Hook dans un Compte AWS. 

Pour permettre à votre Hook d'inspecter de manière proactive la configuration de votre stack, définissez le paramètre sur `HookInvocationStatus` une `ENABLED` fois que le Hook a été enregistré et activé dans votre compte. 

**Topics**
+ [Propriétés du schéma de configuration des crochets](#hook-configuration-schema-properties)
+ [Exemples de configuration de crochets](#hook-configuration-examples)
+ [CloudFormation Filtres de niveau Hooks Stack](hooks-stack-level-filtering.md)
+ [CloudFormation Filtres cibles Hooks](hooks-target-filtering.md)
+ [Utilisation de caractères génériques avec les noms de cibles Hook](wildcard-hook-targets.md)

**Note**  
La quantité maximale de données que la configuration d'un Hook peut stocker est de 300 Ko. Cela s'ajoute à toutes les contraintes imposées sur le paramètre de [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)fonctionnement de la `Configuration` demande.

## Propriétés du schéma de configuration des crochets
<a name="hook-configuration-schema-properties"></a>

Le schéma suivant est la structure d'un schéma de configuration 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>
La configuration des crochets prend en charge l'activation ou la désactivation des crochets au niveau de la pile, des modes de défaillance et des valeurs des propriétés des crochets.  
La configuration Hook prend en charge les propriétés suivantes.    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
Spécifie si le Hook est `ENABLED` ou`DISABLED`.  
*Valeurs valides* : `ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
Spécifie la liste des opérations sur lesquelles le Hook est exécuté. Pour de plus amples informations, veuillez consulter [Crochet et cibles](hooks-concepts.md#hook-terms-hook-target).  
*Valeurs valides* : `STACK` \$1 `RESOURCE` \$1 `CHANGE_SET` \$1 `CLOUD_CONTROL`   
`TargetStacks`  <a name="hooks-targetstacks"></a>
*Disponible à des fins de rétrocompatibilité. Utilisez `HookInvocationStatus` plutôt.*  
Si le mode est défini sur`ALL`, le Hook s'applique à toutes les piles de votre compte lors d'une opération `CREATE``UPDATE`, ou d'une opération sur une `DELETE` ressource.  
Si le mode est défini sur`NONE`, le Hook ne s'appliquera pas aux piles de votre compte.  
*Valeurs valides* : `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
Ce champ indique au service comment traiter les défaillances de Hook.  
+ Si le mode est défini sur et que le Hook échoue, la configuration d'échec arrête le provisionnement des ressources et annule la pile. `FAIL`
+ Si le mode est défini sur `WARN` et que le Hook échoue, la configuration d'avertissement permet de poursuivre le provisionnement avec un message d'avertissement.
*Valeurs valides* : `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
Spécifie les paramètres de chiffrement pour les données d'annotations Hook.    
`KmsKeyId`  
L'alias, l'alias ARN, l'ID de clé ou l'ARN de la clé de chiffrement AWS KMS symétrique utilisée pour chiffrer les données d'annotations Hook. Pour plus d'informations, consultez [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)la AWS KMS documentation.  
Avant de pouvoir créer des Hooks avec des AWS KMS clés gérées par le client, votre utilisateur ou votre rôle doit disposer AWS KMS des autorisations nécessaires pour `DescribeKey` et`GenerateDataKey`. Pour de plus amples informations, veuillez consulter [AWS KMS politique clé et autorisations pour chiffrer les résultats de CloudFormation Hooks au repos](hooks-kms-key-policy.md).   
`Properties`  <a name="hooks-properties"></a>
Spécifie les propriétés d'exécution de Hook. Elles doivent correspondre à la forme des propriétés prises en charge par le schéma Hooks.

## Exemples de configuration de crochets
<a name="hook-configuration-examples"></a>

Pour des exemples de configuration de Hooks depuis le AWS CLI, consultez les sections suivantes :
+ [Activez un Hook basé sur le contrôle proactif ()AWS CLI](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [Activer un crochet de protection (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [Activer un crochet Lambda ()AWS CLI](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)