View a markdown version of this page

cdk bootstrap - AWS Kit Pengembangan Cloud (AWS CDK) v2

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.

cdk bootstrap

Siapkan AWS lingkungan untuk penerapan CDK dengan menerapkan tumpukan bootstrap CDK, bernama, ke lingkungan. CDKToolkit AWS

Tumpukan bootstrap adalah CloudFormation tumpukan yang menyediakan bucket Amazon S3 dan repositori Amazon ECR di AWS lingkungan. AWS CDK CLI menggunakan sumber daya ini untuk menyimpan templat yang disintesis dan aset terkait selama penerapan.

Penggunaan

$ cdk bootstrap <arguments> <options>

Argumen

AWS lingkungan

AWS Lingkungan target untuk menerapkan tumpukan bootstrap dalam format berikut:aws://<account-id>/<region>.

Contoh: aws://123456789012/us-east-1

Argumen ini dapat diberikan beberapa kali dalam satu perintah untuk menyebarkan tumpukan bootstrap ke beberapa lingkungan.

Secara default, CDK CLI akan mem-bootstrap semua lingkungan yang direferensikan dalam aplikasi CDK atau akan menentukan lingkungan dari sumber default. Ini bisa berupa lingkungan yang ditentukan menggunakan --profile opsi, dari variabel lingkungan, atau sumber AWS CLI default.

Opsi

Untuk daftar opsi global yang bekerja dengan semua perintah CDK CLI, lihat Opsi global.

--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING>

Nama bucket Amazon S3 yang akan digunakan oleh CDK CLI. Bucket ini akan dibuat dan tidak boleh ada saat ini.

Berikan opsi ini untuk mengganti nama default bucket Amazon S3.

Saat Anda menggunakan opsi ini, Anda mungkin harus menyesuaikan sintesis. Untuk mempelajari selengkapnya, lihat Meny esuaikan sintesis tumpukan CDK.

Nilai default: Tidak ditentukan

--bootstrap-customer-key <BOOLEAN>

Buat Customer Master Key (CMK) untuk bucket bootstrap (Anda akan dikenakan biaya tetapi dapat menyesuaikan izin, hanya bootstrap modern).

Opsi ini tidak kompatibel dengan--bootstrap-kms-key-id.

Nilai default: Tidak ditentukan

--bootstrap-kms-key-id <STRING>

ID kunci master AWS KMS untuk digunakan untuk en SSE-KMS kripsi.

Berikan opsi ini untuk mengganti kunci AWS KMS default yang digunakan untuk mengenkripsi bucket Amazon S3.

Opsi ini tidak kompatibel dengan--bootstrap-customer-key.

Nilai default: Tidak ditentukan

--express <BOOLEAN>

Bootstrap menggunakan mode CloudFormation ekspres. Mode ekspres memungkinkan penerapan yang lebih cepat CloudFormation melalui pelaporan operasi tumpukan setelah selesai segera setelah CloudFormation menerapkan konfigurasi sumber daya. Namun, CloudFormation laporan berhasil tanpa menunggu sumber daya stabil. Selain itu, mode ekspres tidak melakukan rollback secara otomatis dan akan meninggalkan tumpukan dalam keadaan gagal jika terjadi kesalahan.

Untuk informasi selengkapnya, lihat mode ekspres di Panduan AWS CloudFormation Pengguna.

Nilai default: false

--cloudformation-execution-policies <ARRAY>

ARN kebijakan IAM terkelola yang harus dilampirkan ke peran penerapan yang diasumsikan AWS CloudFormation selama penerapan tumpukan Anda.

Secara default, tumpukan digunakan dengan izin administrator penuh menggunakan AdministratorAccess kebijakan.

Anda dapat memberikan opsi ini beberapa kali dalam satu perintah. Anda juga dapat menyediakan beberapa ARN sebagai satu string, dengan masing-masing ARN dipisahkan oleh koma. Berikut ini adalah contohnya:

$ cdk bootstrap --cloudformation-execution-policies "arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"

