Ini adalah Panduan Pengembang AWS CDK v2. CDKV1 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 CDK penerapan dengan menerapkan tumpukan CDK bootstrap, bernamaCDKToolkit
, ke dalam lingkungan. AWS
Tumpukan bootstrap adalah CloudFormation tumpukan yang menyediakan bucket Amazon S3 dan ECR repositori Amazon di lingkungan. AWS AWS CDK CLIMenggunakan sumber daya ini untuk menyimpan template yang disintesis dan aset terkait selama penerapan.
Penggunaan
$
cdk bootstrap
<arguments>
<options>
Pendapat
- AWS lingkungan
-
AWS Lingkungan target untuk menyebarkan tumpukan bootstrap ke 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 CDK aplikasi atau akan menentukan lingkungan dari sumber default. Ini bisa berupa lingkungan yang ditentukan menggunakan
--profile
opsi, dari variabel lingkungan, atau AWS CLI sumber default.
Opsi
Untuk daftar opsi global yang berfungsi dengan semua CDK CLI perintah, lihatOpsi global.
--bootstrap-bucket-name, --toolkit-bucket-name, -b
STRING
-
Nama bucket Amazon S3 yang akan digunakan oleh. CDK CLI Bucket ini akan dibuat dan saat ini tidak boleh ada.
Berikan opsi ini untuk mengganti nama default bucket Amazon S3.
Saat Anda menggunakan opsi ini, Anda mungkin harus menyesuaikan sintesis. Untuk mempelajari selengkapnya, lihat Sesuaikan sintesis CDK tumpukan.
Nilai default: Tidak terdefinisi
--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 terdefinisi
--bootstrap-kms-key-id
STRING
-
ID kunci AWS KMS master yang digunakan untuk SSE-KMS enkripsi.
Berikan opsi ini untuk mengganti AWS KMS kunci default yang digunakan untuk mengenkripsi bucket Amazon S3.
Opsi ini tidak kompatibel dengan
--bootstrap-customer-key
.Nilai default: Tidak terdefinisi
--cloudformation-execution-policies
ARRAY
-
IAMKebijakan terkelola ARNs yang harus dilampirkan ke peran penerapan yang diasumsikan AWS CloudFormation selama penerapan tumpukan Anda.
Secara default, tumpukan digunakan dengan izin administrator penuh menggunakan kebijakan.
AdministratorAccess
Anda dapat memberikan opsi ini beberapa kali dalam satu perintah. Anda juga dapat memberikan beberapa ARNs sebagai string tunggal, dengan individu ARNs dipisahkan dengan koma. Berikut 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 bahwa kebijakan yang Anda tentukan cukup untuk penerapan apa pun yang akan Anda lakukan ke lingkungan yang 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 daftar.--trust
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 nyaman bagi Anda.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 terdefinisi
--example-permissions-boundary, -epb
BOOLEAN
-
Gunakan batas izin contoh, yang disediakan oleh. AWS CDK
Opsi ini tidak kompatibel dengan
--custom-permissions-boundary
.Kebijakan batas izin yang CDK diberikan harus dianggap sebagai contoh. Edit konten dan referensikan kebijakan contoh jika Anda menguji fitur tersebut. Ubah menjadi kebijakan baru untuk penerapan aktual, jika belum ada. Kekhawatirannya adalah untuk menghindari drift. Kemungkinan besar, batas izin dipertahankan dan memiliki konvensi khusus, termasuk penamaan.
Untuk informasi selengkapnya tentang mengonfigurasi izin, termasuk menggunakan batas izin, lihat Panduan Pengembang Keamanan dan Keselamatan
. Nilai default: Tidak terdefinisi
--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. --previous-parameters
BOOLEAN
-
Gunakan nilai sebelumnya untuk parameter yang ada.
Setelah template bootstrap digunakan dengan serangkaian parameter, Anda harus mengatur opsi ini
false
untuk mengubah parameter apa pun pada penerapan masa depan. Kapanfalse
, Anda harus memasok ulang semua parameter yang disediakan sebelumnya.Nilai default:
true
--public-access-block-configuration
BOOLEAN
-
Blokir konfigurasi akses publik di bucket Amazon S3 yang dibuat dan digunakan oleh. CDK CLI
Nilai default:
true
--qualifier
STRING
-
Nilai string sembilan digit yang unik untuk setiap tumpukan bootstrap. Nilai ini ditambahkan ke ID fisik sumber daya di tumpukan bootstrap.
Dengan menyediakan qualifier, Anda menghindari bentrokan nama sumber daya saat menyediakan beberapa tumpukan bootstrap di lingkungan yang sama.
Saat Anda mengubah qualifier, CDK aplikasi Anda harus meneruskan nilai yang diubah ke stack synthesizer. Untuk informasi selengkapnya, lihat Sesuaikan sintesis CDK tumpukan.
Nilai default:
hnb659fds
. Nilai ini tidak memiliki signifikansi. --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
-
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.
Kapan
true
, perlindungan terminasi diaktifkan. Ini mencegah tumpukan bootstrap terhapus secara tidak sengaja.Untuk mempelajari lebih lanjut tentang perlindungan penghentian, lihat Melindungi tumpukan agar tidak dihapus di Panduan AWS CloudFormation Pengguna.
Nilai default: Tidak terdefinisi
--toolkit-stack-name
STRING
-
Nama tumpukan bootstrap untuk dibuat.
Secara default,
cdk bootstrap
menyebarkan tumpukan bernamaCDKToolkit
ke dalam AWS lingkungan yang ditentukan. Gunakan opsi ini untuk memberikan nama yang berbeda untuk tumpukan bootstrap Anda.Nilai default:
CDKToolkit
Wajib: Ya
--trust
ARRAY
-
Akun AWS IDsYang 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 sediakan sebelumnya. Jika Anda hanya memberikan akun baru untuk dipercaya, akun tepercaya sebelumnya akan dihapus.
Berikut ini adalah contoh yang mempercayai dua akun:
$
cdk bootstrap
⏳ 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.aws://123456789012/us-west-2
--trust234567890123
--trust987654321098
--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess
penting
Template bootstrap modern secara efektif memberikan izin yang tersirat oleh
--cloudformation-execution-policies
ke AWS akun mana pun dalam daftar.--trust
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 nyaman bagi Anda.Nilai default:
[]
--trust-for-lookup
ARRAY
-
Akun AWS IDsItu harus dipercaya untuk mencari nilai-nilai di lingkungan ini.
Gunakan opsi ini untuk memberikan izin akun untuk mensintesis tumpukan yang akan diterapkan ke lingkungan, tanpa benar-benar memberi mereka izin untuk menyebarkan 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 prod
$
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 menerapkannya menggunakan AWS CloudFormation. Berikut ini adalah contoh mengekspor template yang ada:
$
cdk bootstrap --show-template > bootstrap-template.yaml
Anda juga dapat memberitahu CDK CLI untuk menggunakan template kustom. Berikut 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