cdk import - AWS Cloud Development Kit (AWS CDK) v2
UsoArgumentosOpciones

Esta es la guía para AWS CDK desarrolladores de la versión 2. La versión anterior del CDK v1 entró en mantenimiento el 1 de junio de 2022 y dejó de ofrecer soporte 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 import

Utilice las importaciones AWS CloudFormation de recursos para importar AWS los recursos existentes a una pila de CDK.

Con este comando, puede tomar los recursos existentes que se crearon con otros métodos y empezar a administrarlos mediante el AWS CDK.

Al considerar la posibilidad de transferir recursos a la administración de CDK, a veces es aceptable crear nuevos recursos, como con las funciones de IAM, las funciones de Lambda y las reglas de eventos. En el caso de otros recursos, como los recursos con estado, como los buckets de Amazon S3 y las tablas de DynamoDB, la creación de nuevos recursos puede afectar al servicio. Puede utilizarlos cdk import para importar los recursos existentes con una interrupción mínima de sus servicios. Para obtener una lista de AWS los recursos compatibles, consulte el tema sobre el soporte de tipos de recursos en la Guía del AWS CloudFormation usuario.

Para importar un recurso existente a una pila de CDK

  1. Ejecute una cdk diff para asegurarse de que su pila de CDK no tenga cambios pendientes. Al realizar unacdk import, los únicos cambios que se permiten en una operación de importación son la adición de nuevos recursos que se estén importando.

  2. Agregue componentes fijos para los recursos que desee importar a su pila. Por ejemplo, añada lo siguiente para un bucket de Amazon S3:

    new s3.Bucket(this, 'ImportedS3Bucket', {});

    No añada ningún otro cambio. También debe asegurarse de modelar exactamente el estado que tiene el recurso actualmente. Para el ejemplo del depósito, asegúrate de incluir las AWS KMS claves, las políticas del ciclo de vida y cualquier otra información relevante sobre el depósito. De lo contrario, es posible que las operaciones de actualización posteriores no den los resultados esperados.

  3. Ejecute cdk import. Si hay varias pilas en la aplicación CDK, pasa un nombre de pila específico como argumento.

  4. La CDK CLI le pedirá que introduzca los nombres reales de los recursos que va a importar. Tras proporcionar esta información, se iniciará la importación.

  5. Si el cdk import informe es correcto, el CDK administrará el recurso. Cualquier cambio posterior en la configuración de la construcción se reflejará en el recurso.

Esta característica tiene actualmente las siguientes limitaciones:

  • No es posible importar recursos a pilas anidadas.

  • No se comprueba si las propiedades especificadas son correctas y están completas para el recurso importado. Intente iniciar una operación de detección de desviaciones después de la importación.

  • Los recursos que dependen de otros recursos deben importarse todos juntos o individualmente, en el orden correcto. De lo contrario, la CloudFormation implementación fallará y las referencias no se resolverán.

  • Este comando utiliza las credenciales de la función de despliegue, que son necesarias para leer el depósito provisional cifrado. Esto requiere la versión 12 de la plantilla de arranque, que incluye los permisos de IAM necesarios para la función de implementación.

Uso

$ cdk import <arguments> <options>

Argumentos

ID lógico de la pila de CDK

El ID lógico de la pila de CDK de tu aplicación a la que se van a importar los recursos. Este argumento se puede proporcionar varias veces en un solo comando.

Tipo: cadena

Obligatorio: no

Opciones

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

--change-set-name STRING

El nombre del conjunto de CloudFormation cambios que se va a crear.

--execute BOOLEAN

Especifique si se va a ejecutar el conjunto de cambios.

Valor predeterminado: true

--force, -f BOOLEAN

De forma predeterminada, la CDK CLI sale del proceso si la diferencia de plantillas incluye actualizaciones o eliminaciones. Especifique si true desea anular este comportamiento y continúe siempre con la importación.

--help, -h BOOLEAN

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

--record-resource-mapping, -r STRING

Utilice esta opción para generar un mapeo de los recursos físicos existentes con los recursos de la CDK que se van a importar. La asignación se escribirá en la ruta de archivo que usted proporcione. No se realizará ninguna operación de importación real.

--resource-mapping, -m STRING

Utilice esta opción para especificar un archivo que defina la asignación de recursos. El CDK CLI utilizará este archivo para asignar los recursos físicos a los recursos que se van a importar, en lugar de preguntárselo a usted de forma interactiva.

Esta opción se puede ejecutar desde scripts.

--rollback BOOLEAN

En caso de fallo, restaure la pila a un estado estable.

Para especificarlofalse, puede usar --no-rollback o-R.

Especifique si false desea iterar con mayor rapidez. Las implementaciones que contienen sustituciones de recursos siempre fallarán.

Valor predeterminado: true

--toolkit-stack-name STRING

El nombre de la pila de herramientas de CDK que se va a crear