Référence syntaxique du schéma de configuration Hook - CloudFormation
Propriétés du schéma de configuration des crochetsExemples de configuration de crochets

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

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.

Rubriques
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 SetTypeConfigurationfonctionnement de la Configuration demande.

Propriétés du schéma de configuration des crochets

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

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

Spécifie si le Hook est ENABLED ouDISABLED.

Valeurs valides : ENABLED | DISABLED

TargetOperations

Spécifie la liste des opérations sur lesquelles le Hook est exécuté. Pour de plus amples informations, veuillez consulter Crochet et cibles.

Valeurs valides : STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

TargetStacks

Disponible à des fins de rétrocompatibilité. Utilisez HookInvocationStatus plutôt.

Si le mode est défini surALL, le Hook s'applique à toutes les piles de votre compte lors d'une opération CREATEUPDATE, ou d'une opération sur une DELETE ressource.

Si le mode est défini surNONE, le Hook ne s'appliquera pas aux piles de votre compte.

Valeurs valides : ALL | NONE

FailureMode

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 | WARN

EncryptionConfiguration

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 KeyIdla 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 etGenerateDataKey. Pour de plus amples informations, veuillez consulter AWS KMS politique clé et autorisations pour chiffrer les résultats de CloudFormation Hooks au repos.

Properties

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

Pour des exemples de configuration de Hooks depuis le AWS CLI, consultez les sections suivantes :