AWS CloudFormation server bahasa - AWS CloudFormation
IDEs Integrasi dengan server AWS CloudFormation bahasaMemulaiMenginisialisasi CloudFormation proyek di IDESumber terbukaButuh bantuan?

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

AWS CloudFormation server bahasa

Server AWS CloudFormation bahasa menyediakan kemampuan untuk mempercepat authoring infrastructure-as-code (IAc) dan menyebarkan AWS sumber daya dengan aman dan percaya diri. Ini mengikuti protokol server bahasa (LSP) untuk menyediakan dokumentasi tentang hover, pelengkapan otomatis, diagnostik melalui validasi statis, pergi ke definisi dan tindakan kode. Selain kemampuan server bahasa tradisional ini, server menambahkan fitur online untuk mengeksplorasi dan menyebarkan AWS sumber daya melalui CloudFormation. Ini termasuk kemampuan untuk memvalidasi dan menyebarkan template menggunakan set perubahan; melihat perbedaan tumpukan, peristiwa, sumber daya, dan output; daftar tumpukan dan telusuri sumber daya berdasarkan jenis; dan masukkan status sumber daya langsung langsung ke templat. CloudFormation Perkakas pengembang dan lingkungan pengembangan terintegrasi (IDE) dapat memanfaatkan kemampuan server bahasa untuk meningkatkan pengalaman pengembang IAC. CloudFormation

IDEs Integrasi dengan server AWS CloudFormation bahasa

Ekstensi AWS Toolkit mengintegrasikan server CloudFormation bahasa untuk meningkatkan pengalaman penulisan. Integrasi ini saat ini didukung dalam VS Code berbasis IDEs, termasuk:

Memulai

Prasyarat

Sebelum Anda mulai, pastikan bahwa:

  • Anda menggunakan IDE berbasis VS Code pada sistem operasi yang didukung (macOS,Windows, atauLinux).

  • Anda telah menginstal atau meningkatkan ke versi terbaru dari AWS Toolkit untuk IDE Anda.

Beberapa fitur di server AWS CloudFormation bahasa memerlukan kredensi aktif Akun AWS dan dikonfigurasi. Anda harus masuk ke Anda Akun AWS melalui AWS Toolkit menggunakan kredensil yang valid.

Langkah 1: Instal atau tingkatkan AWS Toolkit

  • Buka Ekstensi IDE atau Pengelola Plugin Anda.

  • Cari AWS Toolkit.

  • Instal atau perbarui ke versi 3.85.0 atau yang lebih baru dari AWS Toolkit untuk IDE Anda.

  • Mulai ulang IDE Anda setelah instalasi.

Catatan: Setelah instalasi, AWS Toolkit secara otomatis mengaktifkan dukungan CloudFormation IDE. Saat pertama kali menginstal atau memutakhirkan AWS Toolkit dengan ekstensi server AWS CloudFormation bahasa, Anda diminta untuk memberikan izin AWS untuk mengumpulkan data penggunaan anonim. Data ini membantu AWS meningkatkan server CloudFormation bahasa dan meningkatkan pengalaman penulisan. Tidak ada informasi sensitif yang dikumpulkan dan AWS tidak merekam atau menyimpan konten templat, konfigurasi sumber daya, atau data pelanggan yang dapat diidentifikasi. Anda dapat mengubah preferensi telemetri kapan saja dari pengaturan IDE. Data penggunaan yang dikumpulkan hanya berfokus pada interaksi fitur dan metrik kinerja. Wawasan ini membantu AWS mengidentifikasi dan memprioritaskan peningkatan seperti validasi yang lebih cepat, pelengkapan otomatis yang disempurnakan, dan diagnostik kesalahan yang lebih baik.

Langkah 2: Akses CloudFormation di panel AWS Toolkit

Di IDE Anda, buka panel AWS Toolkit dari bilah aktivitas. Di bawah AWS Toolkit, pilih CLOUDFORMATION.

