Esta es la guía para AWS CDK desarrolladores de la versión 2. La CDK versión anterior entró en mantenimiento el 1 de junio de 2022 y finalizó el 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.
Tutorial: cómo crear su primera aplicación de AWS CDK
Comience a utilizar AWS Cloud Development Kit (AWS CDK) al utilizar la interfaz de la línea de comandos AWS CDK (CLI de AWS CDK) para desarrollar su primera aplicación de CDK, arrancar su entorno de AWS e implementar su aplicación en AWS.
Requisitos previos
Antes de iniciar este tutorial, complete los pasos en Introducción al AWS CDK.
Acerca de este tutorial
En este tutorial, creará e implementará una aplicación sencilla en AWS mediante el uso del AWS CDK. La aplicación consta de una función de AWS Lambda que devuelve un mensaje de Hello World!
cuando se invoca. La función se invocará a través de la URL de la función de Lambda que sirve como punto de conexión HTTP(S) dedicado para la función de Lambda.
A través de este tutorial, hará lo siguiente:
-
Crear su proyecto: cree un proyecto de CDK mediante el comando
cdk init
de la CLI de CDK. -
Configurar su entorno de AWS: configure el entorno de AWS en el que implementará la aplicación.
-
Arrancar su entorno deAWS: prepare su entorno de AWS para la implementación mediante el arranque del comando
cdk bootstrap
de la CLI de CDK. -
Desarrollar su aplicación: utilice constructos de la Biblioteca de constructos de AWS para definir la función de Lambda y los recursos de URL de la función de Lambda.
-
Preparar su aplicación para la implementación: use la CLI de CDK para crear su aplicación y sintetizar una plantilla de AWS CloudFormation.
-
Implementar su aplicación: utilice el comando
cdk deploy
de la CLI de CDK para implementar su aplicación y aprovisionar sus recursos de AWS. -
Interactuar con su aplicación: interactúe con la función de Lambda implementada en AWS al invocarla y recibir una respuesta.
-
Modificar su aplicación: modifique su función de Lambda e impleméntela para aplicar sus cambios.
-
Eliminar la aplicación: elimine todos los recursos creados con el comando
cdk destroy
de la CLI de CDK.
Paso 1: cree su proyecto de CDK
En este paso va a crear un proyecto nuevo de CDK. Un proyecto de CDK debe estar en su propio directorio, con sus propias dependencias de módulos locales.
Para crear un proyecto de CDK
-
Desde el directorio de inicio que elija, cree y navegue hasta un directorio denominado
hello-cdk
:$
mkdir hello-cdk && cd hello-cdk
importante
Asegúrese de asignar un nombre al directorio del proyecto
hello-cdk
, exactamente como se muestra aquí. La CLI de CDK usa este nombre de directorio para nombrar las características del código del CDK. Si utiliza otro nombre de directorio, tendrá problemas durante este tutorial. -
Desde el directorio
hello-cdk
, inicie un nuevo proyecto de CDK a través del comandocdk init
de la CLI de CDK. Especifique la plantilla de laapp
y su lenguaje de programación preferido con la opción--language
:
El comando cdk init
crea una estructura de archivos y carpetas dentro del directorio hello-cdk
para ayudar a organizar el código fuente de la aplicación de CDK. Esta estructura de archivos y carpetas se denomina proyecto de CDK. Tómese un momento para explorar su proyecto de CDK.
Si ha instalado Git, cada proyecto que cree utilizando cdk init
se iniciará como un repositorio de Git.
Durante la inicialización del proyecto, la CLI de CDK crea una aplicación de CDK que contiene una única pila de CDK. La instancia de la aplicación de CDK se crea mediante el constructo App
. La siguiente es una parte de este código del archivo de aplicación de CDK:
La pila de CDK se crea mediante el constructo Stack
. La siguiente es una parte de este código del archivo de pila de CDK:
Paso 2: configure su entorno
En este paso, configurará el entorno de AWS de la pila de CDK. De este modo, podrá especificar en qué entorno se implementará su pila de CDK.
En primer lugar, determine el entorno de AWS que desea utilizar. Un entorno de AWS consta de una Cuenta de AWS y una Región de AWS.
Si usa la AWS CLI para configurar las credenciales de seguridad en su equipo local, puede usar la AWS CLI para obtener información del entorno de AWS para un perfil específico.
Para usar la AWS CLI para obtener su ID de Cuenta de AWS
-
Ejecute el siguiente comando de la AWS CLI para obtener el ID de Cuenta de AWS de su perfil
default
:$
aws sts get-caller-identity --query "Account" --output text
-
Si prefiere utilizar un perfil con nombre, proporcione el nombre de su perfil a través de la opción
--profile
:$
aws sts get-caller-identity --profile
your-profile-name
--query "Account" --output text
Para usar la AWS CLI para obtener su Región de AWS
-
Ejecute el siguiente comando de la AWS CLI para obtener la región que configuró para su perfil
default
:$
aws configure get region
-
Si prefiere utilizar un perfil con nombre, proporcione el nombre de su perfil a través de la opción
--profile
:$
aws configure get region --profile
your-profile-name
A continuación, configurará el entorno de AWS para su pila de CDK modificando la instancia de HelloCdkStack
en el archivo de la aplicación. Para este tutorial, codificará de forma rígida la información de su entorno de AWS. Recomendamos este procedimiento para los entornos de producción. Para obtener información sobre otras formas de configurar entornos, consulte Configuración de los entornos para usarlos con AWS CDK.
Para configurar el entorno de su pila de CDK
-
En el archivo de la aplicación, utilice la propiedad
env
del constructoStack
para configurar el entorno. A continuación, se muestra un ejemplo:
Paso 3: arranque su entorno de AWS
En este paso, arranque el entorno de AWS que ha configurado en el paso anterior. Esto prepara el entorno para las implementaciones de CDK.
Para arrancar su entorno, ejecute lo siguiente desde la raíz de su proyecto de CDK:
$
cdk bootstrap
Al arrancar desde la raíz de su proyecto de CDK, no tiene que proporcionar ninguna información adicional. La CLI de CDK obtiene información sobre el entorno de su proyecto. En el caso de que arranque fuera de un proyecto de CDK, debe proporcionar información sobre el entorno con el comando cdk bootstrap
. Para obtener más información, consulte Inicie su entorno para usarlo con AWS CDK.
Paso 4: cree su aplicación de CDK
En la mayoría de los entornos de programación, el código se crea o compila después de realizar cambios. Esto no es necesario con AWS CDK, ya que la CLI de CDK realizará este paso automáticamente. Sin embargo, puede seguir compilando de forma manual cuando quiera encontrar errores de sintaxis y de tipeo. A continuación, se muestra un ejemplo:
Paso 5: enumere las pilas de CDK de su aplicación
En este punto, debería tener una aplicación de CDK que contenga una sola pila de CDK. Para verificarlo, use el comando cdk list
de la CLI de CDK para mostrar sus pilas. El resultado debe mostrar una sola pila denominada HelloCdkStack
:
$
cdk list
HelloCdkStack
Si no puede ver este resultado, verifique que se encuentra en el directorio de trabajo correcto de su proyecto e inténtelo nuevamente. Si sigue sin ver su pila, repita el proceso Paso 1: cree su proyecto de CDK e inténtelo de nuevo.
Paso 6: defina la función de Lambda
En este paso, importe el módulo aws_lambda
desde la Biblioteca de constructos de AWS y utilice el constructo Function
de nivel 2.
Modifique el archivo de pila de CDK de la siguiente manera:
Examinemos en mayor profundidad al constructo Function
. Como todos los constructos, la clase Function
utiliza tres parámetros:
-
alcance: define la instancia de
Stack
como la matriz del constructoFunction
. Todos los constructos que definen a los recursos de AWS se crean dentro del alcance de una pila. Puede definir constructos dentro de otros constructos, lo cual crea una jerarquía (árbol). Tanto en este como en la mayoría de los casos, el alcance esthis
(self
en Python). -
ID: el ID del constructo de la
Function
dentro de la aplicación de AWS CDK. Este ID, más un hash basado en la ubicación de la función dentro de la pila, identifica de forma exclusiva a la función durante la implementación. El AWS CDK también hace referencia a este ID cuando actualiza el constructo en su aplicación y la vuelve a implementar para actualizar el recurso implementado. Aquí, su ID de constructo esHelloWorldFunction
. Las funciones también pueden tener un nombre, especificado con la propiedadfunctionName
. Esta es diferente al ID del constructo. -
props: agrupación de valores que definen las propiedades de la función. Aquí se definen las propiedades
runtime
,handler
ycode
.Las props se representan de forma diferente en los lenguajes compatibles con el AWS CDK.
-
En TypeScript y JavaScript,
props
es un único argumento al que se le pasa un objeto que contiene las propiedades deseadas. -
En Python, las props se pasan como argumentos de palabras clave.
-
En Java, se proporciona un Builder para pasar las props. Existen dos: uno para
FunctionProps
y otro paraFunction
, con el fin de que pueda construir el constructo y su objeto de props en un solo paso. Este código usa este último. -
En C#, se crea una instancia de un objeto de
FunctionProps
mediante un inicializador de objetos y se pasa como tercer parámetro.
Si las props de un constructo son opcionales, puede omitir el parámetro
props
por completo. -
Todos los constructos utilizan los mismos tres argumentos, por lo que es fácil mantenerse orientado a medida que se aprenden otros nuevos. Y como es de esperar, puede subclasificar cualquier constructo para ampliarlo según sus necesidades o si desea cambiar sus valores predeterminados.
Paso 7: implemente la URL de función de Lambda
En este paso, se utiliza el método auxiliar addFunctionUrl
del constructo Function
para definir la URL de una función de Lambda. Para generar el valor de esta URL en el momento de la implementación, creará una salida de AWS CloudFormation al utilizar el constructo CfnOutput
.
Agregue lo siguiente a su archivo:
aviso
Para simplificar este tutorial, la URL de función de Lambda se define sin autenticación. Cuando se implementa, se crea un punto de conexión de acceso público que se puede utilizar para invocar la función. Cuando termine con este tutorial, siga Paso 12: elimine la aplicación para eliminar estos recursos.
Paso 8: sintetice una plantilla de CloudFormation
En este paso, se prepara para la implementación sintetizando una plantilla de CloudFormation con el comando cdk
synth
de la CLI de CDK. Este comando realiza una validación básica del código de CDK, ejecuta la aplicación de CDK y genera una plantilla de CloudFormation a partir de la pila de CDK.
Si su aplicación contiene más de una pila, debe especificar qué pilas desea sintetizar. Como la aplicación contiene solo una pila, la CLI de CDK detecta automáticamente la pila que se va a sintetizar.
Si no sintetiza una plantilla, la CLI de CDK realizará este paso automáticamente cuando la implemente. Sin embargo, recomendamos que ejecute este paso antes de cada implementación para comprobar si hay errores de síntesis.
Antes de sintetizar una plantilla, si lo desea, puede crear su aplicación para detectar errores de sintaxis y de tipeo. Para obtener instrucciones, consulte Paso 4: cree su aplicación de CDK.
Para sintetizar una plantilla de CloudFormation, ejecute lo siguiente desde la raíz del proyecto:
$
cdk synth
nota
Si recibe un error como el siguiente, verifique que está en el directorio hello-cdk
e inténtelo de nuevo:
--app is required either in command-line, in cdk.json or in ~/.cdk.json
Si se ejecuta correctamente, la CLI de CDK generará una plantilla con formato de YAML de CloudFormation para stdout
y guardará una plantilla con formato de JSON en el directorio cdk.out
de su proyecto.
A continuación, se muestra un ejemplo de resultado de la plantilla de CloudFormation:
Resources: HelloWorldFunctionServiceRole
unique-identifier
: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Statement: - Action: sts:AssumeRole Effect: Allow Principal: Service: lambda.amazonaws.com Version: "2012-10-17" ManagedPolicyArns: - Fn::Join: - "" - - "arn:" - Ref: AWS::Partition - :iam::aws:policy/service-role/AWSLambdaBasicExecutionRole Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/ServiceRole/Resource HelloWorldFunctionunique-identifier
: Type: AWS::Lambda::Function Properties: Code: ZipFile: " \ exports.handler = async function(event) { \ return { \ statusCode: 200, \ body: JSON.stringify('Hello World!'), \ }; \ }; \ " Handler: index.handler Role: Fn::GetAtt: - HelloWorldFunctionServiceRoleunique-identifier
- Arn Runtime: nodejs20.x DependsOn: - HelloWorldFunctionServiceRoleunique-identifier
Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/Resource HelloWorldFunctionFunctionUrlunique-identifier
: Type: AWS::Lambda::Url Properties: AuthType: NONE TargetFunctionArn: Fn::GetAtt: - HelloWorldFunctionunique-identifier
- Arn Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/FunctionUrl/Resource HelloWorldFunctioninvokefunctionurlunique-identifier
: Type: AWS::Lambda::Permission Properties: Action: lambda:InvokeFunctionUrl FunctionName: Fn::GetAtt: - HelloWorldFunctionunique-identifier
- Arn FunctionUrlAuthType: NONE Principal: "*" Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/invoke-function-url CDKMetadata: Type: AWS::CDK::Metadata Properties: Analytics: v2:deflate64:unique-identifier
Metadata: aws:cdk:path: HelloCdkStack/CDKMetadata/Default Condition: CDKMetadataAvailable Outputs: myFunctionUrlOutput: Value: Fn::GetAtt: - HelloWorldFunctionFunctionUrlunique-identifier
- FunctionUrl Parameters: BootstrapVersion: Type: AWS::SSM::Parameter::Value<String> Default: /cdk-bootstrap/unique-identifier
/version Description: Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip] Rules: CheckBootstrapVersion: Assertions: - Assert: Fn::Not: - Fn::Contains: - - "1" - "2" - "3" - "4" - "5" - Ref: BootstrapVersion AssertDescription: CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI.
nota
Cada plantilla generada contiene un recurso AWS::CDK::Metadata
de forma predeterminada. El equipo de AWS CDK utiliza estos metadatos para obtener información sobre el uso de AWS CDK y encontrar formas de mejorarlo. Para obtener más información, incluyendo cómo optar por no informar la versión, consulte Informes de versiones.
Al definir un único constructo de nivel 2, el AWS CDK crea una amplia plantilla de CloudFormation que contiene los recursos de Lambda, junto con los permisos y la lógica de enlace necesarios para que los recursos interactúen dentro de la aplicación.
Paso 9: implemente su pila de CDK
En este paso, utilice el comando cdk deploy
de la CLI de CDK para implementar su pila de CDK. Este comando recupera la plantilla de CloudFormation generada y la implementa a través de AWS CloudFormation, lo que aprovisiona los recursos como parte de una pila de CloudFormation.
Desde el directorio raíz del proyecto, ejecute lo siguiente. Confirme los cambios si se le solicita:
$
cdk deploy
✨ Synthesis time: 2.69s HelloCdkStack: start: Buildingunique-identifier
:current_account-current_region HelloCdkStack: success: Builtunique-identifier
:current_account-current_region HelloCdkStack: start: Publishingunique-identifier
:current_account-current_region HelloCdkStack: success: Publishedunique-identifier
:current_account-current_region This deployment will make potentially sensitive changes according to your current security approval level (--require-approval broadening). Please confirm you intend to make the following modifications: IAM Statement Changes ┌───┬───────────────────────────────────────┬────────┬──────────────────────────┬──────────────────────────────┬───────────┐ │ │ Resource │ Effect │ Action │ Principal │ Condition │ ├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${HelloWorldFunction.Arn} │ Allow │ lambda:InvokeFunctionUrl │ * │ │ ├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${HelloWorldFunction/ServiceRole.Arn} │ Allow │ sts:AssumeRole │ Service:lambda.amazonaws.com │ │ └───┴───────────────────────────────────────┴────────┴──────────────────────────┴──────────────────────────────┴───────────┘ IAM Policy Changes ┌───┬───────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ │ Resource │ Managed Policy ARN │ ├───┼───────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │ + │ ${HelloWorldFunction/ServiceRole} │ arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole │ └───┴───────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘ (NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299) Do you wish to deploy these changes (y/n)?y
Del mismo modo que cdk synth
, no es necesario especificar la pila de AWS CDK, ya que la aplicación contiene una sola pila.
Durante la implementación, la CLI de CDK muestra información sobre el progreso a medida que se implementa la pila. Cuando haya terminado, podrá ir a la consola de AWS CloudFormationHelloCdkStack
. También puede ir a la consola de Lambda para ver el recurso HelloWorldFunction
.
Cuando la implementación esté completa, la CLI de CDK generará la URL de su punto de conexión. Copie esta URL para el siguiente paso. A continuación, se muestra un ejemplo:
... HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset... ✅ HelloCdkStack ✨ Deployment time: 41.65s Outputs: HelloCdkStack.myFunctionUrlOutput = https://
<api-id>
.lambda-url.<Region>
.on.aws/ Stack ARN: arn:aws:cloudformation:Region
:account-id
:stack/HelloCdkStack/unique-identifier
✨ Total time: 44.34s
Paso 10: interactúe con su aplicación en AWS
En este paso, interactúe con la aplicación en AWS a través de la invocación de la función de Lambda mediante la URL de función. Al acceder a la URL, la función de Lambda devuelve el mensaje de Hello World!
.
Para invocar la función, acceda a la URL de función a través del navegador o desde la línea de comandos. A continuación, se muestra un ejemplo:
$
curl https://
"Hello World!"%<api-id>
.lambda-url.<Region>
.on.aws/
Paso 11: modifique su aplicación
En este paso, modifique el mensaje que la función de Lambda devuelve cuando se invoca. Para realizar una diferencia, utilice el comando cdk diff
de la CLI de CDK para obtener una vista previa de los cambios y realizar una implementación para actualizar la aplicación. A continuación, interactúe con la aplicación en AWS para ver el nuevo mensaje.
Modifique la instancia de myFunction
en su archivo de pila de CDK de la siguiente manera:
Actualmente, los cambios en el código no han realizado ninguna actualización directa en el recurso de Lambda implementado. El código define el estado deseado del recurso. Para modificar el recurso implementado, utilizará la CLI de CDK para sintetizar el estado deseado en una nueva plantilla de AWS CloudFormation. A continuación, implementará la nueva plantilla de CloudFormation como un conjunto de cambios. Los conjuntos de cambios solo realizan cambios necesarios para alcanzar el nuevo estado deseado.
Para obtener una vista previa de los cambios, ejecute el comando cdk diff
. A continuación, se muestra un ejemplo:
$
cdk diff
Stack HelloCdkStack Hold on while we create a read-only change set to get a diff with accurate replacement information (use --no-change-set to use a less accurate but faster template-only diff) Resources [~] AWS::Lambda::Function HelloWorldFunction HelloWorldFunctionunique-identifier
└─ [~] Code └─ [~] .ZipFile: ├─ [-] exports.handler = async function(event) { return { statusCode: 200, body: JSON.stringify('Hello World!'), }; }; └─ [+] exports.handler = async function(event) { return { statusCode: 200, body: JSON.stringify('Hello CDK!'), }; }; ✨ Number of stacks with differences: 1
Para crear esta diferencia, la CLI de CDK necesita su cuenta de Cuenta de AWS para obtener la plantilla de AWS CloudFormation más reciente de la pila HelloCdkStack
. A continuación, compare la plantilla más reciente con la plantilla que acaba de sintetizar en su aplicación.
Para implementar los cambios, ejecute el comando cdk deploy
. A continuación, se muestra un ejemplo:
$
cdk deploy
✨ Synthesis time: 2.12s HelloCdkStack: start: Buildingunique-identifier
:current_account-current_region HelloCdkStack: success: Builtunique-identifier
:current_account-current_region HelloCdkStack: start: Publishingunique-identifier
:current_account-current_region HelloCdkStack: success: Publishedunique-identifier
:current_account-current_region HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset... ✅ HelloCdkStack ✨ Deployment time: 26.96s Outputs: HelloCdkStack.myFunctionUrlOutput = https://unique-identifier
.lambda-url.<Region>
.on.aws/ Stack ARN: arn:aws:cloudformation:Region
:account-id
:stack/HelloCdkStack/unique-identifier
✨ Total time: 29.07s
Para integrar su aplicación, repita Paso 10: interactúe con su aplicación en AWS. A continuación, se muestra un ejemplo:
$
curl https://
"Hello CDK!"%<api-id>
.lambda-url.<Region>
.on.aws/
Paso 12: elimine la aplicación
En este paso, utilice el comando cdk destroy
de la CLI de CDK para eliminar su aplicación. Este comando elimina la pila de CloudFormation asociada a la pila de CDK, la cual comprende los recursos que ha creado.
Para eliminar la aplicación, ejecute el comando cdk destroy
y confirme la solicitud para eliminar la aplicación. A continuación, se muestra un ejemplo:
$
cdk destroy
Are you sure you want to delete: HelloCdkStack (y/n)?y
HelloCdkStack: destroying... [1/1] ✅ HelloCdkStack: destroyed
Siguientes pasos
¡Enhorabuena! Ha completado el tutorial y lo ha utilizado el AWS CDK para crear, modificar y eliminar correctamente los recursos de Nube de AWS. Ahora tiene todo listo para empezar a usar el AWS CDK.
Para obtener más información sobre el uso del AWS CDK en su lenguaje de programación preferido, consulte Trabajar con la biblioteca de AWS CDK.
Para obtener más ayuda, consulte los siguientes recursos:
-
Para realizar un recorrido más detallado sobre un proyecto más complejo, pruebe CDK Workshop
. -
Consulte API referenc para empezar a explorar los constructos de CDK disponibles para sus servicios favoritos de AWS.
-
Visite Construct Hub
para descubrir constructos creados por AWS y otros. -
Explore Examples
sobre el uso del AWS CDK.
El AWS CDK es un proyecto de código abierto. Para contribuir, consulte Contributing to the AWS Cloud Development Kit (AWS CDK)