View a markdown version of this page

CloudFormation Server Bahasa - AWS CloudFormation
IDE yang terintegrasi dengan Server CloudFormation BahasaMemulaiMenginisialisasi CloudFormation proyek di IDE (hanya VS Code)Sumber terbukaPerlu bantuan?

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

CloudFormation Server Bahasa

Server AWS CloudFormation Bahasa membantu Anda menulis CloudFormation template dalam editor. Saat Anda mengetik, ini menyarankan jenis sumber daya dan properti, menunjukkan dokumentasi, menemukan kesalahan, memungkinkan Anda melompat ke definisi, dan menawarkan perbaikan untuk beberapa masalah. Menggunakan Language Server Protocol (LSP), yang memungkinkan server bekerja dengan editor yang berbeda. Memulai dan menggunakan Server Bahasa untuk fitur penulisan lokal ini tidak memerlukan kredentif Akun AWS atau AWS .

Integrasi AWS Toolkit juga menggunakan Server Bahasa untuk alur kerja online yang memanggil layanan. AWS Alur kerja ini dapat menelusuri sumber daya dan tumpukan. Mereka juga dapat menjalankan validasi template sisi layanan, menerapkan template, menunjukkan perbedaan set perubahan, dan memantau peristiwa tumpukan. Alur kerja online ini adalah satu-satunya fitur yang memerlukan AWS kredenSIAL aktif Akun AWS dan valid.

IDE yang terintegrasi dengan Server CloudFormation Bahasa

AWS menyediakan integrasi siap pakai dengan Server CloudFormation Bahasa melalui AWS Toolkit untuk IDE berikut:

IDE berikut juga mendukung Server CloudFormation Bahasa:

Untuk Visual Studio Code dan JetBrains IDE, instal AWS Toolkit. Toolkit menyertakan dan memulai Server Bahasa, jadi Anda tidak perlu mengunduh server secara terpisah.

Untuk editor lain yang mendukung LSP, unduh file untuk komputer Anda dari rilis https://github.com/aws-cloudformation/cloudformation-languageserver/releases/latest terbaru GitHub, ekstrak, dan konfigurasikan editor Anda untuk menjalankan perintah berikut:

node /path/to/install-location/cfn-lsp-server-standalone.js --stdio

Untuk Node.js versi yang didukung, unduhan yang tersedia, verifikasi file, dan contoh penyiapan untuk editor yang berbeda, lihat panduan instalasi mandiri.

Memulai

Langkah-langkah berikut menunjukkan cara menggunakan Server Bahasa melalui AWS Toolkit untuk Kode Visual Studio dan JetBrains IDE. Untuk editor lain, ikuti contoh penyiapannya di panduan instalasi mandiri.

Prasyarat

Sebelum Anda mulai, pastikan bahwa:

  • Anda menggunakan IDE yang didukung padamacOS,Windows, atauLinux.

  • Untuk Visual Studio Code atau JetBrains IDE, instal atau perbarui AWS Toolkit.

  • Untuk editor lain, instal Node.js versi yang didukung dan unduh file Server Bahasa untuk komputer Anda. Panduan instalasi mandiri mencantumkan versi dan file yang didukung.

Anda tidak memerlukan kredentif Akun AWS atau AWS untuk memulai Server Bahasa atau menggunakan fitur penulisan dan pemeriksaan templat lokalnya. Konfigurasikan AWS kredenSIAL yang valid di Toolkit hanya saat Anda menggunakan alur kerja online yang menelusuri sumber daya atau tumpukan, memanggil CloudFormation layanan, atau menyebarkan template.

Langkah 1: Instal atau tingkatkan AWS Toolkit

Instal atau perbarui ke versi terbaru AWS Toolkit dari ekstensi IDE atau pengelola plugin Anda, lalu mulai ulang IDE Anda.

Setelah instalasi, AWS Toolkit secara otomatis mengaktifkan dukungan CloudFormation IDE. Saat pertama kali menginstal atau memutakh AWS irkan Toolkit dengan Server 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 template, konfigurasi sumber daya, atau data pelanggan yang dapat diidentifikasi. Anda dapat mengubah preferensi telemetri kapan saja dari pengaturan IDE. Mulai ulang IDE agar perubahan berlaku. 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 ditingkatkan, dan diagnostik kesalahan yang lebih baik.