Bagian panel:

  • Wilayah: Menampilkan arus Wilayah AWS. Anda dapat mengubahnya dengan memilih nama Region atau dengan menggunakan AWS CloudFormation: Pilih Region perintah dari palet perintah.

  • Lingkungan: Menunjukkan lingkungan yang Anda pilih selama CFN init (misalnya, dev, test, atau prod). Nilai ini muncul hanya setelah menyelesaikan langkah pemilihan lingkungan.

  • Tumpukan: Menampilkan daftar CloudFormation tumpukan paginasi di akun Anda.

    • Klik pada ikon refresh untuk memperbarui daftar tumpukan.

    • Gunakan ikon + untuk menyebarkan template baru sebagai tumpukan.

    • Setiap entri tumpukan meliputi:

      • Ikhtisar: Menampilkan ringkasan tumpukan dan status

      • ID tumpukan

      • Deskripsi

      • Waktu yang dibuat dan Waktu yang diperbarui

      • Alasan Status dan Status

      • Acara, Output, dan Sumber Daya

    • Ubah set

  • Sumber Daya: Setelah Anda memilih jenis sumber daya, panel akan menampilkan AWS sumber daya dari jenis itu di akun Anda. Anda dapat melihat, menyegarkan, menyalin, atau mengimpornya ke template Anda.

Langkah 3: Validasi, uji, dan perbaiki template Anda

Saat Anda menulis CloudFormation template Anda, IDE menyediakan bantuan penulisan cerdas untuk membantu Anda membuat infrastruktur yang akurat dan sesuai dengan lebih cepat. Server CloudFormation bahasa berjalan di latar belakang dan menyediakan fitur authoring berikut:

  • Penyelesaian kode: Menyarankan jenis sumber daya, parameter, dan properti berdasarkan CloudFormation skema.

  • Tambahkan AWS sumber daya yang ada: Memungkinkan Anda mengimpor sumber daya yang ada dari template Anda Akun AWS ke dalam template Anda. IDE menggunakan AWS Cloud Control API (CCAPI) untuk mengambil konfigurasi langsung dan properti sumber daya, membantu Anda mengkloning atau menggunakan kembali infrastruktur yang ada dalam template Anda.

Untuk menambahkan sumber daya ke template Anda

  • Perluas panel CloudFormation Resources: Di panel samping AWS Toolkit, perluas CloudFormation, lalu di bawah Resources, klik ikon Add +.

  • Cari jenis sumber daya: Untuk menemukan jenis AWS sumber daya tertentu, di bilah pencarian ketik jenis AWS sumber daya tertentu yang ingin Anda tambahkan. Contoh:

    • AWS::S3::Bucket

    • AWS::Lambda::Function

    Anda dapat memilih jenis sumber daya menggunakan AWS CloudFormation: Tambahkan Jenis Sumber Daya di palet perintah.

  • Menambahkan resource ke template Anda: Di bawah panel Resources, daftar paginasi AWS sumber daya yang terdeteksi di akun Anda akan ditampilkan. Jika Anda memiliki banyak sumber daya, hanya halaman pertama yang ditampilkan. Gunakan kontrol navigasi di bagian bawah panel untuk menelusuri halaman tambahan dan melihat semua sumber daya yang tersedia.

  • Pilih sumber daya yang ingin Anda sertakan dalam template Anda.

  • Anda dapat menyisipkan sumber daya ke dalam template Anda dengan dua cara, tergantung pada tujuan Anda:

    • Mengkloning sumber daya yang ada: Buat sumber daya baru di template Anda menggunakan konfigurasi langsung dan properti AWS sumber daya yang ada.

    • Impor sumber daya yang ada: Masukkan sumber daya aktual ke tumpukan Anda dengan menambahkannya ke template Anda menggunakan status langsungnya.

