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 comando cdk refactor está en la versión preliminar y está sujeto a cambios.

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

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

Al cambiar el nombre de los constructos o moverlos entre pilas del código de CDK, CloudFormation suele tratarlas como recursos nuevos, lo que provoca sustituciones que pueden provocar interrupciones del servicio o la pérdida de datos. El comando cdk refactor detecta estos cambios de forma inteligente y funciona con la API de refactorización de CloudFormation para conservar los recursos y, al mismo tiempo, actualizar sus ID lógicos.

Con cdk refactor puede:

  • Cambie el nombre de los constructos para mayor claridad en su base de código sin tener que sustituir los recursos.

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

  • Reorganice su jerarquía de constructos (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.

  • Realice actualizaciones o modificaciones entre las bibliotecas de constructos de forma segura, incluidas las dependencias de terceros, sin tener que sustituir los recursos cuando los ID lógicos cambien de una versión a otra.

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

Cuando se ejecuta, el comando calcula de forma automática las asignaciones comparando el código actual con el estado implementado. Verifica que la aplicación de CDK contenga exactamente el mismo conjunto de recursos que el estado implementado, y solo se diferencian en sus ubicaciones en el árbol de constructos. El comando detecta la adición, eliminación o modificación de algún recurso, 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 con el fin de resolver estos casos.

Para ver una introducción, consulte Conserve los recursos implementados al refactorizar el código de CDK.

Uso

$ cdk refactor <arguments> <options>

Argumentos

ID de pila de CDK

El ID de constructo de la pila de CDK correspondiente a la aplicación que desea refactorizar.

Puede especificar varios ID de pila 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 para refactorizar incluirá automáticamente la pila adicional en la operación.

Si no indica ningún identificador de pila, 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 de la 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, en especial 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 solicitar confirmación al usuario.

Esto resulta útil en entornos interactivos cuando se tiene confianza en los cambios. En entornos no interactivos, como las canalizaciones de CI/CD, la CLI de CDK avanza de forma automática 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>

Proporciona anulaciones cuando la CLI de CDK no puede 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 por completo una refactorización, debe revertir la aplicación a un estado anterior y volver a ejecutar el proceso de refactorización.