Langkah 2: Ak CloudFormation ses di AWS Toolkit

Setelah menginstal AWS Toolkit, buka CloudFormation panel di IDE Anda. Di VS Code, buka panel AWS Toolkit dari bilah aktivitas dan pilih CLOUD FORMATION. Di JetBrains IDE, buka jendela alat AWS Toolkit dari bilah samping dan pilih CloudFormation tab.

CloudFormation Panel berisi bagian-bagian berikut:

  • Wilayah: Menampilkan saat ini Wilayah AWS. Di VS Code, Anda dapat mengubahnya dengan memilih nama Region atau dengan menggunakan perintah AWS CloudFormation: Select Region dari palet perintah. Di JetBrains IDE, Wilayah dikonfigurasi melalui pengaturan koneksi AWS Toolkit.

  • Tumpukan: Menampilkan daftar tumpukan paginasi di CloudFormation akun Anda. Perluas tumpukan untuk melihat simpul Set Perubahan, yang mencantumkan kumpulan perubahan yang terkait dengan tumpukan itu. Gunakan tindakan View Stack Detail untuk membuka tampilan detail tumpukan, yang menampilkan ikhtisar tumpukan, peristiwa, output, dan sumber daya.

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

Di JetBrains IDE, bilah alat di atas pohon menyediakan akses cepat ke tindakan umum termasuk Validasi dan Penyebaran, Jalankan Ulang Validasi dan Penyebaran, Tambahkan Jenis Sumber Daya, dan Segarkan. Tindakan juga tersedia melalui menu konteks klik kanan pada node pohon.

Langkah 3: Validasi, uji, dan perbaiki template Anda

Saat Anda menulis CloudFormation template, Server CloudFormation Bahasa berjalan di latar belakang dan memberikan bantuan penulisan lokal tanpa AWS kredenSIAL:

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

  • Ekstrak ke parameter: Ketika kursor Anda berada pada nilai literal dalam template (misalnya, string sepertit2.micro), IDE menawarkan tindakan refactoring untuk mengekstrak nilai ke Parameters bagian dan mengganti literal dengan a !Ref ke parameter baru. Jika nilai literal yang sama muncul di beberapa tempat, Anda dapat memilih untuk mengekstrak semua kejadian sekaligus.

Toolkit juga menyediakan alur kerja online untuk menambahkan AWS sumber daya yang ada ke template Anda. Alur kerja ini memerlukan AWS kredentif yang valid dan menggunakan AWS Cloud Control API (CCAPI) untuk mengambil konfigurasi dan properti sumber daya secara langsung, membantu Anda mengkloning atau menggunakan kembali infrastruktur yang ada di dalam template Anda.

Untuk menambahkan sumber daya ke template Anda

  • Menambahkan jenis sumber daya: Di CloudFormation panel AWS Toolkit, di bawah Sumber Daya, tambahkan jenis sumber daya untuk dijelajahi. Di VS Code, klik ikon Tambah + atau gunakan perintah AWS CloudFormation: Tambahkan Jenis Sumber Daya dari palet perintah. Di JetBrains, klik tombol Tam bah Jenis Sumber Daya di bilah alat atau klik kanan simpul Resources.

  • Cari jenis sumber daya: Dalam dialog pencarian, ketik jenis AWS sumber daya yang ingin Anda tambahkan. Contoh:

    • AWS::S3::Bucket

    • AWS::Lambda::Function

  • Jelajahi sumber daya: Di bawah bagian Sumber Daya, daftar halaman sumber AWS daya yang terdeteksi di akun Anda ditampilkan. Jika Anda memiliki banyak sumber daya, hanya halaman pertama yang ditampilkan. Gunakan kontrol navigasi untuk bergerak melalui halaman tambahan dan melihat semua sumber daya yang tersedia.

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

  • Anda dapat memasukkan sumber daya ke 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 sumber AWS daya yang ada.

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