Untuk menghindari kegagalan penerapan, pastikan kebijakan yang Anda tentukan cukup untuk penerapan apa pun yang akan Anda lakukan ke lingkungan yang sedang di-bootstrap.

Opsi ini hanya berlaku untuk bootstrap modern.

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 dengan kebijakan dan akun tepercaya yang membuat Anda nyaman.

Nilai default: []

--custom-permissions-boundary, -cpb <STRING>

Tentukan nama batas izin yang akan digunakan.

Opsi ini tidak kompatibel dengan--example-permissions-boundary.

Nilai default: Tidak ditentukan

--example-permissions-boundary, -epb <BOOLEAN>

Gunakan contoh batas izin, disediakan oleh AWS CDK.

Opsi ini tidak kompatibel dengan--custom-permissions-boundary.

Kebijakan batas izin yang disediakan CDK harus dianggap sebagai contoh. Edit konten dan referensi kebijakan contoh jika Anda menguji fitur tersebut. Ubah menjadi kebijakan baru untuk penerapan aktual, jika belum ada. Perhatiannya adalah untuk menghindari penyimpangan. Kemungkinan besar, batas izin dipertahankan dan memiliki konvensi khusus, termasuk penamaan.

Untuk informasi selengkapnya tentang mengonfigurasi izin, termasuk menggunakan batas izin, lihat Panduan Peng embang Keamanan dan Keselamatan.

Nilai default: Tidak ditentukan

--execute <BOOLEAN>

Konfigurasikan apakah akan menjalankan set perubahan.

Nilai default: true

--force, -f <BOOLEAN>

Selalu bootstrap, bahkan jika itu akan menurunkan versi template bootstrap.

Nilai default: false

--help, -h <BOOLEAN>

Tampilkan informasi referensi perintah untuk cdk bootstrap perintah tersebut.

--previous-parameters <BOOLEAN>

Gunakan nilai sebelumnya untuk parameter yang ada.

Setelah template bootstrap diterapkan dengan satu set parameter, Anda harus mengatur opsi ini false untuk mengubah parameter apa pun pada penerapan di masa mendatang. Kapanfalse, Anda harus memasok kembali semua parameter yang disediakan sebelumnya.

Nilai default: true

--public-access-block-configuration <BOOLEAN>

Blokir konfigurasi akses publik pada bucket Amazon S3 yang dibuat dan digunakan oleh CDK CLI.

Nilai default: true

--qualifier <STRING>

Nine-digit nilai string yang unik untuk setiap tumpukan bootstrap. Nilai ini ditambahkan ke ID fisik sumber daya di tumpukan bootstrap.

Dengan menyediakan kualifikasi, Anda menghindari bentrokan nama sumber daya saat menyediakan beberapa tumpukan bootstrap di lingkungan yang sama.

Saat Anda mengubah kualifikasi, aplikasi CDK Anda harus meneruskan nilai yang diubah ke stack synthesizer. Untuk informasi selengkapnya, lihat Meny esuaikan sintesis tumpukan CDK.

Nilai default:hnb659fds. Nilai ini tidak memiliki arti penting.

--show-template <BOOLEAN>

Alih-alih bootstrap, cetak template bootstrap saat ini ke output standar (). stdout Anda kemudian dapat menyalin dan menyesuaikan template seperlunya.

Nilai default: false

--tags, -t <ARRAY>

Tag untuk ditambahkan ke tumpukan bootstrap dalam format. KEY=VALUE

Nilai default: []

--template <STRING>

Gunakan template dari file yang diberikan alih-alih yang bawaan.

--termination-protection <BOOLEAN>

Alihkan perlindungan AWS CloudFormation terminasi pada tumpukan bootstrap.

Kapantrue, perlindungan penghentian diaktifkan. Ini mencegah tumpukan bootstrap dihapus secara tidak sengaja.

Untuk mempelajari lebih lanjut tentang perlindungan penghentian, lihat Mel indungi tumpukan agar tidak dihapus di Panduan AWS CloudFormation Pengguna.

