cdk migrate - AWS Kit Cloud Development Kit (AWS CDK) v2

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 migrate

Migre AWS los recursos, las AWS CloudFormation pilas y las CloudFormation plantillas implementados a un nuevo proyecto de AWS CDK.

Este comando crea una nueva aplicación del CDK. En ella, se incluye una única pila que recibe el nombre del valor que usted proporciona con --stack-name. Puede configurar el origen de la migración con --from-scan, --from-stack o --from-path.

Para obtener más información sobre su usocdk migrate, consulte Migrar los recursos y AWS CloudFormation plantillas existentes a la AWS CDK.

nota

El comando cdk migrate es experimental y es posible que se someta a cambios importantes en el futuro.

Uso

$ cdk migrate <options>

Opciones

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

Opciones obligatorias

--stack-name <STRING>

El nombre de la AWS CloudFormation pila que se creará en la aplicación CDK tras la migración.

Obligatorio: sí

Opciones condicionales

--from-path <PATH>

La ruta a la AWS CloudFormation plantilla que se va a migrar. Proporcione esta opción para especificar una plantilla local.

Obligatorio: condicional. Obligatorio si se migra desde una AWS CloudFormation plantilla local.

--from-scan <STRING>

Al migrar los recursos implementados desde un AWS entorno, use esta opción para especificar si se debe iniciar un nuevo escaneo o si la AWS CLI de CDK debe usar el último escaneo exitoso.

Obligatorio: condicional. Se requiere cuando se migra desde recursos implementados. AWS

Valores aceptados: most-recent, new

--from-stack <BOOLEAN>

Proporcione esta opción para migrar desde una AWS CloudFormation pila implementada. Se utiliza --stack-name para especificar el nombre de la AWS CloudFormation pila implementada.

Obligatorio: condicional. Necesario si se migra desde una AWS CloudFormation pila implementada.

Opciones no obligatorias

--account <STRING>

La cuenta de la que se va a recuperar la plantilla de AWS CloudFormation pila.

Obligatorio: no

Predeterminado: la CLI de AWS CDK obtiene la información de la cuenta de las fuentes predeterminadas.

--compress <BOOLEAN>

Se brinda esta opción para comprimir el proyecto de CDK generado en un archivo ZIP.

Obligatorio: no

--filter <ARRAY>

Se utiliza al migrar los recursos desplegados desde una AWS cuenta y una región. AWS Esta opción especifica un filtro para determinar qué recursos implementados se van a migrar.

Esta opción acepta una matriz de pares clave-valor, donde la clave representa el tipo de filtro y el valor representa el contenido que se va a filtrar.

Se aceptan las siguientes claves:

  • resource-identifier: el identificador del recurso. El valor puede ser el ID lógico o físico del recurso. Por ejemplo, resource-identifier="ClusterName".

  • resource-type-prefix— El prefijo del tipo de AWS CloudFormation recurso. Por ejemplo, especifique resource-type-prefix="AWS::DynamoDB::" para filtrar todos los recursos de Amazon DynamoDB.

  • tag-key: la clave de una etiqueta de recurso. Por ejemplo, tag-key="myTagKey".

  • tag-value: el valor de una etiqueta de recurso. Por ejemplo, tag-value="myTagValue".

Proporcione varios pares clave-valor para la lógica condicional AND. El siguiente ejemplo filtra cualquier recurso de DynamoDB que esté etiquetado con myTagKey como la clave de la etiqueta: --filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey".

Proporcione la opción --filter varias veces con un solo comando para la lógica condicional OR. El siguiente ejemplo filtra cualquier recurso de DynamoDB o que esté etiquetado con myTagKey como la clave de la etiqueta: --filter resource-type-prefix="AWS::DynamoDB::" --filter tag-key="myTagKey".

Obligatorio: no

--help, -h <BOOLEAN>

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

--language <STRING>

El lenguaje de programación que se utilizará en el proyecto de CDK creado durante la migración.

Obligatorio: no

Valores válidos: typescript, python, java, csharp, go.

Valor predeterminado: typescript

--output-path <PATH>

La ruta de salida del proyecto de CDK migrado.

Obligatorio: no

Predeterminado: de forma predeterminada, la CLI de AWS CDK utilizará su directorio de trabajo actual.

--region <STRING>

La AWS región de la que se va a recuperar la plantilla de AWS CloudFormation pila.

Obligatorio: no

Predeterminado: la CLI de la AWS CDK obtiene la información de AWS la región de las fuentes predeterminadas.

Ejemplos

Ejemplo sencillo de migración desde una pila CloudFormation

Migre desde una CloudFormation pila implementada en un AWS entorno específico utilizando--from-stack. Indique --stack-name para asignar un nombre a su nueva pila de CDK. El siguiente código es un ejemplo que migra myCloudFormationStack a una nueva aplicación de CDK que está utilizando TypeScript:

$ cdk migrate --language typescript --from-stack --stack-name 'myCloudFormationStack'

Ejemplo sencillo de migración desde una plantilla local CloudFormation

Migre desde una CloudFormation plantilla JSON o YAML local utilizando. --from-path Indique --stack-name para asignar un nombre a su nueva pila de CDK. El siguiente es un ejemplo en el que se crea una nueva aplicación de CDK TypeScript que incluye una myCloudFormationStack pila de un archivo localtemplate.json:

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

Ejemplo sencillo de migración desde recursos implementados AWS

Migre AWS los recursos desplegados desde un AWS entorno específico que no estén asociados a una CloudFormation pila utilizando--from-scan. La CLI de CDK utiliza la IaC generator servicio para buscar recursos y generar una plantilla. A continuación, la CLI de la CDK hace referencia a la plantilla para crear la nueva aplicación de la CDK. El siguiente es un ejemplo en el que se crea una nueva aplicación de CDK TypeScript con una myCloudFormationStack pila nueva que contiene los recursos migrados: AWS

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