翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# フック設定スキーマ構文リファレンス
<a name="hook-configuration-schema"></a>

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

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

**Topics**
+ [フック設定スキーマのプロパティ](#hook-configuration-schema-properties)
+ [フック設定の例](#hook-configuration-examples)
+ [CloudFormation スタックレベルのフィルターをフックします](hooks-stack-level-filtering.md)
+ [CloudFormation フックターゲットフィルター](hooks-target-filtering.md)
+ [フックターゲット名でのワイルドカードの使用](wildcard-hook-targets.md)

**注記**  
フックの設定で保存できるデータの最大量は 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`、フックは、`CREATE`、、`UPDATE`または `DELETE`リソースオペレーション中にアカウント内のすべてのスタックに適用されます。  
モードが に設定されている場合`NONE`、フックはアカウントのスタックには適用されません。  
*有効な値:* `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
このフィールドは、フック障害の処理方法をサービスに指示します。  
+ モードが に設定されていて`FAIL`、フックが失敗した場合、失敗設定はリソースのプロビジョニングを停止し、スタックをロールバックします。
+ モードが に設定`WARN`され、フックが失敗した場合、警告設定によりプロビジョニングを警告メッセージで続行できます。
*有効な値:* `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
フック注釈データの暗号化設定を指定します。    
`KmsKeyId`  
Hook 注釈データの暗号化に使用される対称暗号化キーのエイリアス、エイリアス ARN、キー ID、または AWS KMS キー 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-kms-key-policy.md)」を参照してください。  
`Properties`  <a name="hooks-properties"></a>
Hook ランタイムプロパティを指定します。これらは、フックスキーマでサポートされているプロパティの形状と一致する必要があります。

## フック設定の例
<a name="hook-configuration-examples"></a>

からフックを設定する例については AWS CLI、以下のセクションを参照してください。
+ [プロアクティブコントロールベースのフックをアクティブ化する (AWS CLI)](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [ガードフックをアクティブ化する (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)