本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 勾點組態結構描述語法參考
<a name="hook-configuration-schema"></a>

本節概述用於設定勾點的結構描述語法。在 中叫用勾點時，CloudFormation 會在執行時間使用此組態結構描述 AWS 帳戶。

若要讓 Hook 主動檢查堆疊的組態，請在帳戶中註冊和啟用 Hook `HookInvocationStatus``ENABLED`之後，將 設定為 。

**Topics**
+ [勾點組態結構描述屬性](#hook-configuration-schema-properties)
+ [勾點組態範例](#hook-configuration-examples)
+ [CloudFormation 勾點堆疊層級篩選條件](hooks-stack-level-filtering.md)
+ [CloudFormation 掛鉤目標篩選條件](hooks-target-filtering.md)
+ [使用萬用字元搭配勾點目標名稱](wildcard-hook-targets.md)

**注意**  
Hook 組態可存放的最大資料量為 300 KB。這是對 [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)操作的`Configuration`請求參數施加的所有限制之外的。

## 勾點組態結構描述屬性
<a name="hook-configuration-schema-properties"></a>

下列結構描述是勾點組態結構描述的結構。

```
{
    "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>
勾點組態支援在堆疊層級、失敗模式和勾點屬性值啟用或停用勾點。  
勾點組態支援下列屬性。    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
指定勾點是 `ENABLED`還是 `DISABLED`。  
*有效值*：`ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
指定要執行勾點的操作清單。如需詳細資訊，請參閱[掛鉤目標](hooks-concepts.md#hook-terms-hook-target)。  
*有效值*：`STACK` \$1 `RESOURCE` \$1 `CHANGE_SET` \$1 `CLOUD_CONTROL`   
`TargetStacks`  <a name="hooks-targetstacks"></a>
*可用於回溯相容性。請`HookInvocationStatus`改用 。*  
如果模式設定為 `ALL`，勾點會在 `UPDATE`、 `CREATE`或 `DELETE` 資源操作期間套用至您帳戶中的所有堆疊。  
如果模式設定為 `NONE`，則勾點不會套用至您帳戶中的堆疊。  
*有效值*：`ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
此欄位會告知服務如何處理勾點故障。  
+ 如果模式設定為 `FAIL`，且勾點失敗，則失敗組態會停止佈建資源並復原堆疊。
+ 如果模式設定為 `WARN`且勾點失敗，則警告組態允許佈建繼續出現警告訊息。
*有效值*：`FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
指定勾點註釋資料的加密設定。    
`KmsKeyId`  
用於加密 Hook 註釋資料的對稱加密 AWS KMS 金鑰的別名、別名 ARN、金鑰 ID 或金鑰 ARN。如需詳細資訊，請參閱 AWS KMS 文件中的 [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)。  
在使用客戶受管 AWS KMS 金鑰建立勾點之前，您的使用者或角色必須具有 `DescribeKey`和 的 AWS KMS 許可`GenerateDataKey`。如需詳細資訊，請參閱[AWS KMS 加密靜態 CloudFormation Hooks 結果的金鑰政策和許可](hooks-kms-key-policy.md)。  
`Properties`  <a name="hooks-properties"></a>
指定勾點執行時間屬性。這些應符合 Hooks 結構描述支援的屬性形狀。

## 勾點組態範例
<a name="hook-configuration-examples"></a>

如需從 設定勾點的範例 AWS CLI，請參閱下列各節：
+ [啟用主動控制型勾點 (AWS CLI)](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [啟用 Guard Hook (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [啟用 Lambda 勾點 (AWS CLI)](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)