Referensi sintaks skema konfigurasi hook - CloudFormation
Properti skema konfigurasi kaitContoh konfigurasi kait

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

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.

Topik
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. SetTypeConfiguration

Properti skema konfigurasi kait

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

Konfigurasi Hook mendukung pengaktifan atau penonaktifan Hooks pada tingkat tumpukan, mode kegagalan, dan nilai properti Hook.

Konfigurasi Hook mendukung properti berikut.

HookInvocationStatus

Menentukan apakah Hook adalah ENABLED atauDISABLED.

Nilai yang valid: ENABLED | DISABLED

TargetOperations

Menentukan daftar operasi Hook dijalankan terhadap. Untuk informasi selengkapnya, lihat Target kait.

Nilai yang valid: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL

TargetStacks

Tersedia untuk kompatibilitas mundur. Gunakan HookInvocationStatus sebagai gantinya.

Jika mode diatur keALL, Hook berlaku untuk semua tumpukan di akun Anda selama operasiCREATE,UPDATE, atau DELETE sumber daya.

Jika mode diatur keNONE, Hook tidak akan berlaku untuk tumpukan di akun Anda.

Nilai yang valid: ALL | NONE

FailureMode

Bidang ini memberi tahu layanan bagaimana memperlakukan kegagalan Hook.

  • Jika mode diatur keFAIL, 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 | WARN

EncryptionConfiguration

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 KeyIddi 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.

Properties

Menentukan properti runtime Hook. Ini harus sesuai dengan bentuk properti yang didukung oleh skema Hooks.

Contoh konfigurasi kait

Untuk contoh konfigurasi Hooks dari AWS CLI, lihat bagian berikut: