Migrasikan sumber daya dan AWS CloudFormation templat yang ada ke AWS CDK

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.

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.

Gunakan Antarmuka Baris AWS Cloud Development Kit (AWS CDK) Perintah (AWS CDK CLI) untuk memigrasikan AWS sumber daya yang diterapkan, AWS CloudFormation tumpukan yang diterapkan, dan templat lokal ke. AWS CloudFormation AWS CDK

Cara kerja migrasi

Gunakan AWS CDK CLI cdk migrateperintah untuk bermigrasi dari sumber berikut:

Setelah bermigrasi, Anda dapat mengelola, memodifikasi, dan menerapkan aplikasi CDK AWS CloudFormation untuk menyediakan atau memperbarui sumber daya Anda.

Manfaat CDK Migrate

Migrasi sumber daya ke dalam secara AWS CDK historis merupakan proses manual yang membutuhkan waktu dan keahlian dengan AWS CloudFormation dan bahkan AWS CDK untuk memulai. Dengan CDK Migrate, AWS CDK CLI memfasilitasi sebagian besar upaya migrasi untuk Anda dalam waktu yang singkat. CDK Migrate akan segera membantu Anda mulai menggunakan aplikasi AWS CDK untuk mengembangkan dan mengelola aplikasi baru dan yang sudah ada. AWS

Pertimbangan

Pertimbangan umum

Pertimbangan saat bermigrasi dari template AWS CloudFormation

Pertimbangan saat bermigrasi dari sumber daya yang digunakan

Prasyarat

Sebelum menggunakan cdk migrate perintah, selesaikan semua langkah pengaturan diMemulai dengan AWS CDK.

Memulai dengan CDK Migrate

Untuk memulai, jalankan AWS CDK CLI cdk migrateperintah dari direktori pilihan Anda. Berikan opsi wajib dan opsional, tergantung pada jenis migrasi yang Anda lakukan.

Untuk daftar lengkap dan deskripsi opsi yang dapat Anda gunakancdk migrate, lihatcdk migrate.

Berikut ini adalah beberapa opsi penting yang mungkin ingin Anda berikan.

Migrasi dari tumpukan AWS CloudFormation

Untuk bermigrasi dari AWS CloudFormation tumpukan yang diterapkan, berikan opsi. --from-stack Berikan nama AWS CloudFormation tumpukan yang Anda gunakan. --stack-name Berikut adalah contohnya:

$ cdk migrate --from-stack --stack-name "myCloudFormationStack"

The AWS CDK CLI akan melakukan hal berikut:

Saat Anda bermigrasi dari AWS CloudFormation tumpukan yang diterapkan, AWS CDK CLI mencoba untuk mencocokkan logis sumber daya yang diterapkan IDs dan nama AWS CloudFormation tumpukan yang diterapkan ke sumber daya yang dimigrasi dan tumpukan di aplikasi CDK baru.

Setelah migrasi, Anda dapat mengelola dan memodifikasi aplikasi CDK secara normal. Saat Anda menerapkan, AWS CloudFormation akan mengidentifikasi penerapan sebagai pembaruan AWS CloudFormation tumpukan karena nama tumpukan yang cocok AWS CloudFormation . Sumber daya dengan pencocokan logis IDs akan diperbarui. Untuk informasi selengkapnya tentang penerapan, lihatKelola dan terapkan aplikasi CDK Anda.

Migrasi dari template AWS CloudFormation

CDK Migrate mendukung migrasi dari AWS CloudFormation templat yang diformat dalam atau. JSON YAML

Untuk bermigrasi dari AWS CloudFormation templat lokal, gunakan --from-path opsi dan berikan jalur ke templat lokal. Anda juga harus memberikan --stack-name opsi yang diperlukan. Berikut adalah contohnya:

$ cdk migrate --from-path "./template.json" --stack-name "myCloudFormationStack"

The AWS CDK CLI akan melakukan hal berikut:

Setelah migrasi, Anda dapat mengelola dan memodifikasi aplikasi CDK secara normal. Saat penerapan, Anda memiliki opsi berikut:

Migrasi dari template AWS SAM

Untuk bermigrasi dari templat AWS Serverless Application Model (AWS SAM), Anda harus terlebih dahulu mengonversinya menjadi AWS CloudFormation templat atau menerapkan untuk membuat AWS CloudFormation tumpukan.

Untuk mengonversi AWS SAM templat ke AWS CloudFormation, Anda dapat menggunakan AWS SAM CLI sam validate --debugperintah. Anda mungkin harus mengatur lint ke false dalam samconfig.toml file Anda sebelum menjalankan perintah ini.

Untuk mengonversi ke AWS CloudFormation tumpukan, gunakan AWS SAM templat menggunakan AWS SAM CLI. Kemudian bermigrasi dari tumpukan yang diterapkan.

Migrasi dari sumber daya yang digunakan