Kiat

  • Anda dapat menyegarkan panel Sumber daya kapan saja untuk melihat daftar sumber daya terbaru yang tersedia di akun atau Wilayah Anda.

  • Jika Anda mengimpor sumber daya, jangan menambahkan sumber daya yang sudah menjadi milik CloudFormation tumpukan yang ada di akun yang sama.

  • Untuk mengonfirmasi apakah sumber daya sudah dikelola oleh CloudFormation, klik ikon i (informasi) di sebelah nama sumber daya.

  • Atau, Anda dapat menggunakan perintah AWS CloudFormation: Dapatkan Info Manajemen Stack untuk memeriksa apakah sumber daya milik tumpukan.

Anda dapat menambahkan sumber daya terkait ke sumber daya yang dipilih dengan menggunakan perintah AWS CloudFormation: Tambahkan Sumber Daya Terkait menurut Jenis. Setelah Anda memilih jenis sumber daya dari yang sudah ditentukan dalam template Anda, IDE menampilkan daftar sumber daya yang biasanya terkait dengan atau bergantung pada jenis itu. Misalnya, jika Anda memilihAWS::EC2::Instance, IDE mungkin menyarankan untuk menambahkan sumber daya terkait seperti AWS::EC2::SecurityGroup atauAWS::EC2::Subnet. Fitur ini membantu Anda membangun komponen infrastruktur yang terhubung dengan cepat tanpa mencari jenis sumber daya yang kompatibel secara manual.

Validasi statis

CloudFormation IDE menyediakan validasi statis bawaan yang didukung oleh AWS CloudFormation Linter (cfn-lint) dan. AWS CloudFormation Guard Validasi ini berjalan di belakang layar saat Anda membuat templat, membantu Anda mengidentifikasi kesalahan sintaks, kesenjangan kepatuhan, dan masalah praktik terbaik sebelum penerapan.

Ikhtisar validasi statis

Anda akan melihat dua jenis validasi statis real-time di IDE:

  • CloudFormation Linter (cfn-lint): Memvalidasi template Anda terhadap spesifikasi CloudFormation sumber daya dan aturan skema.

  • Guard (cfn-guard): Memvalidasi template Anda terhadap aturan kepatuhan dan paket kebijakan organisasi.

CloudFormation Linter (cfn-serat)

CloudFormation Linter terintegrasi ke dalam IDE untuk secara otomatis memeriksa sintaks dan struktur template Anda saat Anda mengetik.

  • Validasi skema: Mendeteksi kesalahan sintaks dan skema untuk memastikan templat Anda sesuai dengan skema sumber daya. CloudFormation

  • Penyorotan kesalahan: Menampilkan garis berlekuk-lekuk merah atau kuning di bawah masalah, mewakili pemblokir penerapan atau peringatan.

  • Arahkan kursor ke bantuan: Saat Anda mengarahkan kursor ke kesalahan, IDE akan menampilkan pesan diagnostik yang terkait dengan masalah tersebut. Jika perbaikan cepat tersedia, itu juga akan ditawarkan di panel hover.

Integrasi penjaga

Guard memvalidasi template Anda terhadap set aturan yang menentukan kepatuhan dan kebijakan keamanan. IDE menjalankan validasi Guard secara real time melalui server CloudFormation bahasa, memberi Anda umpan balik langsung saat Anda membuat templat.

  • Paket aturan default: IDE menyertakan seperangkat aturan Penjaga yang telah terdaftar sebelumnya yang berfokus pada praktik terbaik dasar untuk keamanan sumber daya dan kebersihan konfigurasi. Untuk mempelajari lebih lanjut tautan ke registri aturan penjaga.

  • Menambahkan paket aturan: Untuk menambah atau mengubah set aturan, buka Pengaturan, Pelindung, dan pilih atau unggah paket aturan Penjaga tambahan.

Tips: Memahami indikator garis berlekuk-lekuk

  • Coretan biru: Petunjuk praktik terbaik atau rekomendasi pengoptimalan.

  • Coretan kuning: Peringatan untuk masalah non-pemblokiran (misalnya, tag atau parameter yang hilang).

  • Coretan merah: Pemblokir penerapan seperti nama properti yang tidak valid, bidang wajib yang hilang, atau ketidakcocokan skema.

