Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Referensi sintaks skema konfigurasi hook
<a name="hook-configuration-schema"></a>

Bagian ini menguraikan sintaks skema yang digunakan untuk mengkonfigurasi Hooks. CloudFormation menggunakan skema konfigurasi ini saat runtime saat menjalankan Hook di file. Akun AWS

Untuk mengaktifkan Hook Anda secara proaktif memeriksa konfigurasi tumpukan Anda, atur `HookInvocationStatus` ke `ENABLED` setelah Hook terdaftar dan diaktifkan di akun Anda. 

**Topics**
+ [Properti skema konfigurasi kait](#hook-configuration-schema-properties)
+ [Contoh konfigurasi kait](#hook-configuration-examples)
+ [CloudFormation Filter tingkat tumpukan kait](hooks-stack-level-filtering.md)
+ [CloudFormation Filter target kait](hooks-target-filtering.md)
+ [Menggunakan wildcard dengan nama target Hook](wildcard-hook-targets.md)

**catatan**  
Jumlah maksimum data yang dapat disimpan oleh konfigurasi Hook adalah 300 KB. Ini adalah tambahan untuk semua kendala yang dikenakan pada parameter `Configuration` permintaan operasi. [https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)

## Properti skema konfigurasi kait
<a name="hook-configuration-schema-properties"></a>

Skema berikut adalah struktur untuk skema konfigurasi 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>
Konfigurasi Hook mendukung pengaktifan atau penonaktifan Hooks pada tingkat tumpukan, mode kegagalan, dan nilai properti Hook.  
Konfigurasi Hook mendukung properti berikut.    
`HookInvocationStatus`  <a name="hooks-hookinvocationstatus"></a>
Menentukan apakah Hook adalah `ENABLED` atau`DISABLED`.  
*Nilai yang valid*: `ENABLED` \$1 `DISABLED`  
`TargetOperations`  <a name="hooks-targetoperations"></a>
Menentukan daftar operasi Hook dijalankan terhadap. Untuk informasi selengkapnya, lihat [Target kait](hooks-concepts.md#hook-terms-hook-target).  
*Nilai yang valid*: `STACK` \$1 `RESOURCE` \$1 `CHANGE_SET` \$1 `CLOUD_CONTROL`   
`TargetStacks`  <a name="hooks-targetstacks"></a>
*Tersedia untuk kompatibilitas mundur. Gunakan `HookInvocationStatus` sebagai gantinya.*  
Jika mode diatur ke`ALL`, Hook berlaku untuk semua tumpukan di akun Anda selama operasi`CREATE`,`UPDATE`, atau `DELETE` sumber daya.  
Jika mode diatur ke`NONE`, Hook tidak akan berlaku untuk tumpukan di akun Anda.  
*Nilai yang valid*: `ALL` \$1 `NONE`  
`FailureMode`  <a name="hooks-failuremode"></a>
Bidang ini memberi tahu layanan bagaimana memperlakukan kegagalan Hook.  
+ Jika mode diatur ke`FAIL`, dan Hook gagal, maka konfigurasi gagal berhenti menyediakan sumber daya dan memutar kembali tumpukan.
+ Jika mode diatur ke `WARN` dan Hook gagal, maka konfigurasi peringatan memungkinkan penyediaan untuk melanjutkan dengan pesan peringatan.
*Nilai yang valid*: `FAIL` \$1 `WARN`  
`EncryptionConfiguration`  <a name="hooks-encryptionconfiguration"></a>
Menentukan pengaturan enkripsi untuk data anotasi Hook.    
`KmsKeyId`  
Alias, alias ARN, ID kunci, atau ARN kunci dari kunci enkripsi simetris yang digunakan untuk mengenkripsi data AWS KMS anotasi Hook. Untuk informasi lebih lanjut, lihat [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)di AWS KMS dokumen.  
Sebelum Anda dapat membuat Hooks dengan AWS KMS kunci yang dikelola pelanggan, pengguna atau peran Anda harus memiliki AWS KMS izin untuk `DescribeKey` dan. `GenerateDataKey` Untuk informasi selengkapnya, lihat [AWS KMS kebijakan kunci dan izin untuk mengenkripsi hasil CloudFormation Hooks saat istirahat](hooks-kms-key-policy.md).   
`Properties`  <a name="hooks-properties"></a>
Menentukan properti runtime Hook. Ini harus sesuai dengan bentuk properti yang didukung oleh skema Hooks.

## Contoh konfigurasi kait
<a name="hook-configuration-examples"></a>

Untuk contoh konfigurasi Hooks dari AWS CLI, lihat bagian berikut:
+ [Aktifkan Hook () berbasis kontrol proaktif AWS CLI](proactive-controls-hooks-activate-hooks.md#proactive-controls-hooks-activate-hooks-cli)
+ [Aktifkan Guard Hook (AWS CLI)](guard-hooks-activate-hooks.md#guard-hooks-activate-hooks-cli)
+ [Aktifkan Lambda Hook ()AWS CLI](lambda-hooks-activate-hooks.md#lambda-hooks-activate-hooks-cli)