Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Referencia a la sintaxis del esquema de la configuración del enlace
<a name="hook-configuration-schema"></a>

En esta sección se describe la sintaxis del esquema utilizada para configurar los Hooks. CloudFormation utiliza este esquema de configuración en tiempo de ejecución al invocar un Hook en un Cuenta de AWS. 

Para que tu Hook pueda inspeccionar de forma proactiva la configuración de tu pila, configúrala una `ENABLED` vez `HookInvocationStatus` que el Hook se haya registrado y activado en tu cuenta. 

**Topics**
+ [Propiedades del esquema de configuración de ganchos](#hook-configuration-schema-properties)
+ [Ejemplos de configuración de Hook](#hook-configuration-examples)
+ [CloudFormation Filtros de nivel de pila Hooks](hooks-stack-level-filtering.md)
+ [CloudFormation Filtros de destino Hooks](hooks-target-filtering.md)
+ [Uso de caracteres comodín con nombres de objetivos de Hook](wildcard-hook-targets.md)

**nota**  
La cantidad máxima de datos que puede almacenar la configuración de un Hook es de 300 KB. Esto se suma a todas las restricciones impuestas al parámetro de [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)operación de la `Configuration` solicitud.

## Propiedades del esquema de configuración de ganchos
<a name="hook-configuration-schema-properties"></a>

El siguiente esquema es la estructura de un esquema de configuración de 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 configuración de los Hooks permite activar o desactivar los Hooks a nivel de pila, los modos de error y los valores de las propiedades del Hook.  
La configuración de Hook admite las siguientes propiedades.    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
Especifica si el Hook es `ENABLED` o`DISABLED`.  
*Valores válidos*: `ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
Especifica la lista de operaciones con las que se ejecuta el Hook. Para obtener más información, consulte [¡Gancho los objetivos](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>
*Disponible por motivos de compatibilidad con versiones anteriores. Úselo `HookInvocationStatus` en su lugar.*  
Si el modo está configurado en`ALL`, el Hook se aplica a todas las pilas de tu cuenta durante una operación `CREATE``UPDATE`, o con un `DELETE` recurso.  
Si el modo está configurado en`NONE`, el Hook no se aplicará a las acumulaciones de tu cuenta.  
*Valores válidos*: `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
Este campo indica al servicio cómo tratar los errores de Hook.  
+ Si el modo está establecido en y el Hook falla, la configuración errónea detiene el aprovisionamiento de recursos y revierte la pila. `FAIL`
+ Si el modo está establecido en `WARN` y el Hook falla, la configuración de advertencia permite que el aprovisionamiento continúe con un mensaje de advertencia.
*Valores válidos*: `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
Especifica la configuración de cifrado de los datos de las anotaciones de Hook.    
`KmsKeyId`  
El alias, el alias ARN, el ID de clave o el ARN de clave de la AWS KMS clave de cifrado simétrico utilizada para cifrar los datos de las anotaciones de Hook. Para obtener más información, consulta los documentos. [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) AWS KMS   
Para poder crear Hooks con AWS KMS claves administradas por el cliente, tu usuario o rol debe tener AWS KMS permisos para `DescribeKey` y`GenerateDataKey`. Para obtener más información, consulte [AWS KMS política clave y permisos para cifrar los resultados de CloudFormation Hooks en reposo](hooks-kms-key-policy.md).   
`Properties`  <a name="hooks-properties"></a>
Especifica las propiedades de ejecución de Hook. Deben coincidir con la forma de las propiedades admitidas por el esquema de Hooks.

## Ejemplos de configuración de Hook
<a name="hook-configuration-examples"></a>

Para ver ejemplos de cómo configurar Hooks desde AWS CLI, consulte las siguientes secciones:
+ [Activa un Hook proactivo basado en el control ()AWS CLI](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [Activa un gancho de protección (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [Activar un gancho Lambda ()AWS CLI](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)