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 CDK CLI AWS Cloud Development Kit (AWS CDK) Command Line Interface (AWS CDK CLI), juga dikenal sebagai CDK Toolkit, adalah alat utama untuk berinteraksi dengan aplikasi CDK Anda. AWS Ini mengeksekusi aplikasi Anda, menginterogasi model aplikasi yang Anda tentukan, dan menghasilkan dan menyebarkan AWS CloudFormation template yang dihasilkan oleh CDK. AWS Ini juga menyediakan fitur lain yang berguna untuk membuat dan bekerja dengan proyek AWS CDK. Topik ini berisi informasi tentang kasus penggunaan umum CDK CLI. CDK CLI diinstal dengan Manajer Paket Node. Dalam kebanyakan kasus, kami sarankan menginstalnya secara global. ``` npm install -g aws-cdk # install latest version npm install -g aws-cdk@X.YY.Z # install specific version ``` **Tip** Jika Anda secara teratur bekerja dengan beberapa versi AWS CDK, pertimbangkan untuk menginstal versi yang cocok dari CDK CLI di masing-masing proyek CDK. Untuk melakukan ini, hilangkan `-g` dari `npm install` perintah. Kemudian gunakan `npx aws-cdk` untuk memanggilnya. Ini menjalankan versi lokal jika ada, kembali ke versi global jika tidak. ## Perintah CDK CLI Semua perintah CDK CLI dimulai dengan`cdk`, yang diikuti oleh subperintah (`list`,, `synthesize``deploy`, dll.). Beberapa subperintah memiliki versi yang lebih pendek (`ls`,`synth`, dll.) yang setara. Opsi dan argumen mengikuti subperintah dalam urutan apa pun. Untuk deskripsi semua subperintah, opsi, dan argumen, lihat referensi perintah [AWS CDK CLI. ](ref-cli-cmd.md) ## Tentukan opsi dan nilainya Opsi baris perintah dimulai dengan dua tanda hubung ()`--`. Beberapa opsi yang sering digunakan memiliki sinonim huruf tunggal yang dimulai dengan tanda hubung tunggal (misalnya, `--app` memiliki sinonim`-a`). Urutan opsi dalam perintah CDK CLI tidak penting. Semua opsi menerima nilai, yang harus mengikuti nama opsi. Nilai dapat dipisahkan dari nama dengan spasi putih atau dengan tanda sama`=`. Dua opsi berikut setara. ``` --toolkit-stack-name MyBootstrapStack --toolkit-stack-name=MyBootstrapStack ``` Beberapa opsi adalah flag (Booleans). Anda dapat menentukan `true` atau `false` sebagai nilainya. Jika Anda tidak memberikan nilai, nilainya dianggap sebagai`true`. Anda juga dapat menawali nama opsi dengan `no-` menyiratkan`false`. ``` # sets staging flag to true --staging --staging=true --staging true # sets staging flag to false --no-staging --staging=false --staging false ``` Beberapa opsi, yaitu`--context`,`--parameters`,`--plugin`,`--tags`, dan`--trust`, dapat ditentukan lebih dari sekali untuk menentukan beberapa nilai. Ini dicatat sebagai memiliki ke `[array]` tik dalam bantuan CDK CLI. Contoh: ``` cdk bootstrap --tags costCenter=0123 --tags responsibleParty=jdoe ``` ## Built-in membantu CDK CLI memiliki bantuan terintegrasi. Anda dapat melihat bantuan umum tentang utilitas dan daftar subperintah yang disediakan dengan mengeluarkan: ``` cdk --help ``` Untuk melihat bantuan untuk subperintah tertentu, misalnya`deploy`, tentukan sebelum `--help` bendera. ``` cdk deploy --help ``` Masalah `cdk version` untuk menampilkan versi CDK CLI. Berikan informasi ini saat meminta dukungan. ## Pelaporan versi Untuk mendapatkan wawasan tentang bagaimana AWS CDK digunakan, konstruksi yang digunakan oleh aplikasi AWS CDK dikumpulkan dan dilaporkan dengan menggunakan sumber daya yang diidentifikasi sebagai. ` AWS::CDK::Metadata` Untuk mempelajari selengkapnya, lihat Meng [ onfigurasi pelaporan ](usage-data.md) data penggunaan AWS CDK. ## Otentikasi dengan AWS Ada berbagai cara di mana Anda dapat mengonfigurasi akses terprogram ke AWS sumber daya, tergantung pada lingkungan dan AWS akses yang tersedia untuk Anda. Untuk memilih metode otentikasi dan mengonfigurasinya untuk CLI CDK, lihat Meng [ onfigurasi kredentif keamanan untuk CLI AWS CDK. ](configure-access.md) Pendekatan yang disarankan untuk pengguna baru yang berkembang secara lokal, yang tidak diberi metode otentikasi oleh majikan mereka, adalah dengan menyiapkan Pusat Identi AWS tas IAM. Metode ini termasuk menginstal AWS CLI untuk kemudahan konfigurasi dan untuk masuk secara teratur ke portal AWS akses. Jika Anda memilih metode ini, lingkungan Anda harus berisi elemen-elemen berikut setelah Anda menyelesaikan prosedur untuk otentikasi Pusat Identitas [ IAM ](https://docs.aws.amazon.com/sdkref/latest/guide/access-sso.html) di Panduan Refer * AWS ensi SDK dan Alat: * + AWS CLI, yang Anda gunakan untuk memulai sesi portal AWS akses sebelum menjalankan aplikasi Anda. + File AWS konfigurasi [ bersama yang ](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) memiliki `[default]` profil dengan satu set nilai konfigurasi yang dapat direferensikan dari AWS CDK. Untuk menemukan lokasi file ini, lihat [ Lokasi file bersama ](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) di Panduan * Refer * AWS ensi SDK dan Alat. + `config`File bersama mengatur [ pengaturan ](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html) wilayah. Ini menetapkan Wil AWS ayah default yang digunakan AWS CDK dan CDK CLI untuk permintaan. AWS + CDK CLI menggunakan konfigurasi penyedia token [ SSO profil ](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile) untuk memperoleh kredenSIAL sebelum mengirim permintaan ke. AWS`sso_role_name`Nilai, yang merupakan peran IAM yang terhubung ke kumpulan izin Pusat Identitas IAM, harus memungkinkan akses ke AWS layanan yang digunakan dalam aplikasi Anda. `config`File contoh berikut menunjukkan profil default yang diatur dengan konfigurasi penyedia token SSO. Peng `sso_session` aturan profil mengacu pada [`sso-session` bagian bernama](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session). `sso-session`Bagian ini berisi pengaturan untuk memulai sesi portal AWS akses. ``` [default] sso_session = sso_account_id = <111122223333> sso_role_name = region = output = [sso-session ] sso_region = sso_start_url = sso_registration_scopes = sso:account:access ``` ### Mulai sebuah AWS akses sesi portal Sebelum mengakses AWS layanan, Anda memerlukan sesi portal AWS akses aktif agar CLI CDK menggunakan otentikasi Pusat Identitas IAM untuk menyelesaikan kredensional. Tergantung pada panjang sesi yang dikonfigurasi, akses Anda akhirnya akan kedaluwarsa dan CLI CDK akan mengalami kesalahan otentikasi. Jalankan perintah berikut di AWS CLI untuk masuk ke portal AWS akses. ``` aws sso login ``` Jika konfigurasi penyedia token SSO Anda menggunakan profil bernama alih-alih profil default, perintahnya adalah`aws sso login --profile `. Juga tentukan profil ini saat mengeluarkan `cdk` perintah menggunakan `--profile` opsi atau variabel `AWS_PROFILE` lingkungan. Untuk menguji apakah Anda sudah memiliki sesi aktif, jalankan perintah AWS CLI berikut. ``` aws sts get-caller-identity ``` Respons terhadap perintah ini harus melaporkan akun Pusat Identitas IAM dan kumpulan izin yang dikonfigurasi dalam `config` file bersama. **catatan** Jika Anda sudah memiliki sesi portal AWS akses aktif dan menjalankannya`aws sso login`, Anda tidak akan diminta untuk memberikan kredenSIAL. Proses masuk dapat meminta Anda untuk mengizinkan akses AWS CLI ke data Anda. Karena AWS CLI dibangun di atas SDK untuk Python, pesan izin mungkin berisi variasi `botocore` nama. ## Tentukan Wilayah dan konfigurasi lainnya CDK CLI perlu mengetahui Wil AWS ayah tempat Anda menyebarkan dan cara mengotentikasi. AWS Ini diperlukan untuk operasi penerapan dan untuk mengambil nilai konteks selama sintesis. Bersama-sama, akun dan Wilayah Anda membentuk * lingkungan*. Wilayah dapat ditentukan menggunakan variabel lingkungan atau dalam file konfigurasi. Ini adalah variabel dan file yang sama yang digunakan oleh AWS alat lain seperti AWS CLI dan berbagai AWS SDK. CDK CLI mencari informasi ini dalam urutan berikut. + Vari `AWS_DEFAULT_REGION` abel lingkungan. + Profil bernama didefinisikan dalam AWS `config` file standar dan ditentukan menggunakan `--profile` opsi pada `cdk` perintah. + `[default]`Bagian dari AWS `config` file standar. Selain menentukan AWS otentikasi dan Wilayah di `[default]` bagian, Anda juga dapat menambahkan satu atau lebih `[profile ]` bagian, di mana `` adalah nama profil. Untuk informasi selengkapnya tentang profil bernama, lihat file konfigurasi dan kredenSIAL [ bersama ](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) di Panduan * Referensi * AWS SDK dan Alat. AWS `config`File standar terletak di `~/.aws/config` (macOS/Linux) atau `%USERPROFILE%\.aws\config` (Windows). Untuk detail dan lokasi alternatif, lihat [ Lokasi file konfigurasi dan kredenSIAL bersama ](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) di Panduan Refer * AWS ensi SDK dan Alat * Lingkungan yang Anda tentukan di aplikasi AWS CDK Anda dengan menggunakan `env` properti stack digunakan selama sintesis. Ini digunakan untuk menghasilkan AWS CloudFormation template khusus lingkungan, dan selama penerapan, itu menggantikan akun atau Wilayah yang ditentukan oleh salah satu metode sebelumnya. Untuk informasi selengkapnya, lihat [ Lingkungan untuk AWS CDK](environments.md). **catatan** AWS CDK menggunakan kredenSIAL dari file sumber yang sama dengan AWS alat dan SDK lainnya, termasuk [AWS Command Line Interface. ](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) Namun, AWS CDK mungkin berperilaku agak berbeda dari alat-alat ini. Ini menggunakan AWS SDK untuk JavaScript di bawah kap. Untuk detail lengkap tentang menyiapkan kredenSIAL untuk AWS SDK untuk JavaScript, lihat [ Menyetel kredenSIAL](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials.html). Anda dapat secara opsional menggunakan opsi `--role-arn` (atau`-r`) untuk menentukan ARN dari peran IAM yang harus digunakan untuk penerapan. Peran ini harus diasumsikan oleh AWS akun yang digunakan. ## Tentukan perintah aplikasi Banyak fitur CDK CLI memerlukan satu atau lebih AWS CloudFormation template disintesis, yang pada gilirannya memerlukan menjalankan aplikasi Anda. AWS CDK mendukung program yang ditulis dalam berbagai bahasa. Oleh karena itu, ia menggunakan opsi konfigurasi untuk menentukan perintah yang tepat yang diperlukan untuk menjalankan aplikasi Anda. Opsi ini dapat ditentukan dengan dua cara. Pertama, dan paling umum, dapat ditentukan menggunakan `app` kunci di dalam file`cdk.json`. Ini ada di direktori utama proyek AWS CDK Anda. CDK CLI memberikan perintah yang sesuai saat membuat proyek baru dengan. `cdk init` Berikut ini `cdk.json` dari TypeScript proyek baru, misalnya. ``` { "app": "npx ts-node bin/hello-cdk.ts" } ``` CLI CDK mencari `cdk.json` di direktori kerja saat ini ketika mencoba menjalankan aplikasi Anda. Karena itu, Anda mungkin membiarkan shell terbuka di direktori utama proyek Anda untuk mengeluarkan perintah CDK CLI. CDK CLI juga mencari kunci aplikasi di `~/.cdk.json` (yaitu, di direktori home Anda) jika tidak dapat menemukannya di. `./cdk.json` Menambahkan perintah aplikasi di sini dapat berguna jika Anda biasanya bekerja dengan kode CDK dalam bahasa yang sama. Jika Anda berada di direktori lain, atau untuk menjalankan aplikasi menggunakan perintah selain perintah yang ada di`cdk.json`, gunakan opsi `--app` (atau`-a`) untuk menentukannya. ``` cdk --app "npx ts-node bin/hello-cdk.ts" ls ``` Saat menerapkan, Anda juga dapat menentukan direktori yang berisi rakitan cloud yang disintesis`cdk.out`, seperti, sebagai nilai`--app`. Tumpukan yang ditentukan digunakan dari direktori ini; aplikasi tidak disintesis. ## Tentukan tumpukan Banyak perintah CDK CLI (misalnya,`cdk deploy`) bekerja pada tumpukan yang ditentukan di aplikasi Anda. Jika aplikasi Anda hanya berisi satu tumpukan, CLI CDK mengasumsikan Anda berarti itu jika Anda tidak menentukan tumpukan secara eksplisit. Jika tidak, Anda harus menentukan tumpukan atau tumpukan yang ingin Anda gunakan. Anda dapat melakukan ini dengan menentukan tumpukan yang diinginkan berdasarkan ID secara individual pada baris perintah. Ingatlah bahwa ID adalah nilai yang ditentukan oleh argumen kedua saat Anda membuat instance tumpukan. ``` cdk synth PipelineStack LambdaStack ``` Anda juga dapat menggunakan wildcard untuk menentukan ID yang cocok dengan pola. + `?`cocok dengan karakter tunggal + `*`cocok dengan sejumlah karakter (`*`sendiri cocok dengan semua tumpukan) + `**`cocok dengan segala sesuatu dalam hierarki Anda juga dapat menggunakan `--all` opsi untuk menentukan semua tumpukan. Jika aplikasi Anda menggunakan [ CDK Pipelines](cdk-pipeline.md), CDK CLI memahami tumpukan dan tahapan Anda sebagai hierarki. Selain itu, `--all` opsi dan `*` wildcard hanya cocok dengan tumpukan tingkat atas. Untuk mencocokkan semua tumpukan, gunakan`**`. Juga digunakan `**` untuk menunjukkan semua tumpukan di bawah hierarki tertentu. Saat menggunakan wildcard, lampirkan pola dalam tanda kutip, atau hindari wildcard dengan. `\` Jika tidak, shell Anda mungkin mencoba memperluas pola ke nama-nama file di direktori saat ini. Paling-paling, ini tidak akan melakukan apa yang Anda harapkan; paling buruk, Anda dapat menerapkan tumpukan yang tidak Anda inginkan. Ini tidak sepenuhnya diperlukan di Windows karena `cmd.exe` tidak memperluas wildcard, tetapi tetap merupakan praktik yang baik. ``` cdk synth "*Stack" # PipelineStack, LambdaStack, etc. cdk synth 'Stack?' # StackA, StackB, Stack1, etc. cdk synth \* # All stacks in the app, or all top-level stacks in a CDK Pipelines app cdk synth '**' # All stacks in a CDK Pipelines app cdk synth 'PipelineStack/Prod/**' # All stacks in Prod stage in a CDK Pipelines app ``` **catatan** Urutan di mana Anda menentukan tumpukan belum tentu urutan di mana mereka akan diproses. CDK CLI memperhitungkan dependensi antara tumpukan saat memutuskan urutan untuk memprosesnya. Sebagai contoh, katakanlah bahwa satu tumpukan menggunakan nilai yang dihasilkan oleh yang lain (seperti ARN dari sumber daya yang ditentukan dalam tumpukan kedua). Dalam hal ini, tumpukan kedua disintesis sebelum yang pertama karena ketergantungan ini. Anda dapat menambahkan dependensi antar tumpukan secara manual menggunakan metode stack. ` [addDependency()](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html#addwbrdependencytarget-reason) ` ## Bootstrap Anda AWS lingkungan Menyebarkan tumpukan dengan CDK memerlukan sumber daya AWS CDK khusus khusus untuk disediakan. Per `cdk bootstrap` intah menciptakan sumber daya yang diperlukan untuk Anda. Anda hanya perlu melakukan bootstrap jika Anda menerapkan tumpukan yang membutuhkan sumber daya khusus ini. Lihat bootstrap [AWS CDK untuk detailnya. ](bootstrapping.md) ``` cdk bootstrap ``` Jika dikeluarkan tanpa argumen, seperti yang ditunjukkan di sini, `cdk bootstrap` perintah mensintesis aplikasi saat ini dan mem-bootstrap lingkungan tempat tumpukannya akan digunakan. Jika aplikasi berisi tumpukan agnostik lingkungan, yang tidak secara eksplisit menentukan lingkungan, akun default dan Wilayah di-bootstrap, atau lingkungan yang ditentukan menggunakan. `--profile` Di luar aplikasi, Anda harus secara eksplisit menentukan lingkungan yang akan di-bootstrap. Anda juga dapat melakukannya untuk mem-bootstrap lingkungan yang tidak ditentukan di aplikasi atau AWS profil lokal Anda. KredenSIAL harus dikonfigurasi (misalnya di`~/.aws/credentials`) untuk akun dan Wilayah yang ditentukan. Anda dapat menentukan profil yang berisi kredenSIAL yang diperlukan. ``` cdk bootstrap / # e.g. cdk bootstrap 1111111111/us-east-1 cdk bootstrap --profile test 1111111111/us-east-1 ``` **penting** Setiap lingkungan (account/region kombinasi) tempat Anda menerapkan tumpukan semacam itu harus di-bootstrap secara terpisah. Anda mungkin dikenakan AWS biaya untuk apa yang disimpan AWS CDK di sumber daya bootstrap. Selain itu, jika Anda menggunakan`--bootstrap-customer-key`, kunci AWS KMS akan dibuat, yang juga dikenakan biaya per lingkungan. **catatan** Versi sebelumnya dari template bootstrap membuat kunci KMS secara default. Untuk menghindari biaya, lakukan bootstrap ulang. `--no-bootstrap-customer-key` **catatan** CDK CLI v2 tidak mendukung template bootstrap asli, dijuluki template lama, digunakan secara default dengan CDK v1. **penting** Template bootstrap modern secara efektif memberikan izin yang tersirat oleh `--cloudformation-execution-policies` ke AWS akun mana pun dalam `--trust` daftar. Secara default, ini memperluas izin untuk membaca dan menulis ke sumber daya apa pun di akun bootstrap. Pastikan untuk [ mengonfigurasi tumpukan bootstrap ](bootstrapping-customizing.md) dengan kebijakan dan akun tepercaya yang membuat Anda nyaman. ## Buat aplikasi baru Untuk membuat aplikasi baru, buat direktori untuknya, lalu, di dalam direktori, keluarkan`cdk init`. ``` mkdir my-cdk-app cd my-cdk-app cdk init