Questo è il AWS Guida per gli sviluppatori di CDK v2. Il vecchio CDK v1 è entrato in manutenzione il 1° giugno 2022 e ha terminato il supporto il 1° giugno 2023.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Esegui la migrazione delle risorse esistenti e AWS CloudFormation modelli in AWS CDK
|
La funzionalità CDK Migrate è disponibile in anteprima per AWS CDK ed è soggetta a modifiche. |
Usa il AWS Kit di sviluppo cloud (AWS CDK) Interfaccia a riga di comando (AWS CDK (CLI) per la migrazione è stato implementato AWS risorse, distribuite AWS CloudFormation stack e locali AWS CloudFormation modelli per AWS CDK.
Come funziona la migrazione
Usa il AWS CDK CLI cdk migrate comando per migrare dalle seguenti fonti:
-
Distribuito AWS risorse.
-
Distribuito AWS CloudFormation pile.
-
Locale AWS CloudFormation modelli.
- Distribuito AWS risorse
-
È possibile eseguire la migrazione implementata AWS risorse da un ambiente specifico (AWS account e AWS Regione) che non sono associati a un AWS CloudFormation pila.
La AWS CDK CLI utilizza generatore IaC servizio per cercare le risorse presenti nel tuo AWS ambiente per raccogliere informazioni sulle risorse. Per saperne di più sul generatore IaC, vedi Generazione di modelli per le risorse esistenti nel AWS CloudFormation Guida per l'utente.
Dopo aver raccolto i dettagli delle risorse, AWS CDK CLI crea una nuova app CDK che include un singolo stack contenente le risorse migrate.
- Distribuito AWS CloudFormation pile
-
Puoi migrare un singolo AWS CloudFormation impilare in un nuovo AWS App CDK. La AWS CDK CLI recupererà il AWS CloudFormation modello del tuo stack e crea una nuova app CDK. L'app CDK sarà costituita da un unico stack che contiene i dati migrati AWS CloudFormation pila.
- Locale AWS CloudFormation modelli
-
Puoi migrare da un locale AWS CloudFormation modello. I modelli locali possono contenere o meno risorse distribuite. I AWS CDK CLI creerà una nuova app CDK che contiene un singolo stack con le tue risorse.
Dopo la migrazione, puoi gestire, modificare e distribuire la tua app CDK su AWS CloudFormation per effettuare il provisioning o aggiornare le tue risorse.
Vantaggi di CDK Migrate
Migrazione delle risorse in AWS Il CDK è stato storicamente un processo manuale che richiede tempo ed esperienza con AWS CloudFormation e AWS CDK per iniziare. Con CDK Migrate, AWS CDK CLI facilita la maggior parte delle operazioni di migrazione in una frazione del tempo. CDK Migrate ti consentirà di iniziare rapidamente a utilizzare AWS CDK per sviluppare e gestire applicazioni nuove ed esistenti su AWS.
Considerazioni
Considerazioni generali
- CDK Migrate e CDK Import
-
Il
cdk importil comando può importare risorse distribuite in un'app CDK nuova o esistente. Durante l'importazione, ogni risorsa dovrà essere definita manualmente come costrutto L1 nell'app. Ti consigliamo di utilizzarecdk importper importare una o più risorse alla volta in un'app CDK nuova o esistente. Per saperne di più, vedi Importa le risorse esistenti in uno stack.Il
cdk migrateil comando migra dalle risorse distribuite, distribuito AWS CloudFormation stack o locali AWS CloudFormation modelli in una nuova app CDK. Durante la migrazione, AWS CDK CLI utilizzacdk importper importare le tue risorse nella nuova app CDK. Il AWS CDK CLI genera anche costrutti L1 per ogni risorsa per te. Ti consigliamo di utilizzarecdk migratequando si importa da una fonte di migrazione supportata in una nuova AWS app CDK. - CDK Migrate crea solo costrutti L1
-
L'app CDK appena creata includerà solo i costrutti L1. Puoi aggiungere costrutti di livello superiore alla tua app dopo la migrazione.
- CDK Migrate crea app CDK che contengono un singolo stack
-
L'app CDK appena creata conterrà un singolo stack.
Durante la migrazione delle risorse distribuite, tutte le risorse migrate saranno contenute in un unico stack nella nuova app CDK.
Durante la migrazione AWS CloudFormation è possibile migrare solo uno stack AWS CloudFormation raggruppa in un unico stack nella nuova app CDK.
- Migrazione delle risorse
-
Risorse del progetto, ad esempio AWS Il codice Lambda non verrà migrato direttamente nella nuova app CDK. Dopo la migrazione, puoi specificare i valori degli asset per includerli nell'app CDK.
- Migrazione di risorse con stato
-
Quando si migrano risorse con stato, come database e bucket Amazon Simple Storage Service (Amazon S3), molto spesso si desidera migrare la risorsa esistente anziché crearne una nuova.
Per migrare e preservare le risorse con stato, procedi come segue:
-
Verifica che la tua risorsa stateful supporti l'importazione. Per ulteriori informazioni, consulta Supporto per tipi di risorse nel AWS CloudFormation Guida per l'utente.
-
Dopo la migrazione, verifica che l'ID logico della risorsa migrata nella nuova app CDK corrisponda all'ID logico della risorsa distribuita.
-
Se si esegue la migrazione da un AWS CloudFormation stack, verifica che il nome dello stack nella nuova app CDK corrisponda a AWS CloudFormation pila.
-
Distribuisci l'app CDK usando lo stesso AWS account e AWS Regione della risorsa migrata.
-
Considerazioni sulla migrazione da un AWS CloudFormation modello
- CDK Migrate supporta la migrazione di un singolo modello
-
Durante la migrazione AWS CloudFormation modelli, puoi selezionare un singolo modello da migrare. I modelli annidati non sono supportati.
- Migrazione di modelli con funzioni intrinseche
-
Quando si esegue la migrazione da un AWS CloudFormation modello che utilizza funzioni intrinseche, AWS CDK CLI tenterà di migrare la tua logica nell'app CDK con
Fnclasse. Per saperne di più, vedi classe Fn nel AWS Kit di sviluppo cloud (AWS Riferimento all'API CDK).
Considerazioni sulla migrazione dalle risorse distribuite
- Limitazioni alla scansione
-
Durante la scansione dell'ambiente alla ricerca di risorse, il generatore IaC presenta limitazioni specifiche sui dati che può recuperare e limiti di quota durante la scansione. Per saperne di più, consulta Considerazioni nel AWS CloudFormation Guida per l'utente.
Prerequisiti
Prima di utilizzare cdk migrate comando, completa tutti i passaggi di configurazione in Guida introduttiva a AWS CDK.
Inizia con CDK Migrate
Per iniziare, esegui AWS CLI CDK cdk migrate comando da una cartella a tua scelta. Fornisci le opzioni obbligatorie e opzionali, a seconda del tipo di migrazione che stai eseguendo.
Per un elenco completo e una descrizione delle opzioni che è possibile utilizzare con cdk migrate, vedi cdk migrare.
Di seguito sono riportate alcune opzioni importanti che potresti voler fornire.
- Stack name (Nome stack)
-
L'unica opzione richiesta è
--stack-name. Utilizzate questa opzione per specificare un nome per lo stack che verrà creato all'interno di AWS App CDK dopo la migrazione. Il nome dello stack verrà utilizzato anche come nome del tuo AWS CloudFormation stack al momento della distribuzione. - Linguaggio
-
Usa
--languageper specificare il linguaggio di programmazione della nuova app CDK. - AWS account e AWS Regione
-
La AWS CDK CLI recupera AWS account e AWS Informazioni sulla regione provenienti da fonti predefinite. Per ulteriori informazioni, vedere Ambienti per AWS CDK. Puoi usare
--accounte--regionopzioni concdk migrateper fornire altri valori. - Directory di output del tuo nuovo progetto CDK
-
Per impostazione predefinita, AWS CDK CLI creerà un nuovo progetto CDK nella tua directory di lavoro e utilizzerà il valore fornito con
--stack-nameper assegnare un nome alla cartella del progetto. Se esiste attualmente una cartella con lo stesso nome, AWS CDK CLI sovrascriverà quella cartella.È possibile specificare un percorso di output diverso per la nuova cartella di progetto CDK con
--output-pathopzione. - Fonte di migrazione
-
Fornisci un'opzione per specificare la fonte da cui stai eseguendo la migrazione.
-
--from-path— Esegui la migrazione da una rete locale AWS CloudFormation modello. -
--from-scan— Esegui la migrazione dalle risorse distribuite in un AWS account e AWS Regione. -
--from-stack— Migrare da un AWS CloudFormation pila.
A seconda della fonte di migrazione, puoi fornire opzioni aggiuntive per personalizzare il
cdk migratecomando. -
Esegui la migrazione da un AWS CloudFormation pila
Per migrare da uno distribuito AWS CloudFormation stack, fornisci il --from-stack opzione. Fornisci il nome del tuo schierato AWS CloudFormation impila con --stack-name. Di seguito è riportato un esempio:
$ cdk migrate --from-stack --stack-name "myCloudFormationStack"
Il AWS CDK CLI eseguirà le seguenti operazioni:
-
Recupera il AWS CloudFormation modello dello stack distribuito.
-
Esegui
cdk initper inizializzare una nuova app CDK. -
Crea uno stack all'interno dell'app CDK che contenga la tua migrazione AWS CloudFormation pila.
Quando si esegue la migrazione da un sistema distribuito AWS CloudFormation stack, il AWS La CLI CDK tenta di abbinare gli ID logici delle risorse distribuite e quelli distribuiti AWS CloudFormation nome dello stack alle risorse migrate e allo stack nella nuova app CDK.
Dopo la migrazione, puoi gestire e modificare normalmente la tua app CDK. Quando esegui la distribuzione, AWS CloudFormation identificherà la distribuzione come AWS CloudFormation aggiornamento dello stack dovuto alla corrispondenza AWS CloudFormation nome dello stack. Le risorse con ID logici corrispondenti verranno aggiornate. Per ulteriori informazioni sulla distribuzione, consulta Gestisci e distribuisci la tua app CDK.
Migrare da un AWS CloudFormation modello
CDK Migrate supporta la migrazione da AWS CloudFormation modelli formattati in JSON o YAML.
Per migrare da un locale AWS CloudFormation modello, usa il --from-path opzione e fornisci un percorso al modello locale. È inoltre necessario fornire il necessario --stack-name opzione. Di seguito è riportato un esempio:
$ cdk migrate --from-path "./template.json" --stack-name "myCloudFormationStack"
La AWS CDK CLI eseguirà le seguenti operazioni:
-
Recupera il tuo locale AWS CloudFormation modello.
-
Esegui
cdk initper inizializzare una nuova app CDK. -
Crea uno stack all'interno dell'app CDK che contenga la tua migrazione AWS CloudFormation modello.
Dopo la migrazione, puoi gestire e modificare normalmente la tua app CDK. Al momento della distribuzione, sono disponibili le seguenti opzioni:
-
Aggiornare un AWS CloudFormation pila — Se il locale AWS CloudFormation il modello è stato distribuito in precedenza, è possibile aggiornare quello distribuito AWS CloudFormation pila.
-
Implementa un nuovo AWS CloudFormation pila — Se il locale AWS CloudFormation il modello non è mai stato distribuito o se desideri creare un nuovo stack da un modello distribuito in precedenza, puoi distribuirne uno nuovo AWS CloudFormation pila.
Migrare da un AWS Modello SAM
Migrare da un AWS Modello applicativo serverless (AWS modello SAM), devi prima convertirlo in un AWS CloudFormation modello o implementalo per creare un AWS CloudFormation pila.
Per convertire un AWS Modello SAM in AWS CloudFormation, puoi usare il AWS STESSA CLIP sam validate --debug comando. Potrebbe essere necessario impostare lint a false nel tuo samconfig.toml file prima di eseguire questo comando.
Per convertire in un AWS CloudFormation stack, distribuisci il AWS modello SAM utilizzando il AWS STESSA CLIP. Quindi esegui la migrazione dallo stack distribuito.
Esegui la migrazione dalle risorse distribuite
Per migrare da una versione distribuita AWS risorse, fornisci il --from-scan opzione. È inoltre necessario fornire il necessario --stack-name opzione. Di seguito è riportato un esempio:
$ cdk migrate --from-scan --stack-name "myCloudFormationStack"
La AWS CDK CLI eseguirà le seguenti operazioni:
-
Scansiona il tuo account per i dettagli delle risorse e delle proprietà — Il AWS CDK CLI utilizza il generatore IaC per scansionare il tuo account e raccogliere dettagli.
-
Genera un AWS CloudFormation modello — Dopo la scansione, AWS CDK CLI utilizza il generatore IaC per creare un AWS CloudFormation modello.
-
Inizializza una nuova app CDK e migra il tuo modello — Il AWS CDK CLI viene eseguito
cdk initper inizializzarne una nuova AWS app CDK e migra la tua AWS CloudFormation modello nell'app CDK come un unico stack.
Usa i filtri
Per impostazione predefinita, AWS CDK CLI eseguirà la scansione dell'intero AWS ambiente e migra le risorse fino al limite massimo di quota del generatore IaC. È possibile fornire filtri con AWS CDK CLI per specificare i criteri in base ai quali le risorse vengono migrate dal tuo account alla nuova app CDK. Per ulteriori informazioni, consulta
--filter
.
Scansione delle risorse con il generatore IaC
A seconda del numero di risorse presenti nel tuo account, la scansione potrebbe richiedere alcuni minuti. Durante il processo di scansione verrà visualizzata una barra di avanzamento.
- Tipi di risorse supportati
-
Il AWS CDK CLI migrerà le risorse supportate dal generatore IaC. Per un elenco completo, vedi Supporto per tipi di risorse nel AWS CloudFormation Guida per l'utente.
Risoluzione delle proprietà di sola scrittura
Alcune risorse supportate contengono proprietà di sola scrittura. Queste proprietà possono essere scritte su, per configurare la proprietà, ma non possono essere lette dal generatore IaC o AWS CloudFormation per ottenere il valore. Ad esempio, una proprietà utilizzata per specificare una password del database può essere di sola scrittura per motivi di sicurezza.
Durante la scansione delle risorse durante la migrazione, il generatore IaC rileverà le risorse che possono contenere proprietà di sola scrittura e le classificherà in uno dei seguenti tipi:
-
MUTUALLY_EXCLUSIVE_PROPERTIES— Si tratta di proprietà di sola scrittura per una risorsa specifica che sono intercambiabili e hanno uno scopo simile. Una delle proprietà che si escludono a vicenda è necessaria per configurare la risorsa. Ad esempio,S3Bucket,ImageUri, eZipFileproprietà per unAWS::Lambda::Functionle risorse sono proprietà di sola scrittura che si escludono a vicenda. Ognuno di essi può essere utilizzato per specificare gli asset della funzione, ma è necessario utilizzarne uno. -
MUTUALLY_EXCLUSIVE_TYPES— Si tratta di proprietà obbligatorie di sola scrittura che accettano più tipi di configurazione. Ad esempio,Bodyproprietà di unAWS::ApiGateway::RestApila risorsa accetta un oggetto o un tipo di stringa. -
UNSUPPORTED_PROPERTIES— Si tratta di proprietà di sola scrittura che non rientrano nelle altre due categorie. Sono proprietà opzionali o obbligatorie che accettano una serie di oggetti.
Per ulteriori informazioni sulle proprietà di sola scrittura e su come il generatore IaC le gestisce durante la scansione delle risorse distribuite e la creazione AWS CloudFormation modelli, vedi generatore IaC e proprietà di sola scrittura nel AWS CloudFormation Guida per l'utente.
Dopo la migrazione, è necessario specificare i valori delle proprietà di sola scrittura nella nuova app CDK. Il AWS CDK CLI aggiungerà un Avvertenze sezione dedicata al progetto CDK ReadMe file per documentare tutte le proprietà di sola scrittura identificate dal generatore IaC. Di seguito è riportato un esempio:
# 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
-
Gli avvisi sono organizzati in titoli che identificano l'ID logico della risorsa a cui sono associati.
-
Gli avvisi sono classificati per tipo. Questi tipi provengono direttamente dal generatore IaC.
- Per risolvere le proprietà di sola scrittura
-
-
Identificare le proprietà di sola scrittura da risolvere da Avvertenze sezione del tuo progetto CDK
ReadMefile. Qui puoi prendere nota delle risorse della tua app CDK che possono contenere proprietà di sola scrittura e identificare i tipi di proprietà di sola scrittura che sono stati scoperti.-
Per
MUTUALLY_EXCLUSIVE_PROPERTIES, stabilisci quale proprietà che si escludono a vicenda configurare nel tuo AWS App CDK. -
Per
MUTUALLY_EXCLUSIVE_TYPES, determina il tipo accettato che utilizzerai per configurare la proprietà. -
Per
UNSUPPORTED_PROPERTIES, determina se la proprietà è facoltativa o obbligatoria. Quindi, configura se necessario.
-
-
Usa la guida di Generatore IaC e proprietà di sola scrittura per fare riferimento al significato dei tipi di avviso.
-
Nell'app CDK, i valori delle proprietà di sola scrittura da risolvere verranno specificati anche nel
Propssezione della tua app. Fornisci qui i valori corretti. Per le descrizioni e le linee guida delle proprietà, puoi fare riferimento al AWS Riferimento all'API CDK.Di seguito è riportato un esempio di
Propssezione all'interno di un'app CDK migrata con due proprietà di sola scrittura da risolvere:export interface MyTestAppStackProps extends cdk.StackProps { /** * The Amazon S3 key of the deployment package. */ readonly lambdaFunction00asdfasdfsadf008grk1CodeS3Keym8P82: string; /** * An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. */ readonly lambdaFunction00asdfasdfsadf008grk1CodeS3Bucketzidw8: string; }Una volta risolti tutti i valori delle proprietà di sola scrittura, sei pronto per prepararti per la distribuzione.
-
Il file migrate.json
Il AWS CDK CLI crea un migrate.json file nel tuo AWS progetto CDK durante la migrazione. Questo file contiene informazioni di riferimento sulle risorse distribuite. Quando distribuisci la tua app CDK per la prima volta, AWS CDK CLI utilizza questo file per fare riferimento alle risorse distribuite, associa le risorse alle nuove AWS CloudFormation impila ed elimina il file.
Gestisci e distribuisci la tua app CDK
Durante la migrazione a AWS CDK, la nuova app CDK potrebbe non essere immediatamente pronta per l'implementazione. Questo argomento descrive le azioni da prendere in considerazione durante la gestione e la distribuzione della nuova app CDK.
Preparati per l'implementazione
Prima della distribuzione, devi preparare la tua app CDK.
- Sintetizza la tua app
-
Usa il
cdk synthcomando per sintetizzare lo stack della tua app CDK in un AWS CloudFormation modello.Se hai eseguito la migrazione da un sistema distribuito AWS CloudFormation stack o template, puoi confrontare il modello sintetizzato con il modello migrato per verificare i valori delle risorse e delle proprietà.
Per saperne di più su
cdk synth, vedi Sintetizza gli stack. - Esegui un diff
-
Se hai eseguito la migrazione da un sistema distribuito AWS CloudFormation stack, puoi usare il comando cdk diff per confrontarlo con lo stack nella tua nuova app CDK.
Per saperne di più su cdk diff, vedi Confronta gli stack.
- Avvia il tuo ambiente
-
Se stai eseguendo l'implementazione da un AWS ambiente per la prima volta, usa
cdk bootstrapper preparare il tuo ambiente. Per saperne di più, vedi AWS Bootstrap CDK.
Implementa la tua app CDK
Quando distribuisci un'app CDK, AWS CDK CLI utilizza AWS CloudFormation servizio per fornire le tue risorse. Le risorse sono raggruppate in un unico stack nell'app CDK e distribuite come un unico AWS CloudFormation pila.
A seconda del luogo da cui hai effettuato la migrazione, puoi implementarlo per crearne uno nuovo AWS CloudFormation impila o aggiorna un esistente AWS CloudFormation pila.
- Implementa per crearne uno nuovo AWS CloudFormation pila
-
Se hai eseguito la migrazione da risorse distribuite, AWS CDK CLI ne creerà automaticamente una nuova AWS CloudFormation stack al momento della distribuzione. Le risorse distribuite saranno incluse nel nuovo AWS CloudFormation pila.
Se hai effettuato la migrazione da un locale AWS CloudFormation modello che non è mai stato distribuito, il AWS CDK CLI ne creerà automaticamente un nuovo AWS CloudFormation stack al momento della distribuzione.
Se hai eseguito la migrazione da un sistema distribuito AWS CloudFormation stack o locale AWS CloudFormation modello precedentemente distribuito, è possibile distribuirlo per crearne uno nuovo AWS CloudFormation pila. Per creare un nuovo stack, procedi come segue:
-
Distribuisci su un nuovo AWS ambiente. Ciò consiste nell'utilizzare un diverso AWS account o distribuzione su un altro AWS Regione.
-
Se desideri distribuire un nuovo stack nello stesso AWS ambiente dello stack o del modello migrato, devi modificare il nome dello stack nell'app CDK con un nuovo valore. È inoltre necessario modificare tutti gli ID logici delle risorse nell'app CDK. Quindi, puoi eseguire l'implementazione nello stesso ambiente per creare un nuovo stack e nuove risorse.
-
- Esegui l'implementazione per aggiornare un sistema esistente AWS CloudFormation pila
-
Se hai eseguito la migrazione da un sistema distribuito AWS CloudFormation stack o locale AWS CloudFormation modello precedentemente distribuito, è possibile implementarlo per aggiornare quello esistente AWS CloudFormation pila.
Verifica che il nome dello stack nella tua app CDK corrisponda al nome dello stack distribuito AWS CloudFormation impila e distribuisci sullo stesso AWS ambiente.