勾點組態結構描述語法參考 - CloudFormation
勾點組態結構描述屬性勾點組態範例

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

勾點組態結構描述語法參考

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

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

主題
注意

Hook 組態可存放的最大資料量為 300 KB。這是對 SetTypeConfiguration操作的Configuration請求參數施加的所有限制之外的。

勾點組態結構描述屬性

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

{
    "CloudFormationConfiguration": {
        "HookConfiguration": {
            "HookInvocationStatus": "ENABLED",
            "TargetOperations": ["STACK"],
            "FailureMode": "FAIL",
            "EncryptionConfiguration": {
                "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abc-123"
            },
            "Properties": {
                ...
            }
        }
    }
}
HookConfiguration

勾點組態支援在堆疊層級、失敗模式和勾點屬性值啟用或停用勾點。

勾點組態支援下列屬性。

HookInvocationStatus

指定勾點是 ENABLED還是 DISABLED。

有效值：ENABLED | DISABLED

TargetOperations

指定要執行勾點的操作清單。如需詳細資訊，請參閱掛鉤目標。

有效值：STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

TargetStacks

可用於回溯相容性。請HookInvocationStatus改用 。

如果模式設定為 ALL，勾點會在 UPDATE、 CREATE或 DELETE 資源操作期間套用至您帳戶中的所有堆疊。

如果模式設定為 NONE，則勾點不會套用至您帳戶中的堆疊。

有效值：ALL | NONE

FailureMode

此欄位會告知服務如何處理勾點故障。

  • 如果模式設定為 FAIL，且勾點失敗，則失敗組態會停止佈建資源並復原堆疊。

  • 如果模式設定為 WARN且勾點失敗，則警告組態允許佈建繼續出現警告訊息。

有效值：FAIL | WARN

EncryptionConfiguration

指定勾點註釋資料的加密設定。

KmsKeyId

用於加密 Hook 註釋資料的對稱加密 AWS KMS 金鑰的別名、別名 ARN、金鑰 ID 或金鑰 ARN。如需詳細資訊，請參閱 AWS KMS 文件中的 KeyId。

在使用客戶受管 AWS KMS 金鑰建立勾點之前，您的使用者或角色必須具有 DescribeKey和 的 AWS KMS 許可GenerateDataKey。如需詳細資訊，請參閱AWS KMS 加密靜態 CloudFormation Hooks 結果的金鑰政策和許可。

Properties

指定勾點執行時間屬性。這些應符合 Hooks 結構描述支援的屬性形狀。

勾點組態範例

如需從 設定勾點的範例 AWS CLI，請參閱下列各節：