Esta es la segunda versión de la Guía para desarrolladores de AWS CDK. 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.

Implementar aplicaciones de AWS CDK

Una implementación de AWS Cloud Development Kit (AWS CDK) es el proceso de aprovisionamiento de la infraestructura de AWS.

Funcionamiento de las implementaciones de AWS CDK

El AWS CDK utiliza el servicio de AWS CloudFormation para realizar implementaciones. Antes de la implementación, se sintetizan las pilas de CDK. Esto crea una plantilla de CloudFormation y artefactos de implementación para cada pila de CDK de la aplicación. Las implementaciones se inician desde una máquina de desarrollo local o desde un entorno de integración y entrega continuas (CI/CD). Durante la implementación, los activos se cargan en los recursos de inicio y la plantilla de CloudFormation se envía a CloudFormation para aprovisionar los recursos de AWS.

Para que la implementación se realice correctamente, se requiere lo siguiente:

Requisitos previos para las implementaciones de CDK

Antes de poder implementar una aplicación de AWS CDK, debe ejecutar los siguientes pasos:

Configuración de credenciales de seguridad

Para utilizar la CLI del CDK a la hora de interactuar con AWS, debe configurar las credenciales de seguridad en su máquina local. Para obtener instrucciones, consulte Configuración de las credenciales de seguridad para la CLI de AWS CDK.

Inicie su entorno de AWS

Una implementación siempre está asociada a uno o más entornos de AWS. Antes de poder realizar la implementación, primero se debe iniciar el entorno. El inicio aprovisiona recursos en su entorno que el CDK utiliza para realizar y gestionar las implementaciones. Estos recursos incluyen un bucket de Amazon Simple Storage Service (Amazon S3) y un repositorio de Amazon Elastic Container Registry (Amazon ECR) para almacenar y gestionar los activos. Estos recursos también incluyen roles AWS Identity and Access Management (IAM) que se utilizan para proporcionar permisos durante el desarrollo y la implementación.

Le recomendamos que utilice el comando cdk bootstrap de la interfaz de línea de comandos del AWS CDK (la CLI del AWS CDK) para iniciar el entorno. Si es necesario, puede personalizar el inicio o crear estos recursos manualmente en su entorno. Para obtener instrucciones, consulte Arranque su entorno para utilizarlo con AWS CDK.

Configure los entornos de AWS

Cada pila del CDK debe estar asociada a un entorno para determinar dónde se implementa la pila. Para obtener instrucciones, consulte Configuración de los entornos para usarlos con AWS CDK.

Desarrolle su aplicación del CDK

Dentro de un proyecto de CDK, usted crea y desarrolla su aplicación de CDK. Dentro de la aplicación, se crean una o más pilas de CDK. Dentro de sus pilas, puede importar y usar constructos de la Biblioteca de constructos de AWS para definir su infraestructura. Antes de poder implementarla, la aplicación de CDK debe contener al menos una pila.

Síntesis de aplicaciones del CDK

Para realizar la síntesis, le recomendamos que utilice el comando cdk synth de la CLI del CDK. El comando cdk deploy también realizará una síntesis antes de iniciar la implementación. Sin embargo, usando cdk synth, puede validar su aplicación de CDK y detectar errores antes de iniciar la implementación.

El comportamiento de la síntesis está determinado por el sintetizador de pila que configure para la pila del CDK. Si no configura un sintetizador, se utilizará DefaultStackSynthesizer. También puede configurar y personalizar la síntesis para que se adapte a sus necesidades. Para obtener instrucciones, consulte Configurar y realizar la síntesis de pilas de CDK.

Para que la plantilla sintetizada de CloudFormation se implemente correctamente en su entorno, debe ser compatible con la forma en que se inició su entorno. Por ejemplo, la plantilla de CloudFormation debe especificar el bucket de Amazon S3 correcto en el que implementar los activos. Si utiliza el método predeterminado para iniciar su entorno, el sintetizador de pilas predeterminado funcionará. Si personaliza el comportamiento del CDK, por ejemplo, si personaliza el inicio o la síntesis, el comportamiento de implementación del CDK puede variar.

