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

Questa è la AWS CDK v2 Developer Guide. 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à.

cdk refactor

Importante

Il cdk refactor comando è in versione di anteprima ed è soggetto a modifiche.

È necessario fornire l'--unstable=refactoropzione quando si utilizza questo comando.

Conserva le risorse distribuite durante il refactoring del codice nella tua applicazione AWS Cloud Development Kit (AWS CDK).

Quando rinomini i costrutti o li sposti tra gli stack del codice CDK, in genere li consideri come nuove risorse, provocando sostituzioni che CloudFormation potrebbero portare a interruzioni del servizio o alla perdita di dati. Il cdk refactor comando rileva in modo intelligente queste modifiche e funziona con l'API di refactoring per preservare le risorse CloudFormation aggiornandone al contempo la logica. IDs

Con il cdk refactor puoi:

  • Rinomina i costrutti per una maggiore chiarezza nella tua base di codice senza dover sostituire le risorse.

  • Sposta le risorse tra gli stack per migliorare l'organizzazione e la separazione delle preoccupazioni.

  • Riorganizza la gerarchia dei costrutti (ad esempio raggruppando le risorse AWS in un nuovo costrutto L3) preservando al contempo le risorse cloud sottostanti.

  • Aggiorna o passa in sicurezza da una libreria di costruzione all'altra, comprese le dipendenze di terze parti, senza attivare la sostituzione delle risorse in caso di modifica logica tra le versioni. IDs

Questo comando analizza le modifiche, mostra un elenco di risorse che cambieranno posizione (stack e ID logico) e gestisce il complesso processo di aggiornamento delle CloudFormation risorse mantenendone l'identità e lo stato.

Quando viene eseguito, il comando calcola automaticamente le mappature confrontando il codice corrente con lo stato distribuito. Verifica che l'applicazione CDK contenga esattamente lo stesso set di risorse dello stato distribuito, che differiscono solo nella loro posizione nell'albero di costruzione. Se il comando rileva aggiunte, eliminazioni o modifiche alle risorse, l'operazione di refactoring verrà rifiutata con un messaggio di errore.

Dopo la mappatura del calcolo, il comando mostra le modifiche proposte e, dopo la conferma dell'utente, applica il refactoring. Se viene rilevata un'ambiguità (laddove sono possibili più mappature valide), è possibile fornire un file di override con mappature esplicite per risolvere questi casi.

Per un'introduzione, consulta Preservare le risorse distribuite durante il refactoring del codice CDK.

Utilizzo

$ cdk refactor <arguments> <options>

Argomenti

ID dello stack CDK

L'ID di costruzione dello stack CDK dell'app da refactorizzare.

È possibile specificare più stack IDs per concentrare l'operazione di refactoring su tali stack. Se le risorse vengono spostate tra gli stack e uno di questi stack non è incluso in modo esplicito, il comando refactor includerà automaticamente lo stack aggiuntivo nell'operazione.

Se non fornisci alcuno stack IDs, tutti gli stack dell'app verranno presi in considerazione per il refactoring.

▬Tipo: stringa

Required: No

Opzioni

Per un elenco di opzioni globali che funzionano con tutti i comandi CDK CLI, vedete Opzioni globali.

--dry-run

Stampa la mappatura sulla console senza applicarla.

Questa opzione è utile per convalidare le modifiche prima di eseguire effettivamente il refactoring, specialmente quando si lavora con applicazioni complesse. Mostra esattamente quali modifiche verrebbero apportate senza modificare alcuna risorsa.

--force

Procedi con il refactoring senza richiedere conferma all'utente.

Ciò è utile in ambienti interattivi quando si è certi delle modifiche. In ambienti non interattivi come CI/CD le pipeline, la CLI CDK procede automaticamente senza chiedere conferma, quindi questa opzione non è necessaria.

--help, -h <BOOLEAN>

Mostra le informazioni di riferimento del comando. cdk refactor

--override-file <FILE>

Fornisci eccezioni quando la CLI CDK non è in grado di determinare una risoluzione di refactoring per le risorse. Questo file contiene mappature delle risorse in formato JSON. Di seguito è riportato un esempio:

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

Ripristina un refactor precedente. È necessario fornire un file di override con le mappature delle risorse.

Ciò non annulla completamente una precedente operazione di rifattorizzazione. Per ripristinare completamente un refactor, devi ripristinare l'app a uno stato precedente ed eseguire nuovamente il processo di refactoring.