Esta es la guía para AWS CDK desarrolladores de la versión 2. 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 AWS los recursos, las AWS CloudFormation pilas y CloudFormation las plantillas implementados a un nuevo AWS CDK proyecto.
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 el uso de cdk migrate
, consulte Migre los recursos y AWS CloudFormation plantillas existentes a 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 CDK CLI comandos, consulteOpciones 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 desplegados desde un AWS entorno, utilice esta opción para especificar si se debe iniciar un nuevo análisis o si AWS CDK CLI debe utilizar el último análisis realizado correctamente.
Obligatorio: condicional. Necesario al migrar desde AWS recursos desplegados.
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: El AWS CDK CLI obtiene la información de la cuenta de las fuentes predeterminadas.
--compress
BOOLEAN
-
Proporcione esta opción para comprimir el proyecto de CDK generado en un ZIP file.
Obligatorio: no
--filter
ARRAY
-
Se usa al migrar recursos implementados desde una AWS cuenta y. Región de 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, especifiqueresource-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 conmyTagKey
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 condicionalOR
. El siguiente ejemplo filtra cualquier recurso de DynamoDB o que esté etiquetado conmyTagKey
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, el AWS CDK CLI utilizará su directorio de trabajo actual.
--region
STRING
-
El Región de AWS para recuperar la plantilla de AWS CloudFormation pila.
Obligatorio: no
Predeterminado: El AWS CDK CLI obtiene Región de AWS informació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 es un ejemplo que myCloudFormationStack
migra a una nueva aplicación de CDK que utiliza 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 que crea una nueva aplicación de CDK en TypeScript que incluye una myCloudFormationStack
pila de un template.json
archivo local:
$
cdk migrate --stack-name "myCloudFormationStack" --language typescript --from-path "./template.json"
Ejemplo sencillo de migración desde recursos desplegados AWS
Migre AWS los recursos desplegados desde un AWS entorno específico que no estén asociados a una CloudFormation pila utilizando--from-scan
. El CDK. CLI utiliza el IaC generator servicio para buscar recursos y generar una plantilla. Luego, el CDK CLI hace referencia a la plantilla para crear la nueva aplicación CDK. El siguiente es un ejemplo que crea una nueva aplicación CDK en TypeScript con una nueva myCloudFormationStack
pila que contiene AWS los recursos migrados:
$
cdk migrate --language typescript --from-scan --stack-name "myCloudFormationStack"