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 dek kit de herramientas de CDK
Comience a usar la biblioteca del kit de herramientas de AWS CDK para realizar de forma programática acciones de CDK, como la síntesis e implementación, en su código.
Requisitos previos
-
Se ha instalado una versión compatible de Node.js.
-
Credenciales de AWS configuradas.
-
Familiaridad básica con AWS CDK.
Para más información, consulte Requisitos previos de AWS CDK.
Paso 1: instalar la biblioteca del kit de herramientas de CDK
Instale el paquete de bibliotecas 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 de CDK
Cree una instancia del kit de herramientas de CDK para realizar acciones programáticas en su aplicación de CDK.
import { Toolkit } from '@aws-cdk/toolkit-lib'; const toolkit = new Toolkit({ // Optional configuration options go here });
Puede personalizar la instancia del kit de herramientas de CDK durante la creación. Para obtener instrucciones, consulte Configurar la instancia del kit de herramientas de CDK.
Paso 3: crear una fuente de ensamblaje en la nube para su aplicación de CDK
Una fuente de ensamblaje en la nube proporciona instrucciones para generar un ensamblaje en la nube a partir de su aplicación de CDK. Puede crear uno de varias maneras. A continuación, se muestran algunos ejemplos:
-
Una función de creación de conjuntos 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 de CDK existente:
const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");
Consulte Configurar las fuentes de ensamblaje en la nube para obtener más información.
Paso 4: definir acciones programáticas para su aplicación de CDK
Ahora que ha creado una instancia del kit de herramientas de CDK y una fuente de ensamblaje en la nube, puede empezar a definir las acciones programáticas. A continuación, se muestra 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 de CDK
Puede configurar y personalizar aún más el kit de herramientas de CDK según sus necesidades:
-
Mensajes e interacciones: configure la forma en que el kit de herramientas de 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 npm de bibliotecas del kit de herramientas de CDK, consulte ReadMenpm @aws-cdk/toolkit-lib.
Para obtener información de referencia sobre la API, consulte la referencia sobre las API de la biblioteca del kit de herramientas de CDK.