Nilai default: Tidak ditentukan

--toolkit-stack-name <STRING>

Nama tumpukan bootstrap yang akan dibuat.

Secara default, cdk bootstrap menerapkan tumpukan bernama CDKToolkit ke AWS lingkungan yang ditentukan. Gunakan opsi ini untuk memberikan nama yang berbeda untuk tumpukan bootstrap Anda.

CDK CLI menggunakan nilai ini untuk memverifikasi versi tumpukan bootstrap Anda.

Nilai default: CDKToolkit

Wajib: Ya

--trust <ARRAY>

ID AWS akun yang harus dipercaya untuk melakukan penerapan ke lingkungan ini.

Akun yang melakukan bootstrap akan selalu dipercaya.

Opsi ini mengharuskan Anda juga menyediakan--cloudformation-execution-policies.

Anda dapat memberikan opsi ini beberapa kali dalam satu perintah.

Opsi ini hanya berlaku untuk bootstrap modern.

Untuk menambahkan akun tepercaya ke tumpukan bootstrap yang ada, Anda harus menentukan semua akun yang akan dipercaya, termasuk yang mungkin telah Anda berikan sebelumnya. Jika Anda hanya memberikan akun baru untuk dipercaya, akun yang sebelumnya tepercaya akan dihapus.

Berikut ini adalah contoh yang mempercayai dua akun:

$ cdk bootstrap aws://123456789012/us-west-2 --trust 234567890123 --trust 987654321098 --cloudformation-execution-policies arn:aws:iam::aws:policy/AdministratorAccess ⏳ Bootstrapping environment aws://123456789012/us-west-2... Trusted accounts for deployment: 234567890123, 987654321098 Trusted accounts for lookup: (none) Execution policies: arn:aws:iam::aws:policy/AdministratorAccess CDKToolkit: creating CloudFormation changeset... ✅ Environment aws://123456789012/us-west-2 bootstrapped.
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 dengan kebijakan dan akun tepercaya yang membuat Anda nyaman.

Nilai default: []

--trust-for-lookup <ARRAY>

ID AWS akun yang harus dipercaya untuk mencari nilai di lingkungan ini.

Gunakan opsi ini untuk memberikan izin akun untuk mensintesis tumpukan yang akan digunakan ke lingkungan, tanpa benar-benar memberi mereka izin untuk menerapkan tumpukan tersebut secara langsung.

Anda dapat memberikan opsi ini beberapa kali dalam satu perintah.

Opsi ini hanya berlaku untuk bootstrap modern.

Nilai default: []

Contoh

Bootstrap AWS lingkungan yang ditentukan dalam profil produk

$ cdk bootstrap --profile prod

Terapkan tumpukan bootstrap ke lingkungan foo dan bar

$ cdk bootstrap --app='node bin/main.js' foo bar

Ekspor template bootstrap untuk menyesuaikannya

Jika Anda memiliki persyaratan khusus yang tidak dipenuhi oleh template bootstrap, Anda dapat menyesuaikannya agar sesuai dengan kebutuhan Anda.

Anda dapat mengekspor template bootstrap, memodifikasinya, dan menyebarkannya menggunakan AWS CloudFormation. Berikut ini adalah contoh mengekspor template yang ada:

$ cdk bootstrap --show-template > bootstrap-template.yaml

Anda juga dapat memberi tahu CDK CLI untuk menggunakan template khusus. Berikut ini adalah contohnya:

$ cdk bootstrap --template my-bootstrap-template.yaml

Bootstrap dengan batas izin. Kemudian, hapus batas izin itu

Untuk bootstrap dengan batas izin khusus, kami menjalankan yang berikut:

$ cdk bootstrap --custom-permissions-boundary my-permissions-boundary

Untuk menghapus batas izin, kami menjalankan yang berikut:

$ cdk bootstrap --no-previous-parameters

Gunakan kualifikasi untuk membedakan sumber daya yang dibuat untuk lingkungan pengembangan

$ cdk bootstrap --qualifier dev2024