El ciclo de vida de la aplicación

Al realizar la síntesis, la aplicación del CDK pasa por las siguientes fases, conocidas como el ciclo de vida de la aplicación:

Ejecute una aplicación

La CLI del CDK necesita saber cómo ejecutar su aplicación de CDK. Si creó el proyecto a partir de una plantilla mediante el comando cdk init, el archivo cdk.json de su aplicación incluye una clave de app. Esta clave especifica el comando necesario para el lenguaje en el que está escrita la aplicación. Si su lenguaje requiere compilación, la línea de comandos realiza este paso antes de ejecutar la aplicación automáticamente.

TypeScript

{
  "app": "npx ts-node --prefer-ts-exts bin/my-app.ts"
}

JavaScript

{
  "app": "node bin/my-app.js"
}

Python

{
    "app": "python app.py"
}

Java

{
  "app": "mvn -e -q compile exec:java"
}

C#

{
  "app": "dotnet run -p src/MyApp/MyApp.csproj"
}

Go

{
  "app": "go mod download && go run my-app.go"
}

Si no creó su proyecto con la CLI del CDK o si desea anular la línea de comandos incluida en cdk.json, puede proporcionar la opción --app al ejecutar el comando cdk.

$ cdk --app 'executable' cdk-command ...

La parte ejecutable del comando indica el comando que debe ejecutarse para ejecutar la aplicación CDK. Use las comillas como se muestra, ya que estos comandos contienen espacios. cdk-command es un subcomando similar a synth o deploy que le indica a la CLI del CDK lo que quiere hacer con su aplicación. Siga esto con cualquier opción adicional necesaria para ese subcomando.

La CLI del CDK también puede interactuar directamente con un montaje en la nube ya sintetizado. Para ello, pase el directorio en el que está almacenado el montaje en la nube en --app. En el siguiente ejemplo, se enumeran las pilas definidas en el montaje en la nube almacenado en ./my-cloud-assembly.

$ cdk --app ./my-cloud-assembly ls

Montajes en la nube

La llamada a app.synth() es lo que le indica al AWS CDK que hay que sintetizar un montaje en la nube a partir de una aplicación. Por lo general, no se interactúa directamente con los montajes en la nube. Son archivos que incluyen todo lo necesario para implementar la aplicación en un entorno de nube. Por ejemplo, incluye una plantilla de AWS CloudFormation para cada pila de la aplicación. También incluye una copia de cualquier archivo, activo o imagen de Docker a los que haga referencia en su aplicación.

Consulte la especificación del montaje en la nube para obtener detalles sobre el formato de los montajes en la nube.

Para interactuar con el montaje en la nube que crea su aplicación de AWS CDK, normalmente usará la CLI de AWS CDK. Sin embargo, se puede usar cualquier herramienta que pueda leer el formato del montaje en la nube para implementar su aplicación.

Implementar la aplicación

Para implementar la aplicación, le recomendamos que utilice el comando cdk deploy de la CLI del CDK para iniciar las implementaciones o configurar las implementaciones automatizadas.

Cuando ejecuta cdk deploy, la CLI del CDK inicia cdk synth para prepararse para la implementación. En el siguiente diagrama, se ilustra el ciclo de vida de una aplicación en el contexto de una implementación:

Durante la implementación, la CLI del CDK toma el montaje en la nube producido por la síntesis y lo implementa en un entorno de AWS. Los activos se cargan en Amazon S3 y Amazon ECR y la plantilla de CloudFormation se envía a AWS CloudFormation para su implementación.

Cuando comience la fase de implementación de AWS CloudFormation, su aplicación de CDK ya habrá terminado de ejecutarse y se habrá cerrado. Esto tiene las siguientes implicaciones:

Permisos de implementación

Antes de poder realizar la implementación, se deben establecer los permisos. El siguiente diagrama ilustra los permisos que se utilizan durante una implementación predeterminada, cuando se utiliza el proceso de inicio y el sintetizador de pilas predeterminados: