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.
Introducción a la biblioteca del kit de herramientas CDK
Comience a utilizar la biblioteca del kit de herramientas de AWS CDK para realizar mediante programación acciones de CDK, como la síntesis y el despliegue, en su código.
Requisitos previos
-
Se ha instalado una versión compatible de Node.js.
-
AWS credenciales configuradas.
-
Familiaridad básica con el AWS CDK.
Para obtener más información, consulte los requisitos previos de la AWS CDK.
Paso 1: Instalación de la biblioteca del kit de herramientas CDK
Instale el paquete de biblioteca del kit de herramientas CDK en el entorno de desarrollo de su proyecto ejecutando lo siguiente:
npm install --save @aws-cdk/toolkit-lib
Paso 2: inicializar la biblioteca del kit de herramientas CDK
Cree una instancia de CDK Toolkit para realizar acciones programáticas en su aplicación CDK.
import { Toolkit } from '@aws-cdk/toolkit-lib'; const toolkit = new Toolkit({ // Optional configuration options go here });
Puedes personalizar la instancia de CDK Toolkit durante la creación. Para obtener instrucciones, consulte Configurar la instancia de CDK Toolkit.
Paso 3: Crear una fuente de ensamblaje en la nube para su aplicación CDK
Una fuente de ensamblaje en la nube proporciona instrucciones para generar CloudFormation plantillas a partir de su aplicación CDK. Puede crear una de varias maneras. A continuación, se muestran algunos ejemplos:
-
Una función de creación de ensamblajes en línea:
import * as cdk from 'aws-cdk-lib'; const cloudAssemblySource = await toolkit.fromAssemblyBuilder(async () => { const app = new cdk.App(); new MyStack(app, 'MyStack'); return app.synth(); });
-
Un archivo de aplicación CDK existente:
const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");
Para obtener más información, consulte Configurar las fuentes de ensamblaje en la nube.
Paso 4: Definir acciones programáticas para su aplicación CDK
Ahora que ha creado una instancia de CDK Toolkit y una fuente de ensamblaje en la nube, puede empezar a definir las acciones programáticas. El siguiente es un ejemplo básico que crea una implementación de la pila: MyStack
import { StackSelectionStrategy } from '@aws-cdk/toolkit-lib'; await toolkit.deploy(cloudAssemblySource, { stacks: { strategy: StackSelectionStrategy.PATTERN_MUST_MATCH, // Deploy only stacks that exactly match the provided patterns patterns: ["MyStack"], }, });
Paso 5: seguir personalizando el kit de herramientas CDK
Puede configurar y personalizar aún más el kit de herramientas del CDK según sus necesidades:
-
Mensajes e interacciones: configure la forma en que el kit de herramientas del CDK se comunica con los usuarios y las aplicaciones. Consulte Configurar mensajes e interacciones.
-
Gestión de errores: Implemente una gestión estructurada de errores para las operaciones de CDK. Consulte Configurar la gestión de errores.
Recursos adicionales
Para obtener más información sobre el paquete de bibliotecas del kit de herramientas CDK, consulte el npm
paquete @aws ReadMenpm
-cdk/toolkit-lib.