View a markdown version of this page

cdk orphan - AWS Kit Cloud Development Kit (AWS CDK) v2
De usoArgumentosOpcionesEjemplos

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 orphan

importante

El comando cdk orphan está en la versión preliminar y está sujeto a cambios.

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

Separa de forma segura uno o más recursos de una AWS CloudFormation pila sin eliminarlos. Esto resulta útil cuando necesita migrar un recurso de un tipo de construcción a otro (por ejemplo, migrar un Table DynamoDB TableV2 a) sin tiempo de inactividad ni pérdida de datos.

Cuando se cambia un tipo de construcción en el código CDK, se CloudFormation interpreta como un reemplazo de recurso, lo que elimina el recurso existente y crea uno nuevo. En el caso de los recursos con estado, como las bases de datos y el almacenamiento, esto provoca la pérdida de datos. El cdk orphan comando resuelve este problema separando primero el recurso de la pila, para que puedas volver a importarlo con el nuevo tipo de construcción mediante. cdk import

Con cdk orphan puede:

  • Separa los recursos activos de una pila antes de cambiar su tipo de construcción.

  • Migre entre versiones de construcción (por ejemplo, Table DynamoDB TableV2 a) sin pérdida de datos.

  • Cambie el tipo CloudFormation de recurso que sustenta una construcción sin reemplazar el recurso físico.

El comando orphan realiza tres CloudFormation despliegues:

  1. Resolver referencias: resuelve las referencias cruzadas entre recursos (RefFn::GetAtt,,Fn::Sub) a los recursos huérfanos, de modo que otros recursos de la pila que dependen de ellos sigan funcionando después de eliminar los recursos huérfanos.

  2. Desacoplar: reemplaza todas las referencias entre recursos por sus valores literales resueltos, establece DeletionPolicy y elimina DependsOn las entradas para aislar los recursos del resto de la pila. Retain

  3. Eliminar: elimina los recursos de la CloudFormation plantilla. Los recursos físicos siguen existiendo en su AWS cuenta.

Tras quedar huérfano, actualiza tu código CDK para usar el nuevo tipo de construcción y usa cdk import para volver a administrar el recurso.

Para dejar huérfano un recurso y volver a importarlo con un nuevo tipo de construcción

  1. Despliega tu pila y comprueba que el recurso existe.

  2. Ejecute cdk orphan con la ruta de construcción del recurso:

    $ cdk orphan MyStack/MyTable --unstable=orphan

  3. El comando genera un mapeo de recursos. Guárdalo para el paso de importación.

  4. Actualice el código CDK para usar el nuevo tipo de construcción (por ejemplo, cámbielo Table aTableV2).

  5. Ejecute cdk import con el mapeo de recursos de la salida huérfana:

    $ cdk import MyStack --resource-mapping-inline '{"MyTable":{"TableName":"my-table"}}'

  6. Una vez finalizada la importación, cdk import detecta una desviación y te pide que realices el despliegue. Acepte la solicitud para conciliar la pila.

Esta característica tiene actualmente las siguientes limitaciones:

  • Todas las rutas de construcción deben hacer referencia a la misma pila. No se admite almacenar recursos en varias pilas en un solo comando.

  • No se admiten los patrones comodín. Las rutas coinciden como prefijos exactos.

  • Este comando requiere la versión 32 de la plantilla de arranque, que incluye los permisos de IAM necesarios para la función de implementación.

De uso

$ cdk orphan <PATHS> <options>

Argumentos

RUTAS

Una o más rutas de construcción a orphan, en el formatoStackName/ConstructPath. Por ejemplo, MyStack/MyTable. Se pueden proporcionar varias rutas para dejar huérfanos varios recursos en un solo comando.

Todas las rutas deben hacer referencia a la misma pila.

Tipo: cadena

Obligatorio: sí

Opciones

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

--help, -h <BOOLEAN>

Mostrar la información de referencia para el comando cdk orphan.

Ejemplos

Deja huérfano un solo recurso

$ cdk orphan MyStack/MyTable --unstable=orphan

Huérfanos varios recursos

$ cdk orphan MyStack/MyTable MyStack/MyBucket --unstable=orphan

Omitir el mensaje de confirmación

$ cdk orphan MyStack/MyTable --unstable=orphan --yes