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 Referensi perintah CDK CLI
<a name="ref-cli-cmd"></a>

Bagian ini berisi informasi referensi perintah untuk AWS Cloud Development Kit (AWS CDK) Command Line Interface (CLI). CDK CLI juga disebut sebagai CDK Toolkit.

## Penggunaan
<a name="ref-cli-cmd-usage"></a>

```
$ cdk <command> <arguments> <options>
```

## Commands
<a name="ref-cli-cmd-commands"></a><a name="ref-cli-cmd-commands-acknowledge"></a>

 ` acknowledge ack `   
Akui pemberitahuan berdasarkan nomor terbitan dan sembunyikan agar tidak ditampilkan lagi.<a name="ref-cli-cmd-commands-bootstrap"></a>

 ` bootstrap `   
Siapkan AWS lingkungan untuk penerapan CDK dengan menyebarkan tumpukan bootstrap CDK, bernama`CDKToolkit`, ke lingkungan. AWS <a name="ref-cli-cmd-commands-context"></a>

 ` context `   
Kelola nilai konteks cache untuk aplikasi CDK Anda.<a name="ref-cli-cmd-commands-deploy"></a>

 ` deploy `   
Terapkan satu atau lebih tumpukan CDK ke lingkungan Anda. AWS <a name="ref-cli-cmd-commands-destroy"></a>

 ` destroy `   
Hapus satu atau beberapa tumpukan CDK dari lingkungan Anda AWS .<a name="ref-cli-cmd-commands-diff"></a>

 ` diff `   
Lakukan diff untuk melihat perubahan infrastruktur di antara tumpukan CDK.<a name="ref-cli-cmd-commands-docs"></a>

 ` docs doc `   
Buka dokumentasi CDK di browser Anda.<a name="ref-cli-cmd-commands-doctor"></a>

 ` doctor `   
Periksa dan tampilkan informasi berguna tentang proyek CDK lokal dan lingkungan pengembangan Anda.<a name="ref-cli-cmd-commands-drift"></a>

 ` drift `   
Deteksi penyimpangan konfigurasi untuk sumber daya yang Anda tentukan, kelola, dan terapkan menggunakan CDK.<a name="ref-cli-cmd-commands-flags"></a>

 ` flags `   
Lihat dan ubah konfigurasi flag fitur Anda untuk CDK CLI.<a name="ref-cli-cmd-commands-import"></a>

 ` import `   
Gunakan impor AWS CloudFormation sumber daya untuk mengimpor AWS sumber daya yang ada ke tumpukan CDK.<a name="ref-cli-cmd-commands-init"></a>

 ` init `   
Buat proyek CDK baru dari template.<a name="ref-cli-cmd-commands-list"></a>

 ` list, ls `   
Buat daftar semua tumpukan CDK dan dependensinya dari aplikasi CDK.<a name="ref-cli-cmd-commands-metadata"></a>

 ` metadata `   
Tampilkan metadata yang terkait dengan tumpukan CDK.<a name="ref-cli-cmd-commands-migrate"></a>

 ` migrate `   
Migrasikan AWS sumber daya, AWS CloudFormation tumpukan, dan AWS CloudFormation templat ke dalam proyek CDK baru.<a name="ref-cli-cmd-commands-notices"></a>

 ` notices `   
Tampilkan pemberitahuan untuk aplikasi CDK Anda.<a name="ref-cli-cmd-commands-publish-assets"></a>

 ` publish-assets `   
Publikasikan aset untuk tumpukan CDK yang ditentukan ke tujuan masing-masing tanpa melakukan penerapan.<a name="ref-cli-cmd-commands-refactor"></a>

 ` refactor `   
Pertahankan sumber daya yang diterapkan saat memfaktorkan ulang kode di aplikasi CDK Anda.<a name="ref-cli-cmd-commands-synthesize"></a>

 ` synthesize, synth `   
Sintesis aplikasi CDK untuk menghasilkan rakitan cloud, termasuk AWS CloudFormation template untuk setiap tumpukan.<a name="ref-cli-cmd-commands-watch"></a>

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

## Opsi global
<a name="ref-cli-cmd-options"></a>

Opsi berikut kompatibel dengan semua perintah CDK CLI.<a name="ref-cli-cmd-options-app"></a>

 `--app, -a <STRING>`   
Berikan perintah untuk menjalankan aplikasi atau direktori perakitan cloud Anda.  
 *Wajib*: Ya<a name="ref-cli-cmd-options-asset-metadata"></a>

 `--asset-metadata <BOOLEAN>`   
Sertakan `aws:asset:*` AWS CloudFormation metadata untuk sumber daya yang menggunakan aset.  
 *Wajib*: Tidak  
 *Nilai default*: `true` <a name="ref-cli-cmd-options-build"></a>

 `--build <STRING>`   
