フック設定スキーマ構文リファレンス

このセクションでは、フックの設定に使用されるスキーマ構文の概要を説明します。CloudFormation は、 でフックを呼び出すときに、実行時にこの設定スキーマを使用します AWS アカウント。

フックがスタックの設定をプロアクティブに検査できるようにするには、フックがアカウントに登録されてアクティブ化されたENABLED後、 を HookInvocationStatus に設定します。

トピック

• フック設定スキーマのプロパティ

• フック設定の例

• CloudFormation スタックレベルのフィルターをフックします

• CloudFormation フックターゲットフィルター

• フックターゲット名でのワイルドカードの使用

注記

フックの設定で保存できるデータの最大量は 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、フックは、CREATE、、UPDATEまたは DELETEリソースオペレーション中にアカウント内のすべてのスタックに適用されます。

モードが に設定されている場合NONE、フックはアカウントのスタックには適用されません。

有効な値: ALL | NONE

FailureMode

このフィールドは、フック障害の処理方法をサービスに指示します。

• モードが に設定されていてFAIL、フックが失敗した場合、失敗設定はリソースのプロビジョニングを停止し、スタックをロールバックします。

• モードが に設定WARNされていて、フックが失敗した場合、警告設定ではプロビジョニングを警告メッセージで続行できます。

有効な値: FAIL | WARN

EncryptionConfiguration

フック注釈データの暗号化設定を指定します。

KmsKeyId

Hook 注釈データの暗号化に使用される対称暗号化キーのエイリアス、エイリアス ARN、キー ID、または AWS KMS キー ARN。詳細については、 AWS KMS ドキュメントのKeyId」を参照してください。

カスタマーマネージド AWS KMS キーを使用してフックを作成する前に、ユーザーまたはロールに DescribeKeyおよび へのアクセス AWS KMS 許可が必要ですGenerateDataKey。詳細については、「AWS KMS キーポリシーと CloudFormation フック結果を保管中に暗号化するためのアクセス許可」を参照してください。

Properties

Hook ランタイムプロパティを指定します。これらは、フックスキーマでサポートされているプロパティの形状と一致する必要があります。

フック設定の例

からフックを設定する例については AWS CLI、以下のセクションを参照してください。

• プロアクティブコントロールベースのフックをアクティブ化する (AWS CLI)

• ガードフックをアクティブ化する (AWS CLI)

• Lambda フックをアクティブ化する (AWS CLI)