Esta es la guía para desarrolladores del 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.

Migre los recursos existentes y AWS CloudFormation plantillas al AWS CDK

Usa la interfaz de línea de comandos (CLI del AWS CDK) del AWS Cloud Development Kit (AWS CDK) para migrar AWS los recursos implementados, las AWS CloudFormation pilas implementadas y las plantillas locales al CDK. AWS CloudFormation AWS

Cómo funciona la migración

Use el cdk migrate comando de la CLI del AWS CDK para migrar desde las siguientes fuentes:

Beneficios de CDK Migrate

Históricamente, la migración de recursos a un AWS CDK ha sido un proceso manual que, incluso para empezar, requiere tiempo y experiencia con AWS CloudFormation un AWS CDK. Con CDK Migrate, la CLI de AWS CDK facilita la mayor parte del esfuerzo de migración en una fracción del tiempo. CDK Migrate le permitirá empezar rápidamente a usar el AWS CDK para desarrollar y administrar aplicaciones nuevas y existentes. AWS

Consideraciones

Consideraciones generales

Consideraciones a la hora de migrar desde un AWS CloudFormation plantilla

Consideraciones a la hora de realizar migraciones a partir de recursos implementados

Requisitos previos

Antes de usar el cdk migrate comando, complete todos los pasos de configuración que se indican en Primeros pasos con el AWS CDK.

Comience a usar CDK Migrate

Para empezar, ejecute el cdk migrate comando de la CLI del AWS CDK desde el directorio que elija. Elija las opciones obligatorias y optativas, según el tipo de migración que vaya a realizar.

Para obtener una lista completa de las opciones que puede utilizar con cdk migrate con descripciones, consulte cdk migrate.

A continuación, se indican algunas opciones importantes que debería proporcionar.

Migre desde un AWS CloudFormation pila

Para migrar desde una AWS CloudFormation pila implementada, proporcione la --from-stack opción. Introduzca el nombre de la AWS CloudFormation pila implementada con--stack-name. A continuación, se muestra un ejemplo:

$ cdk migrate --from-stack --stack-name "myCloudFormationStack"

La CLI del AWS CDK realizará lo siguiente:

Al migrar desde una AWS CloudFormation pila implementada, la CLI del AWS CDK intenta hacer coincidir los identificadores lógicos de los recursos implementados y el nombre de la AWS CloudFormation pila implementada con los recursos y la pila migrados en la nueva aplicación de CDK.

Después de la migración, puede administrar y modificar su aplicación de CDK con normalidad. Al realizar la implementación, AWS CloudFormation identificará la implementación como una actualización de la AWS CloudFormation pila debido al nombre de la AWS CloudFormation pila correspondiente. Se actualizarán los recursos con ID lógicos coincidentes. Para obtener más información sobre la implementación, consulte Administración e implementación de su aplicación de CDK.

Migre desde un AWS CloudFormation plantilla

CDK Migrate admite la migración desde AWS CloudFormation plantillas formateadas en o. JSON YAML

Para migrar desde una AWS CloudFormation plantilla local, utilice la --from-path opción e indique una ruta a la plantilla local. También debe proporcionar la opción --stack-name requerida. A continuación, se muestra un ejemplo:

$ cdk migrate --from-path "./template.json" --stack-name "myCloudFormationStack"

La CLI del AWS CDK realizará lo siguiente:

Después de la migración, puede administrar y modificar su aplicación de CDK con normalidad. En el momento de la implementación, tiene las siguientes opciones:

Migre desde un AWS SAM template (Plantilla de SAM)

Para migrar desde una plantilla del modelo de aplicaciones AWS sin servidor (AWS SAM), primero debe convertirla en una AWS CloudFormation plantilla o implementarla para crear una AWS CloudFormation pila.

Para convertir una plantilla de AWS SAM a AWS CloudFormation, puede usar el sam validate --debug comando de la CLI de AWS SAM. Es posible que tenga que configurar lint como false en su archivo samconfig.toml antes de ejecutar este comando.

Para convertirla en una AWS CloudFormation pila, implemente la plantilla AWS SAM mediante la CLI de AWS SAM. A continuación, migre los recursos a partir de la pila implementada.

Migración a partir de los recursos implementados

Para migrar desde AWS los recursos implementados, brinde la --from-scan opción. También debe proporcionar la opción --stack-name requerida. A continuación, se muestra un ejemplo:

$ cdk migrate --from-scan --stack-name "myCloudFormationStack"

La CLI del AWS CDK realizará lo siguiente:

Utilice filtros

De forma predeterminada, la CLI del AWS CDK analizará todo el AWS entorno y migrará los recursos hasta el límite máximo de cuota del generador de IaC. Puede proporcionar filtros con la CLI del AWS CDK para especificar los criterios para la migración de los recursos de su cuenta a la nueva aplicación del CDK. Para obtener más información, consulte --filter .

Búsqueda de recursos con el generador IaC

En función del número de recursos en la cuenta, la búsqueda puede tardar unos minutos. Aparecerá una barra de progreso durante el proceso de búsqueda.

Resolución de propiedades de solo escritura

Algunos recursos compatibles contienen propiedades de solo escritura. Estas propiedades se pueden escribir para configurar la propiedad, pero el generador de IaC no las puede leer ni AWS CloudFormation para obtener el valor. Por ejemplo, una propiedad utilizada para especificar la contraseña de una base de datos puede ser de solo escritura por motivos de seguridad.

Al analizar los recursos durante la migración, el generador IaC detectará los recursos que puedan contener propiedades de solo escritura y los clasificará de acuerdo con cualquiera de los siguientes tipos:

Para obtener más información sobre las propiedades de solo escritura y sobre cómo las administra el generador de IaC al buscar recursos implementados y crear AWS CloudFormation plantillas, consulte el generador de IaC y las propiedades de solo escritura en la Guía del usuario. AWS CloudFormation

Después de la migración, debe especificar los valores de las propiedades de solo escritura en la nueva aplicación de CDK. La CLI del AWS CDK añadirá una sección de advertencias al ReadMe archivo del proyecto del CDK para documentar cualquier propiedad de solo escritura que el generador de IaC haya identificado. A continuación, se muestra un ejemplo:

# 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

El archivo migrate.json

La CLI del AWS CDK crea un migrate.json archivo en su proyecto de AWS CDK durante la migración. Este archivo contiene información de referencia sobre los recursos implementados. Cuando implementas tu aplicación de CDK por primera vez, la CLI de AWS CDK usa este archivo para hacer referencia a los recursos implementados, los asocia a la nueva AWS CloudFormation pila y elimina el archivo.

Administración e implementación de su aplicación de CDK

Al migrar a AWS CDK, es posible que la nueva aplicación de CDK no esté lista para su implementación de inmediato. En este tema, se describen las medidas que se deben tener en cuenta al administrar e implementar su nueva aplicación de CDK.

Preparación para la implementación

Antes de la implementación, debe preparar la aplicación de CDK.

Implemente la aplicación de CDK

Cuando implementa una aplicación de CDK, la CLI de AWS CDK utiliza el AWS CloudFormation servicio para aprovisionar sus recursos. Los recursos se agrupan en una sola pila en la aplicación CDK y se implementan como una sola pila. AWS CloudFormation

Según el lugar desde el que hayas migrado, puedes implementarlos para crear una AWS CloudFormation pila nueva o actualizar una pila existente AWS CloudFormation .