Perintah untuk menjalankan build pra-sintesis.  
 *Wajib*: Tidak<a name="ref-cli-cmd-options-ca-bundle-path"></a>

 `--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 lingkungan`AWS_CA_BUNDLE`.  
 *Wajib*: Ya<a name="ref-cli-cmd-options-ci"></a>

 `--ci <BOOLEAN>`   
Tunjukkan bahwa perintah CDK CLI sedang dijalankan dalam lingkungan integrasi berkelanjutan (CI).  
Opsi ini memodifikasi perilaku CLI CDK agar lebih sesuai dengan operasi otomatis yang khas di saluran pipa CI.  
Saat Anda memberikan opsi ini, log dikirim ke `stdout` alih-alih`stderr`.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-context"></a>

 `--context, -c <ARRAY>`   
Tambahkan parameter string kontekstual sebagai pasangan kunci-nilai.<a name="ref-cli-cmd-options-debug"></a>

 `--debug <BOOLEAN>`   
Aktifkan informasi debugging terperinci. Opsi ini menghasilkan output verbose yang mencakup lebih banyak detail tentang apa yang dilakukan CDK CLI di belakang layar.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-ec2creds"></a>

 `--ec2creds, -i <BOOLEAN>`   
Paksa CLI CDK untuk mencoba dan mengambil kredenal instans Amazon EC2.  
Secara default, CDK CLI menebak status instans Amazon EC2.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-help"></a>

 `--help, -h <BOOLEAN>`   
Tampilkan informasi referensi perintah untuk CDK CLI.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-ignore-errors"></a>

 `--ignore-errors <BOOLEAN>`   
Abaikan kesalahan sintesis, yang kemungkinan akan menghasilkan output yang tidak valid.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-json"></a>

 `--json, -j <BOOLEAN>`   
Gunakan JSON alih-alih YAMAL untuk AWS CloudFormation template yang dicetak ke output standar ()`stdout`.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-lookups"></a>

 `--lookups <BOOLEAN>`   
Lakukan pencarian konteks.  
Sintesis akan gagal jika nilai ini `false` dan pencarian konteks perlu dilakukan.  
 *Wajib*: Tidak  
 *Nilai default*: `true` <a name="ref-cli-cmd-options-no-color"></a>

 `--no-color <BOOLEAN>`   
Hapus warna dan gaya lainnya dari output konsol.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-notices"></a>

 `--notices <BOOLEAN>`   
Tampilkan pemberitahuan yang relevan.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-output"></a>

 `--output, -o <STRING>`   
Tentukan direktori untuk menampilkan rakitan cloud yang disintesis.  
 *Wajib*: Ya  
 *Nilai default*: `cdk.out` <a name="ref-cli-cmd-options-path-metadata"></a>

 `--path-metadata <BOOLEAN>`   
Sertakan `aws::cdk::path` AWS CloudFormation metadata untuk setiap sumber daya.  
 *Wajib*: Tidak  
 *Nilai default*: `true` <a name="ref-cli-cmd-options-plugin"></a>

 `--plugin, -p <ARRAY>`   
Nama atau jalur paket node 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<a name="ref-cli-cmd-options-profile"></a>

 `--profile <STRING>`   
Tentukan nama AWS profil, yang berisi informasi AWS lingkungan Anda, untuk digunakan dengan CDK CLI.  
 *Wajib*: Ya<a name="ref-cli-cmd-options-proxy"></a>

 `--proxy <STRING>`   
Gunakan proxy yang ditunjukkan.  
Jika opsi ini tidak disediakan, CDK CLI akan membaca dari variabel lingkungan`HTTPS_PROXY`.  
 *Wajib*: Ya  
 *Nilai default*: Baca dari variabel `HTTPS_PROXY` lingkungan.<a name="ref-cli-cmd-options-role-arn"></a>

 `--role-arn, -r <STRING>`   
ARN dari peran IAM yang akan diasumsikan oleh CDK CLI saat berinteraksi. AWS CloudFormation  
 *Wajib*: Tidak<a name="ref-cli-cmd-options-staging"></a>

 `--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` <a name="ref-cli-cmd-options-strict"></a>

 `--strict <BOOLEAN>`   
Jangan membuat tumpukan yang berisi peringatan.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-trace"></a>

 `--trace <BOOLEAN>`   
Cetak jejak untuk peringatan tumpukan.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-verbose"></a>

 `--verbose, -v <COUNT>`   
Tampilkan log debug. Anda dapat menentukan opsi ini beberapa kali untuk meningkatkan verbositas.  
 *Wajib*: Tidak<a name="ref-cli-cmd-options-version"></a>

 `--version <BOOLEAN>`   
Tampilkan nomor versi CDK CLI.  
 *Wajib*: Tidak  
 *Nilai default*: `false` <a name="ref-cli-cmd-options-version-reporting"></a>

 `--version-reporting <BOOLEAN>`   
Sertakan ` AWS::CDK::Metadata` sumber daya dalam AWS CloudFormation templat yang disintesis.  
 *Wajib*: Tidak  
 *Nilai default*: `true` 

## Menyediakan dan mengonfigurasi opsi
<a name="ref-cli-cmd-configure"></a>

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`

1.  **File konfigurasi proyek** — `cdk.json` File di direktori proyek CDK Anda.

1.  **File konfigurasi pengguna** — `cdk.json` File yang terletak `~/.cdk.json` di mesin lokal Anda.

## Melewati opsi di baris perintah
<a name="ref-cli-cmd-pass"></a><a name="ref-cli-cmd-pass-bool"></a>

 **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 ini adalah contohnya:

  ```
  $ cdk deploy --watch=true
  $ cdk deploy --watch=false
  ```
+ Berikan mitra opsi - Ubah nama opsi dengan menambahkan `no` untuk menentukan `false` nilai. Berikut ini adalah contohnya:

  ```
  $ cdk deploy --watch
  $ cdk deploy --no-watch
  ```
+ Untuk opsi yang default ke `true` atau`false`, Anda tidak perlu memberikan opsi kecuali Anda ingin mengubah dari default.