AWS CDK CLI referensi perintah - AWS Cloud Development Kit (AWS CDK) v2
PenggunaanCommandsOpsi globalMenyediakan dan mengonfigurasi opsiMelewati opsi di baris perintah

Ini adalah Panduan Pengembang AWS CDK v2. CDK v1 yang lebih lama memasuki pemeliharaan pada 1 Juni 2022 dan mengakhiri dukungan pada 1 Juni 2023.

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

AWS CDK CLI referensi perintah

Bagian ini berisi informasi referensi perintah untuk Antarmuka Baris AWS Cloud Development Kit (AWS CDK) Perintah (CLI). CDK CLI Juga disebut sebagai CDK Toolkit.

Penggunaan

$ cdk <command> <arguments> <options>

Commands

acknowledge, ack

Akui pemberitahuan berdasarkan nomor terbitan dan sembunyikan agar tidak ditampilkan lagi.

bootstrap

Siapkan AWS lingkungan untuk penerapan CDK dengan menyebarkan tumpukan bootstrap CDK, bernamaCDKToolkit, ke lingkungan. AWS

context

Kelola nilai konteks cache untuk aplikasi CDK Anda.

deploy

Terapkan satu atau lebih tumpukan CDK ke lingkungan Anda. AWS

destroy

Hapus satu atau beberapa tumpukan CDK dari lingkungan Anda AWS .

diff

Lakukan diff untuk melihat perubahan infrastruktur di antara tumpukan CDK.

docs, doc

Buka dokumentasi CDK di browser Anda.

doctor

Periksa dan tampilkan informasi berguna tentang proyek CDK lokal dan lingkungan pengembangan Anda.

import

Gunakan impor AWS CloudFormation sumber daya untuk mengimpor AWS sumber daya yang ada ke tumpukan CDK.

init

Buat proyek CDK baru dari template.

list, ls

Buat daftar semua tumpukan CDK dan dependensinya dari aplikasi CDK.

metadata

Tampilkan metadata yang terkait dengan tumpukan CDK.

migrate

Migrasikan AWS sumber daya, AWS CloudFormation tumpukan, dan AWS CloudFormation templat ke dalam proyek CDK baru.

notices

Tampilkan pemberitahuan untuk aplikasi CDK Anda.

synthesize, synth

Sintesis aplikasi CDK untuk menghasilkan rakitan cloud, termasuk AWS CloudFormation template untuk setiap tumpukan.

watch

Terus menonton proyek CDK lokal untuk perubahan untuk melakukan penerapan dan hotswap.

Opsi global

Opsi berikut kompatibel dengan semua CDK CLI perintah.

--app, -a STRING

Berikan perintah untuk menjalankan aplikasi atau direktori perakitan cloud Anda.

Wajib: Ya

--asset-metadata BOOLEAN

Sertakan aws:asset:* AWS CloudFormation metadata untuk sumber daya yang menggunakan aset.

Wajib: Tidak

Nilai default: true

--build STRING

Perintah untuk menjalankan build pra-sintesis.

Wajib: Tidak

--ca-bundle-path STRING

Jalur ke sertifikat CA untuk digunakan saat memvalidasi permintaan HTTPS.

Jika opsi ini tidak disediakan, CDK CLI akan membaca dari variabel AWS_CA_BUNDLE lingkungan.

Wajib: Ya

--ci BOOLEAN

Tunjukkan bahwa CDK CLI perintah sedang dijalankan dalam lingkungan integrasi berkelanjutan (CI).

Opsi ini memodifikasi perilaku CDK CLI agar lebih sesuai dengan operasi otomatis yang khas di jaringan pipa CI.

Saat Anda memberikan opsi ini, log dikirim ke stdout alih-alihstderr.

Wajib: Tidak

Nilai default: false

--context, -c ARRAY

Tambahkan parameter string kontekstual sebagai pasangan kunci-nilai.

--debug BOOLEAN

Aktifkan informasi debugging terperinci. Opsi ini menghasilkan output verbose yang mencakup lebih banyak detail tentang apa CDK CLI dilakukan di belakang layar.

Wajib: Tidak

Nilai default: false

--ec2creds, -i BOOLEAN

Paksa CDK CLI untuk mencoba dan mengambil kredensi EC2 instans Amazon.

Secara default, CDK CLI menebak status EC2 instans Amazon.

Wajib: Tidak

Nilai default: false

--help, -h BOOLEAN

Tampilkan informasi referensi perintah untuk CDK CLI.

Wajib: Tidak

Nilai default: false

--ignore-errors BOOLEAN

