

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# Riferimento alla sintassi dello schema di configurazione dell’hook
<a name="hook-configuration-schema"></a>

Questa sezione descrive la sintassi dello schema utilizzata per configurare gli Hooks. CloudFormation utilizza questo schema di configurazione in fase di esecuzione quando richiama un Hook in un. Account AWS

Per consentire a Hook di ispezionare in modo proattivo la configurazione dello stack, imposta su `ENABLED` dopo che l'`HookInvocationStatus`Hook è stato registrato e attivato nel tuo account. 

**Topics**
+ [Proprietà dello schema di configurazione Hook](#hook-configuration-schema-properties)
+ [Esempi di configurazione Hook](#hook-configuration-examples)
+ [CloudFormation Filtri Hooks Stack Level](hooks-stack-level-filtering.md)
+ [CloudFormation Aggancia i filtri target](hooks-target-filtering.md)
+ [Usare i caratteri jolly con i nomi degli obiettivi di Hook](wildcard-hook-targets.md)

**Nota**  
La quantità massima di dati che la configurazione di un Hook può memorizzare è di 300 KB. Questo si aggiunge a tutti i vincoli imposti al parametro di funzionamento della `Configuration` [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)richiesta.

## Proprietà dello schema di configurazione Hook
<a name="hook-configuration-schema-properties"></a>

Lo schema seguente è la struttura di uno schema di configurazione 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 configurazione Hook supporta l'attivazione o la disattivazione degli Hook a livello di stack, le modalità di errore e i valori delle proprietà Hook.  
La configurazione Hook supporta le seguenti proprietà.    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
Specifica se l'Hook è `ENABLED` o`DISABLED`.  
*Valori validi*: `ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
Specifica l'elenco delle operazioni su cui viene eseguito l'Hook. Per ulteriori informazioni, consulta [Obiettivi Hook](hooks-concepts.md#hook-terms-hook-target).  
*Valori validi*: `STACK` \$1 `RESOURCE` \$1 `CHANGE_SET` \$1 `CLOUD_CONTROL`   
`TargetStacks`  <a name="hooks-targetstacks"></a>
*Disponibile per la compatibilità con le versioni precedenti. Usa `HookInvocationStatus` invece.*  
Se la modalità è impostata su`ALL`, l'Hook si applica a tutti gli stack dell'account durante un'operazione su `CREATE``UPDATE`, o su una `DELETE` risorsa.  
Se la modalità è impostata su`NONE`, l'Hook non si applicherà agli stack del tuo account.  
*Valori validi*: `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
Questo campo indica al servizio come trattare gli errori di Hook.  
+ Se la modalità è impostata su e l'Hook fallisce, la configurazione di errore interrompe il provisioning delle risorse e ripristina lo stack. `FAIL`
+ Se la modalità è impostata su `WARN` e l'Hook fallisce, la configurazione warn consente di continuare il provisioning con un messaggio di avviso.
*Valori validi*: `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
Specifica le impostazioni di crittografia per i dati delle annotazioni Hook.    
`KmsKeyId`  
L'alias, l'alias ARN, l'ID della chiave o l'ARN della chiave di crittografia AWS KMS simmetrica utilizzata per crittografare i dati delle annotazioni Hook. Per ulteriori informazioni, consulta i documenti. [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) AWS KMS   
Prima di poter creare Hooks con AWS KMS chiavi gestite dal cliente, l'utente o il ruolo deve disporre AWS KMS delle autorizzazioni per e. `DescribeKey` `GenerateDataKey` Per ulteriori informazioni, consulta [AWS KMS policy chiave e autorizzazioni per la crittografia dei risultati di CloudFormation Hooks a riposo](hooks-kms-key-policy.md).   
`Properties`  <a name="hooks-properties"></a>
Specifica le proprietà di runtime di Hook. Queste devono corrispondere alla forma delle proprietà supportate dallo schema Hooks.

## Esempi di configurazione Hook
<a name="hook-configuration-examples"></a>

Per esempi di configurazione di Hooks da AWS CLI, consulta le seguenti sezioni:
+ [Attiva un Hook basato su un controllo proattivo ()AWS CLI](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [Attiva un Guard Hook (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [Attiva un Lambda Hook ()AWS CLI](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)