Tips

  • Anda dapat menyegarkan bagian 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 termasuk dalam tumpukan yang CloudFormation ada di akun yang sama.

  • Untuk mengonfirmasi apakah sumber daya sudah dikelola oleh CloudFormation, gunakan tindakan informasi di sebelah sumber daya. Di VS Code, klik ikon i. Di JetBrains IDE, klik kanan sumber daya dan pilih Dapatkan Info Manajemen Stack.

Di VS Code, jalankan perintah AWS CloudFormation: Add Related Resources by Type dari palet perintah. Pilih jenis sumber daya dari yang sudah ditentukan dalam template Anda. IDE mencantumkan jenis sumber daya yang dapat dirujuk oleh tipe yang dipilih melalui propertinya. Misalnya, jika Anda memilihAWS::EC2::Instance, IDE mungkin menyarankan AWS::EC2::SecurityGroup atauAWS::EC2::Subnet. Pilih satu atau beberapa jenis sumber daya terkait, lalu pilih apakah akan membuat definisi sumber daya baru atau mengimpor sumber daya yang ada. Fitur ini saat ini tidak didukung di JetBrains IDE.

Validasi statis

Server CloudFormation Bahasa menyediakan validasi statis bawaan yang didukung oleh CloudFormation Linter danCloudFormation Guard. Pemeriksaan ini berjalan secara lokal di belakang layar dan tidak memerlukan AWS kredenSIAL. Mereka 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-lint)

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

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

  • Penyorotan kesalahan: Menampilkan penanda sebaris di bawah masalah, mewakili pemblokir penerapan atau peringatan.

  • Hover help: Saat Anda mengarahkan kursor ke kesalahan, IDE menampilkan pesan diagnostik yang terkait dengan masalah itu. Jika perbaikan cepat tersedia, itu juga ditawarkan.

Integrasi penjaga

Guard memvalidasi template Anda terhadap kumpulan 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 template.

  • Paket aturan default: IDE menyertakan seperangkat aturan Guard pra-terdaftar yang berfokus pada praktik terbaik dasar untuk keamanan sumber daya dan kebersihan konfigurasi. Untuk mempelajari lebih lanjut, lihat registr i aturan penjaga.

  • Menambahkan paket aturan: Untuk menambah atau memodifikasi kumpulan aturan, buka pengaturan IDE Anda dan arahkan ke bagian konfigurasi Penjaga untuk memilih atau mengunggah paket aturan Guard tambahan.

Tips: Memahami indikator diagnostik

  • Indikator biru: Petunjuk praktik terbaik atau rekomendasi pengoptimalan.

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

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

Langkah 4: Navigasi melalui template

IDE menyediakan tampilan terstruktur dan hierarkis CloudFormation template Anda, diatur ke dalam beberapa bagian sepertiParameters,, ResourcesOutputs, danMappings, menunjukkan setiap jenis sumber daya dan ID logis. Ini membuatnya mudah untuk dengan cepat menemukan dan menavigasi ke sumber daya atau parameter tertentu dalam templat besar. Di VS Code, panel Outline di sidebar Explorer menampilkan struktur ini. Di JetBrains IDE, buka jendela Alat Struktur untuk melihat struktur template untuk file yang sedang terbuka.

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

Langkah 5: Validasi dan terapkan

Validate and De ploy adalah alur kerja online yang memanggil CloudFormation layanan dan memerlukan AWS kredenSIAL yang valid. Saat Anda siap untuk menerapkan template Anda, gunakan fitur ini untuk membuat set perubahan. IDE memvalidasi template Anda, dan jika tidak ada kesalahan pemblokiran yang ditemukan, ia melanjutkan untuk membuat set perubahan yang sadar drift. IDE kemudian menampilkan tampilan diff sehingga Anda dapat meninjau semua perubahan yang diusulkan sebelum menjalankan set perubahan.

Di VS Code, buka palet perintah dan jalankan AWS CloudFormation: Validate and Deploy. Palet perintah memandu Anda melalui pemilihan template, nama tumpukan, parameter, kemampuan, dan opsi penerapan lainnya selangkah demi selangkah. Di JetBrains IDE, gunakan tombol Validate and Deploy toolbar, klik kanan file template di editor, atau klik kanan tumpukan di pohon. JetBrains menyajikan dialog wizard tempat Anda mengonfigurasi semua opsi penerapan termasuk pemilihan template, nama tumpukan, parameter, kemampuan, tag, dan opsi lanjutan.

