cdk refactor - AWS Cloud Development Kit (AWS CDK) v2
PenggunaanArgumenOpsi

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 refactor

penting

cdk refactorPerintah dalam rilis pratinjau dan dapat berubah.

Anda harus memberikan --unstable=refactor opsi saat menggunakan perintah ini.

Pertahankan sumber daya yang digunakan saat memfaktorkan ulang kode di aplikasi AWS Cloud Development Kit (AWS CDK) Anda.

Ketika Anda mengganti nama konstruksi atau memindahkannya melintasi tumpukan dalam kode CDK Anda, biasanya CloudFormation akan memperlakukan ini sebagai sumber daya baru, menyebabkan penggantian yang dapat menyebabkan gangguan layanan atau kehilangan data. cdk refactorPerintah secara cerdas mendeteksi perubahan ini dan bekerja dengan CloudFormation API refactoring untuk mempertahankan sumber daya Anda sambil memperbarui logisnya. IDs

Dengan cdk refactor, Anda dapat:

  • Ganti nama konstruksi untuk kejelasan yang lebih baik dalam basis kode Anda tanpa menyebabkan penggantian sumber daya.

  • Pindahkan sumber daya antar tumpukan untuk meningkatkan organisasi dan pemisahan kekhawatiran.

  • Atur ulang hierarki konstruksi Anda (seperti mengelompokkan sumber daya AWS di bawah konstruksi L3 baru) sambil mempertahankan sumber daya cloud yang mendasarinya.

  • Upgrade atau beralih dengan aman di antara pustaka konstruksi, termasuk dependensi pihak ketiga, tanpa memicu penggantian sumber daya saat perubahan logis antar versi. IDs

Perintah ini menganalisis perubahan Anda, menampilkan daftar sumber daya yang akan mengubah lokasi (tumpukan dan ID logis), dan menangani proses kompleks memperbarui sumber CloudFormation daya sambil mempertahankan identitas dan statusnya.

Saat dijalankan, perintah secara otomatis menghitung pemetaan dengan membandingkan kode Anda saat ini dengan status yang diterapkan. Ini memverifikasi bahwa aplikasi CDK Anda berisi kumpulan sumber daya yang persis sama dengan status yang diterapkan, hanya berbeda di lokasi mereka di pohon konstruksi. Jika perintah mendeteksi penambahan, penghapusan, atau modifikasi sumber daya apa pun, operasi refactoring akan ditolak dengan pesan kesalahan.

Setelah memetakan komputasi, perintah menunjukkan kepada Anda perubahan yang diusulkan dan, setelah konfirmasi pengguna, menerapkan refactoring. Jika ambiguitas terdeteksi (di mana beberapa pemetaan yang valid dimungkinkan), Anda dapat memberikan file penggantian dengan pemetaan eksplisit untuk menyelesaikan kasus ini.

Untuk pengantar, lihat Mempertahankan sumber daya yang diterapkan saat memfaktorkan ulang kode CDK.

Penggunaan

$ cdk refactor <arguments> <options>

Argumen

ID tumpukan CDK

ID konstruksi tumpukan CDK dari aplikasi Anda menjadi refactor.

Anda dapat menentukan beberapa tumpukan IDs untuk memfokuskan operasi refactoring pada tumpukan tersebut. Jika sumber daya dipindahkan antar tumpukan, dan salah satu tumpukan tersebut tidak disertakan secara eksplisit, perintah refactor akan secara otomatis menyertakan tumpukan tambahan dalam operasi.

Jika Anda tidak menyediakan tumpukan apa pun IDs, semua tumpukan di aplikasi akan dipertimbangkan untuk refactoring.

Tipe: String

Wajib: Tidak

Opsi

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

--dry-run

Cetak pemetaan ke konsol tanpa menerapkannya.

Opsi ini berguna untuk memvalidasi perubahan Anda sebelum benar-benar melakukan refactoring, terutama saat bekerja dengan aplikasi yang kompleks. Ini menunjukkan kepada Anda dengan tepat perubahan apa yang akan dilakukan tanpa memodifikasi sumber daya apa pun.

--force

Lanjutkan dengan refactoring tanpa meminta pengguna untuk konfirmasi.

Ini berguna dalam lingkungan interaktif ketika Anda yakin tentang perubahan. Dalam lingkungan non-interaktif seperti CI/CD pipeline, CDK CLI secara otomatis berjalan tanpa diminta, jadi opsi ini tidak diperlukan.

--help, -h <BOOLEAN>

Tampilkan informasi referensi perintah untuk cdk refactor perintah.

--override-file <FILE>

Berikan penggantian saat CDK CLI tidak dapat menentukan resolusi refactoring untuk sumber daya. File ini berisi pemetaan sumber daya dalam format JSON. Berikut ini adalah contohnya:

{
    "environments": [
        {
            "account": "123456789012",
            "region": "us-east-2",
            "resources": {
                "StackA.OldName": "StackB.NewName",
                "StackC.Foo": "StackC.Bar"
            }
        }
    ]
}
--revert <FILE>

Kembalikan refactor sebelumnya. Anda harus menyediakan file override dengan pemetaan sumber daya.

Ini tidak sepenuhnya membatalkan operasi refactor sebelumnya. Untuk mengembalikan refactor sepenuhnya, Anda perlu mengembalikan aplikasi ke status sebelumnya dan menjalankan proses refactor lagi.