Langkah 4: Arahkan melalui template

Ketika Anda mengklik file template di Explorer, panel Outline secara otomatis menampilkan tampilan hierarkis terstruktur dari template Anda CloudFormation . Ini mengatur template menjadi beberapa bagian sepertiParameters,,, dan Resources OutputsMappings, dan menunjukkan setiap jenis sumber daya dan ID logis. Ini memudahkan untuk menemukan dan menavigasi dengan cepat ke sumber daya atau parameter tertentu dalam templat besar.

Anda dapat menggunakan Go to Definition untuk fungsi intrinsik seperti GetAtt danRef, memungkinkan Anda untuk melompat langsung ke sumber daya atau parameter yang direferensikan di template Anda. Ini membantu Anda melacak dependensi, memahami hubungan sumber daya, dan melakukan pengeditan dengan lebih efisien.

Langkah 5: Validasi dan terapkan

Saat Anda siap untuk menerapkan CloudFormation template Anda, buka palet perintah dan jalankan AWS CloudFormation: Validate and Deploy. Perintah memvalidasi template Anda, dan jika tidak ada kesalahan pemblokiran yang ditemukan, itu berlanjut ke fase penerapan. Sebelum mengonfirmasi, IDE menampilkan ringkasan set perubahan sadar drift dan tampilan diff sehingga Anda dapat meninjau semua perubahan yang diusulkan.

Bagaimana validasi bekerja

IDE secara otomatis melakukan pemeriksaan validasi sebelum penerapan dan memvalidasi template Anda terhadap penyebab kegagalan umum, termasuk:

  • Ketidakcocokan sintaks properti atau skema tidak valid: Masalah ini biasanya tertangkap cfn-lint selama penulisan, tetapi jika pengguna melanjutkan untuk menerapkan tanpa mengatasinya, CloudFormation validasi waktu penerapan akan memunculkan kesalahan yang sama sebelum tumpukan dibuat atau diperbarui.

  • Nama sumber daya bertentangan dengan sumber daya yang ada di akun Anda.

  • Kendala khusus layanan, seperti konflik nama bucket S3 atau enkripsi yang hilang.

Jika validasi mendeteksi kesalahan, IDE menyoroti masalah secara langsung di template Anda menggunakan garis berlekuk-lekuk merah atau kuning dan mencantumkan kesalahan di panel MASALAH. Setiap masalah mencakup properti atau sumber daya tertentu yang menyebabkan kegagalan, bersama dengan perbaikan yang disarankan. Jika tidak ada kesalahan pemblokiran, Anda dapat melanjutkan ke fase penerapan.

Jika peringatan ditemukan (masalah non-pemblokiran), dialog akan muncul yang memungkinkan Anda untuk melanjutkan penerapan atau membatalkan dan melakukan koreksi.

IDE membuka set perubahan sadar drift yang menampilkan perbedaan antara template Anda saat ini dan konfigurasi tumpukan yang diterapkan. Ini memungkinkan Anda untuk meninjau, mengonfirmasi, atau membatalkan set perubahan sebelum eksekusi.

Catatan: Set perubahan sadar drift meningkatkan proses CloudFormation penerapan dengan memungkinkan Anda menangani tumpukan drift dengan aman. Stack drift terjadi ketika status sumber daya Anda yang sebenarnya berbeda dari apa yang didefinisikan dalam CloudFormation template Anda, seringkali karena perubahan manual yang dilakukan melalui, CLI Konsol Manajemen AWS, atau SDK. CloudFormationset perubahan sadar drift membandingkan konfigurasi tumpukan yang diproses dengan status sumber daya langsung, dan IDE memunculkan perbedaan ini sehingga Anda dapat mengembalikan sumber daya ke kepatuhan sebelum penerapan.

Lihat acara tumpukan

