View a markdown version of this page

Validasi template dengan cfn-lint - AWS CloudFormation

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

Validasi template dengan cfn-lint

CloudFormation Linter (cfn-lint) memeriksa template JSON dan YAML terhadap skema penyedia CloudFormation sumber daya dan aturan tambahan. Ini dapat menemukan properti sumber daya yang tidak valid, nilai yang tidak didukung, dan masalah umum sebelum Anda mengirim template ke CloudFormation.

Kode sumber, catatan rilis, pengaturan, dan daftar aturan lengkap tersedia di repositori cfn-lint di. GitHub

Instal cfn-lint

Instal cfn-lint dari Indeks Paket Python (PyPI):

python3 -m pip install cfn-lint

PadamacOS, Anda dapat menginstalnya dengan Homebrew:

brew install cfn-lint

Untuk versi Python yang didukung dan metode instalasi lainnya, lihat petunjuk instalasi di GitHub.

Jalankan cfn-lint

Meneruskan satu atau lebih jalur template ke perintah:

cfn-lint template.yaml cfn-lint template-one.yaml template-two.json

Untuk memeriksa template untuk lebih dari satu Wilayah AWS, gunakan --regions opsi:

cfn-lint --regions us-east-1 us-west-2 -- template.yaml

Perintah mengembalikan kode keluar bukan nol ketika menemukan masalah. Anda dapat menggunakan perilaku ini untuk menghentikan pembuatan otomatis saat template tidak lulus pemeriksaan yang dipilih.

Konfigurasikan pemeriksaan

Gunakan .cfnlintrc.yml file.cfnlintrc,.cfnlintrc.yaml, atau untuk menyimpan pengaturan proyek dengan template Anda. Anda dapat menggunakan file ini untuk memilih templat, menyertakan atau mengabaikan pemeriksaan, memilih Wilayah AWS, dan mengonfigurasi perilaku aturan. Untuk semua pengaturan, lihat File konfigurasi di dokumentasi proyek pada GitHub.

Tambahkan cfn-lint ke alur kerja Anda

Anda dapat menjalankan cfn-lint dari editor yang didukung, secara otomatis sebelum komit Git, atau sebagai bagian dari build otomatis. Server CloudFormation Bahasa juga digunakan cfn-lint untuk menampilkan masalah saat Anda mengetik. Untuk pengaturan Server Bahasa, lihatCloudFormation Server Bahasa.

Untuk plugin editor, Tind GitHub akan, konfigurasi pra-komit, aturan khusus, dan contoh lainnya, lihat dokumentasi proyek cfn-lint di. GitHub