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

Esta es la guía para desarrolladores de AWS CDK v2. La primera versión del CDK pasó a la etapa de mantenimiento el 1.° de junio de 2022 y no cuenta con soporte desde el 1.° de junio de 2023.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

cdk refactor

importante

El cdk refactor comando se encuentra en una versión preliminar y está sujeto a cambios.

Debe proporcionar la --unstable=refactor opción cuando utilice este comando.

Preserve los recursos desplegados al refactorizar el código en su aplicación AWS Cloud Development Kit (AWS CDK).

Cuando cambias el nombre de las construcciones o las mueves entre pilas en el código de tu CDK, normalmente las tratas como recursos nuevos, CloudFormation lo que provoca sustituciones que podrían provocar interrupciones del servicio o la pérdida de datos. El cdk refactor comando detecta estos cambios de forma inteligente y funciona con la API de refactorización para conservar los recursos y, al CloudFormation mismo tiempo, actualizar su lógica. IDs

Con cdk refactor puede:

  • Cambia el nombre de las construcciones para mayor claridad en tu base de código sin tener que reemplazar los recursos.

  • Mueva los recursos entre pilas para mejorar la organización y la separación de las preocupaciones.

  • Reorganice su jerarquía de construcción (por ejemplo, agrupando los recursos de AWS en una nueva estructura de nivel 3) y, al mismo tiempo, conserve los recursos de la nube subyacentes.

  • Actualice o cambie de una biblioteca de compilación de forma segura, incluidas las dependencias de terceros, sin tener que sustituir los recursos cuando se produzca un cambio lógico entre versiones. IDs

Este comando analiza los cambios, muestra una lista de los recursos que cambiarán de ubicación (pila e identificador lógico) y gestiona el complejo proceso de actualizar CloudFormation los recursos sin perder su identidad y estado.

Cuando se ejecuta, el comando calcula automáticamente las asignaciones comparando el código actual con el estado desplegado. Verifica que la aplicación de CDK contenga exactamente el mismo conjunto de recursos que el estado desplegado, y solo se diferencian en sus ubicaciones en el árbol de construcción. Si el comando detecta alguna adición, eliminación o modificación de recursos, la operación de refactorización se rechazará con un mensaje de error.

Tras el cálculo del mapeo, el comando muestra los cambios propuestos y, tras la confirmación del usuario, aplica la refactorización. Si se detecta ambigüedad (si es posible realizar varias asignaciones válidas), puede proporcionar un archivo de anulación con asignaciones explícitas para resolver estos casos.

Para obtener una introducción, consulte Preservar los recursos desplegados al refactorizar el código CDK.

Uso

$ cdk refactor <arguments> <options>

Argumentos

ID de pila de CDK

El ID de construcción de la pila de CDK de la aplicación que se va a refactorizar.

Puedes especificar varias pilas IDs para centrar la operación de refactorización en esas pilas. Si los recursos se mueven entre pilas y una de esas pilas no está incluida de forma explícita, el comando refactorizar incluirá automáticamente la pila adicional en la operación.

Si no proporcionas ninguna pila IDs, se tendrán en cuenta todas las pilas de la aplicación para la refactorización.

Tipo: cadena

Obligatorio: no

Opciones

Para obtener una lista de las opciones globales que funcionan con todos los comandos CLI de CDK, consulte Opciones globales.

--dry-run

Imprima el mapeo en la consola sin aplicarlo.

Esta opción resulta útil para validar los cambios antes de realizar realmente la refactorización, especialmente cuando se trabaja con aplicaciones complejas. Muestra exactamente qué cambios se realizarían sin modificar ningún recurso.

--force

Continúe con la refactorización sin pedir confirmación al usuario.

Esto resulta útil en entornos interactivos cuando se tiene confianza en los cambios. En entornos no interactivos, como CI/CD las canalizaciones, la CLI de CDK avanza automáticamente sin solicitar información, por lo que esta opción no es necesaria.

--help, -h <BOOLEAN>

Muestra la información de referencia del comando cdk refactor.

--override-file <FILE>

Proporcione anulaciones cuando la CLI de CDK no pueda determinar una resolución de refactorización para los recursos. Este archivo contiene asignaciones de recursos en formato JSON. A continuación, se muestra un ejemplo:

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

Revierte una refactorización anterior. Debe proporcionar un archivo de anulación con las asignaciones de recursos.

Esto no deshace por completo una operación de refactorización anterior. Para revertir completamente una refactorización, debes revertir la aplicación a un estado anterior y volver a ejecutar el proceso de refactorización.