Saat penerapan dimulai, Anda dapat menavigasi ke CloudFormationtab di panel untuk memantau kemajuan secara real time. Di bawah Stack Events, Anda akan melihat daftar operasi yang dilakukan selama penerapan. Setiap acara mencakup detail seperti:

  • Timestamp: Waktu peristiwa terjadi

  • Sumber daya: AWS Sumber daya spesifik yang dibuat, diperbarui, atau dihapus

  • Status: Keadaan operasi saat ini (misalnya,, CREATE_IN_PROGRESSUPDATE_COMPLETE, atauROLLBACK_IN_PROGRESS)

  • Alasan: Konteks tambahan atau pesan kesalahan, jika berlaku

Anda juga dapat melihat Sumber Daya dan Output tumpukan dari panel ini. Jika Anda ingin membuka tumpukan di Konsol Manajemen AWS, gunakan ikon tautan eksternal di sebelah nama tumpukan. Tampilan Stack Events membantu Anda melacak kemajuan penerapan, mengidentifikasi potensi masalah, dan mengonfirmasi kapan tumpukan Anda berhasil diselesaikan.

Menginisialisasi CloudFormation proyek di IDE

Menginisialisasi CloudFormation proyek di IDE membantu Anda menyiapkan ruang kerja terstruktur dengan folder, konfigurasi lingkungan, dan AWS kredensil yang benar sehingga Anda dapat memvalidasi dan menerapkan templat dengan andal. Anda dapat menginisialisasi CloudFormation proyek baru langsung dari IDE untuk membuat pengaturan yang direkomendasikan ini.

Untuk menginisialisasi CloudFormation proyek:

  • Buka palet perintah

    • Dari IDE Anda, buka palet perintah (Ctrl+Shift+Patau Cmd+Shift+P aktifmacOS).

    • Pilih AWS CloudFormation: CFN Init: Inisialisasi Proyek.

  • Pilih direktori proyek

    • Secara default, IDE menggunakan direktori kerja Anda saat ini.

    • Anda dapat mengubah jalur ini ke folder mana pun tempat Anda ingin menyimpan CloudFormation templat Anda.

  • Pilih profil AWS kredensialnya

    • Anda akan diminta untuk memilih profil AWS kredensi. Profil yang dipilih akan digunakan untuk deteksi lingkungan, validasi, dan penerapan.

  • Siapkan lingkungan Anda

    • Anda akan diminta untuk membuat atau memilih lingkungan.

    • Lingkungan menentukan di mana dan bagaimana template Anda akan digunakan atau divalidasi (misalnya, dev, beta, atau produksi). Anda dapat menggunakan AWS CloudFormation: CFN Init: Add Environment untuk memilih atau mengubah lingkungan Anda.

    • Anda dapat menggunakan AWS CloudFormation: CFN Init: Hapus Lingkungan untuk menghapus lingkungan yang telah Anda pilih.

  • (Opsional) Impor file parameter

    • Jika Anda sudah memiliki file parameter yang ada, IDE memungkinkan Anda untuk mengimpornya selama inisialisasi.

    • IDE secara otomatis mendeteksi file yang kompatibel dan menautkannya ke proyek Anda untuk digunakan dalam validasi dan penerapan templat.

  • Beri nama dan selesaikan proyek

    • Berikan nama proyek, seperti beta-environment, dan selesaikan pengaturannya.

    • IDE membuat struktur proyek awal dan file konfigurasi untuk Anda.

Anda dapat menjalankan validasi, pratinjau penerapan, atau beralih antar lingkungan langsung dari IDE.

Sumber terbuka

Server AWS CloudFormation bahasa bersumber terbuka di bawah Apache-2.0 Lisensi, memberikan transparansi penuh kepada pelanggan tentang bagaimana diagnostik templat, validasi skema, dan analisis statis dilakukan. Ini mengurangi gesekan keamanan dan kepatuhan bagi pelanggan yang membutuhkan visibilitas tingkat sumber sebelum mengadopsi perkakas.

Basis kode tersedia untuk umum di GitHub: https://github.com/aws-cloudformation/cloudformation-languageserver/.

Butuh bantuan?

Coba CloudFormationkomunitas di AWS re:Post.