Abaikan kesalahan sintesis, yang kemungkinan akan menghasilkan output yang tidak valid.

Wajib: Tidak

Nilai default: false

--json, -j BOOLEAN

Gunakan JSON bukan YAMB untuk AWS CloudFormation template yang dicetak ke output standar ()stdout.

Wajib: Tidak

Nilai default: false

--lookups BOOLEAN

Lakukan pencarian konteks.

Sintesis akan gagal jika nilai ini false dan pencarian konteks perlu dilakukan.

Wajib: Tidak

Nilai default: true

--no-color BOOLEAN

Hapus warna dan gaya lainnya dari output konsol.

Wajib: Tidak

Nilai default: false

--notices BOOLEAN

Tampilkan pemberitahuan yang relevan.

Wajib: Tidak

Nilai default: false

--output, -o STRING

Tentukan direktori untuk menampilkan rakitan cloud yang disintesis ke.

Wajib: Ya

Nilai default: cdk.out

--path-metadata BOOLEAN

Sertakan aws::cdk::path AWS CloudFormation metadata untuk setiap sumber daya.

Wajib: Tidak

Nilai default: true

--plugin, -p ARRAY

Nama atau jalur dari node paket yang memperluas fitur CDK. Opsi ini dapat diberikan beberapa kali dalam satu perintah.

Anda dapat mengonfigurasi opsi ini di cdk.json file proyek atau ~/.cdk.json di mesin pengembangan lokal Anda:

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

Wajib: Tidak

--profile STRING

Tentukan nama AWS profil, yang berisi informasi AWS lingkungan Anda, untuk digunakan dengan CDK CLI.

Wajib: Ya

--proxy STRING

Gunakan proxy yang ditunjukkan.

Jika opsi ini tidak disediakan, CDK CLI akan membaca dari variabel HTTPS_PROXY lingkungan.

Wajib: Ya

Nilai default: Baca dari variabel HTTPS_PROXY lingkungan.

--role-arn, -r STRING

ARN dari peran IAM bahwa CDK CLI akan berasumsi saat berinteraksi dengan AWS CloudFormation.

Wajib: Tidak

--staging BOOLEAN

Salin aset ke direktori output.

Tentukan false untuk mencegah penyalinan aset ke direktori output. Hal ini memungkinkan AWS SAM CLI untuk mereferensikan file sumber asli saat melakukan debugging lokal.

Wajib: Tidak

Nilai default: true

--strict BOOLEAN

Jangan membuat tumpukan yang berisi peringatan.

Wajib: Tidak

Nilai default: false

--trace BOOLEAN

Cetak jejak untuk peringatan tumpukan.

Wajib: Tidak

Nilai default: false

--verbose, -v COUNT

Tampilkan log debug. Anda dapat menentukan opsi ini beberapa kali untuk meningkatkan verbositas.

Wajib: Tidak

--version BOOLEAN

Tampilkan CDK CLI nomor versi.

Wajib: Tidak

Nilai default: false

--version-reporting BOOLEAN

Sertakan AWS::CDK::Metadata sumber daya dalam AWS CloudFormation templat yang disintesis.

Wajib: Tidak

Nilai default: true

Menyediakan dan mengonfigurasi opsi

Anda dapat meneruskan opsi melalui argumen baris perintah. Untuk sebagian besar opsi, Anda dapat mengonfigurasinya dalam file cdk.json konfigurasi. Saat Anda menggunakan beberapa sumber konfigurasi, CDK CLI mematuhi prioritas berikut:

  1. Nilai baris perintah - Opsi apa pun yang disediakan pada opsi penggantian baris perintah yang dikonfigurasi dalam file. cdk.json

  2. File konfigurasi proyek — cdk.json File di direktori proyek CDK Anda.

  3. File konfigurasi pengguna — cdk.json File yang terletak ~/.cdk.json di mesin lokal Anda.

Melewati opsi di baris perintah

Melewati nilai boolean

Untuk opsi yang menerima nilai boolean, Anda dapat menentukannya dengan cara berikut:

  • Gunakan true dan false nilai - Berikan nilai boolean dengan perintah. Berikut adalah contohnya:

    $ cdk deploy --watch=true
$ cdk deploy --watch=false

  • Berikan mitra opsi - Ubah nama opsi dengan menambahkan no untuk menentukan false nilai. Berikut adalah contohnya:

    $ cdk deploy --watch
$ cdk deploy --no-watch

  • Untuk opsi yang default ke true ataufalse, Anda tidak perlu memberikan opsi kecuali Anda ingin mengubah dari default.