Cara kerja validasi

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

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

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

  • Service-specific kendala, seperti konflik nama bucket S3 atau enkripsi yang hilang.

Jika validasi mendeteksi kesalahan, IDE menyoroti masalah secara langsung di template Anda dan mencantumkan kesalahan di panel diagnostik. 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 muncul yang memungkinkan Anda melanjutkan penerapan atau membatalkan dan melakukan koreksi.

IDE membuka kumpulan perubahan drift-aware yang menampilkan perbedaan antara template Anda saat ini dan konfigurasi tumpukan yang digunakan. Ini memungkinkan Anda untuk meninjau, mengonfirmasi, atau membatalkan set perubahan sebelum eksekusi. Membatalkan penerapan akan menghapus set perubahan.

Drift-aware set perubahan meningkatkan proses CloudFormation penerapan dengan memungkinkan Anda menangani drift tumpukan dengan aman. Penyimpangan tumpukan terjadi ketika keadaan sebenarnya dari sumber daya Anda berbeda dari apa yang ditentukan dalam CloudFormation template Anda, seringkali karena perubahan manual yang dilakukan melalui Konsol Manajemen AWS, CLI, atau SDK. CloudFormation Kumpulan perubahan drift-aware membandingkan konfigurasi tumpukan yang diproses dengan status sumber daya hidup, dan IDE menampilkan perbedaan ini sehingga Anda dapat mengembalikan sumber daya ke kepatuhan sebelum penerapan.

Lihat acara tumpukan

Saat penerapan dimulai, Anda dapat memantau kemajuan secara real time dari CloudFormation panel. Di bawah Stack Events, Anda melihat daftar operasi yang dilakukan selama penerapan. Setiap acara mencakup rincian seperti:

  • Timestamp: Waktu peristiwa terjadi

  • Sumber: Sumber AWS daya tertentu yang sedang dibuat, diperbarui, atau dihapus

  • Status: Status 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. T ampilan Stack Events membantu Anda melacak kemajuan penerapan, mengidentifikasi potensi masalah, dan mengonfirmasi kapan stack Anda berhasil diselesaikan.

Menginisialisasi CloudFormation proyek di IDE (hanya VS Code)

Menginisialisasi CloudFormation proyek di IDE membantu Anda menyiapkan ruang kerja terstruktur dengan folder dan konfigurasi lingkungan yang benar untuk validasi dan penerapan sisi layanan. Alur kerja online ini memerlukan AWS kredentif, tetapi fitur penulisan lokal dan validasi statis Server Bahasa tidak. Anda dapat menginisialisasi CloudFormation proyek baru langsung dari IDE untuk membuat pengaturan yang disarankan ini. Fitur ini saat ini tersedia di VS Code saja dan tidak didukung di JetBrains IDE.

Untuk menginisialisasi CloudFormation proyek:

  • Buka palet perintah

    • Dari VS Code, 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 template Anda.

  • Pilih profil AWS kredensi Anda

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

  • Siapkan lingkungan Anda

    • Anda diminta untuk membuat atau memilih lingkungan.

    • Lingkungan menentukan di mana dan bagaimana template Anda digunakan atau divalidasi (misalnya, dev, beta, atau produksi). Anda dapat menggunakan AWS CloudFormation: CFN Init: Tambahkan Lingkungan 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 template.

  • Nama dan selesaikan proyek

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

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

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

Sumber terbuka

Server CloudFormation Bahasa bersifat open-source di bawah Apache-2.0 Lisensi, memberikan transparansi penuh kepada pelanggan tentang bagaimana diagnostik template, validasi skema, dan analisis statis dilakukan. Ini mengurangi gesekan keamanan dan kepatuhan bagi pelanggan yang memerlukan visibilitas tingkat sumber sebelum mengadopsi perkakas.

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

Perlu bantuan?

Coba CloudFormation komunitas di AWS re:Post.