Untuk bermigrasi dari AWS sumber daya yang diterapkan, berikan opsi. --from-scan Anda juga harus memberikan --stack-name opsi yang diperlukan. Berikut adalah contohnya:

$ cdk migrate --from-scan --stack-name "myCloudFormationStack"

The AWS CDK CLI akan melakukan hal berikut:

Gunakan filter

Secara default, AWS CDK CLI akan memindai seluruh AWS lingkungan dan memigrasikan sumber daya hingga batas kuota maksimum generator IAC. Anda dapat memberikan filter dengan AWS CDK CLI untuk menentukan kriteria sumber daya yang dimigrasi dari akun Anda ke aplikasi CDK baru. Untuk mempelajari selengkapnya, lihat --filter.

Memindai sumber daya dengan generator IAc

Bergantung pada jumlah sumber daya di akun Anda, pemindaian mungkin memakan waktu beberapa menit. Bilah kemajuan akan ditampilkan selama proses pemindaian.

Selesaikan properti hanya tulis

Beberapa sumber daya yang didukung berisi properti write-only. Properti ini dapat ditulis ke, untuk mengkonfigurasi properti, tetapi tidak dapat dibaca oleh generator IAc atau AWS CloudFormation untuk mendapatkan nilai. Misalnya, properti yang digunakan untuk menentukan kata sandi database mungkin hanya ditulis untuk alasan keamanan.

Saat memindai sumber daya selama migrasi, generator IAc akan mendeteksi sumber daya yang mungkin berisi properti hanya tulis dan akan mengkategorikannya ke dalam salah satu jenis berikut:

Untuk informasi selengkapnya tentang properti khusus tulis dan cara IAc generator mengelolanya saat memindai sumber daya yang digunakan dan membuat AWS CloudFormation templat, lihat generator IAc dan properti khusus tulis di Panduan Pengguna.AWS CloudFormation

Setelah migrasi, Anda harus menentukan nilai properti hanya-tulis di aplikasi CDK baru. The AWS CDK CLI akan menambahkan bagian Peringatan ke ReadMe file proyek CDK untuk mendokumentasikan properti hanya tulis apa pun yang diidentifikasi oleh generator IAc. Berikut adalah contohnya:

# Welcome to your CDK TypeScript project
...
## Warnings
### Write-only properties
Write-only properties are resource property values that can be written to but can't be read by AWS CloudFormation or CDK Migrate. For more information, see [IaC generator and write-only properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html).

Write-only properties discovered during migration are organized here by resource ID and categorized by write-only property type. Resolve write-only properties by providing property values in your CDK app. For guidance, see [Resolve write-only properties](https://docs.aws.amazon.com/cdk/v2/guide/migrate.html#migrate-resources-writeonly).
### MyLambdaFunction
- **UNSUPPORTED_PROPERTIES**: 
  - SnapStart/ApplyOn: Applying SnapStart setting on function resource type.Possible values: [PublishedVersions, None]
This property can be replaced with other types
  - Code/S3ObjectVersion: For versioned objects, the version of the deployment package object to use.
This property can be replaced with other exclusive properties
- **MUTUALLY_EXCLUSIVE_PROPERTIES**: 
  - Code/S3Bucket: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
This property can be replaced with other exclusive properties
  - Code/S3Key: The Amazon S3 key of the deployment package.
This property can be replaced with other exclusive properties

Setelah Anda menyelesaikan semua nilai properti write-only, Anda siap untuk mempersiapkan penerapan.

Berkas.json yang bermigrasi

The AWS CDK CLI membuat migrate.json file dalam AWS CDK proyek Anda selama migrasi. File ini berisi informasi referensi tentang sumber daya yang Anda gunakan. Saat Anda menerapkan aplikasi CDK untuk pertama kalinya, AWS CDK CLI menggunakan file ini untuk mereferensikan sumber daya yang Anda gunakan, mengaitkan sumber daya Anda dengan AWS CloudFormation tumpukan baru, dan menghapus file.

Kelola dan terapkan aplikasi CDK Anda

Saat bermigrasi ke AWS CDK, aplikasi CDK baru mungkin tidak segera siap penerapan. Topik ini menjelaskan item tindakan yang perlu dipertimbangkan saat mengelola dan menerapkan aplikasi CDK baru Anda.

Mempersiapkan penyebaran

Sebelum menerapkan, Anda harus menyiapkan aplikasi CDK Anda.

Menerapkan aplikasi CDK Anda

Saat Anda menerapkan aplikasi CDK, AWS CDK CLI memanfaatkan AWS CloudFormation layanan untuk menyediakan sumber daya Anda. Sumber daya dibundel ke dalam satu tumpukan di aplikasi CDK dan digunakan sebagai tumpukan tunggal. AWS CloudFormation

Tergantung dari mana Anda bermigrasi, Anda dapat menerapkan untuk membuat AWS CloudFormation tumpukan baru atau memperbarui tumpukan yang ada AWS CloudFormation .