Referencia de los comandos de la CLI de AWS CDK - AWS Cloud Development Kit (AWS CDK) v2
UsoComandosOpciones globalesCómo proporcionar y configurar opcionesCómo transferir las opciones en la línea de comandos

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.

Referencia de los comandos de la CLI de AWS CDK

Esta sección contiene la información de referencia para el comando de la interfaz de la línea de comandos (CLI) del AWS Cloud Development Kit (AWS CDK) La CLI del CDK también se conoce como kit de herramientas de CDK.

Uso

$ cdk <command> <arguments> <options>

Comandos

acknowledge ack

Identifica un aviso por el número de incidencia y lo oculta para que no se vuelva a mostrar.

bootstrap

Prepara un entorno de AWS para las implementaciones de CDK mediante la pila de arranque de CDK, denominada CDKToolkit, en el entorno de AWS.

context

Administra los valores de contexto almacenados en la memoria caché para su aplicación CDK.

deploy

Implemente una o más pilas de CDK en su entorno de AWS.

destroy

Elimina una o más pilas de CDK de su entorno de AWS.

diff

Ejecuta diff para ver los cambios en la infraestructura entre las pilas de CDK.

docs doc

Abre la documentación de CDK en su navegador.

doctor

Inspecciona y muestra información útil sobre su entorno de desarrollo y proyecto de CDK locales.

drift

Detecte desviaciones en la configuración de los recursos que defina, gestione e implemente mediante el CDK.

flags

Vea y modifique las configuraciones de su marca de características para la CLI de CDK.

import

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

init

Crea un nuevo proyecto de CDK a partir de una plantilla.

list, ls

Enumera todas las pilas de CDK y sus dependencias de una aplicación CDK.

metadata

Muestra los metadatos asociados a una pila de CDK.

migrate

Migre los recursos de AWS, las pilas de AWS CloudFormation y las plantillas de AWS CloudFormation a un nuevo proyecto de CDK.

notices

Muestra los avisos de su aplicación CDK.

refactor

Preserve los recursos implementados al refactorizar el código en su aplicación de CDK.

synthesize, synth

Sintetiza una aplicación CDK para crear un ensamblaje en la nube que incluya una plantilla de AWS CloudFormation para cada pila.

watch

Vigila de forma continua un proyecto CDK local en busca de cambios para realizar implementaciones e intercambios en caliente.

Opciones globales

Las siguientes opciones son compatibles con todos los comandos de la CLI de CDK.

--app, -a <STRING>

Proporciona el comando para ejecutar la aplicación o el directorio de ensamblaje de la nube.

Obligatorio: sí

--asset-metadata <BOOLEAN>

Incluye metadatos aws:asset:* de AWS CloudFormation para los recursos que utilizan activos.

Obligatorio: no

Valor predeterminado: true

--build <STRING>

Es el comando para ejecutar una compilación previa a la síntesis.

Obligatorio: no

--ca-bundle-path <STRING>

Es la ruta a un certificado de CA que se utilizará al validar las solicitudes HTTPS.

Si no se proporciona esta opción, la CLI de CDK leerá de la variable de entorno AWS_CA_BUNDLE.

Obligatorio: sí

--ci <BOOLEAN>

Indica que los comandos de la CLI de CDK se ejecutan en un entorno de integración continua (CI).

Esta opción modifica el comportamiento de la CLI de CDK para adaptarlo mejor a las operaciones automatizadas típicas de las canalizaciones de CI.

Cuando se proporciona esta opción, los registros se envían a stdout, en lugar de stderr.

Obligatorio: no

Valor predeterminado: false

--context, -c <ARRAY>

Agrega parámetros de cadena contextuales como pares clave-valor.

--debug <BOOLEAN>

Habilita la información de depuración detallada. Esta opción produce un resultado minucioso que incluye muchos más detalles sobre lo que hace la CLI de CDK en segundo plano.

Obligatorio: no

Valor predeterminado: false

--ec2creds, -i <BOOLEAN>

Obliga a la CLI de CDK a intentar obtener las credenciales de la instancia de Amazon EC2.

De forma predeterminada, la CLI de CDK adivina el estado de la instancia de Amazon EC2.

Obligatorio: no

Valor predeterminado: false

--help, -h <BOOLEAN>

Muestra la información de referencia del comando para la CLI de CDK.

Obligatorio: no

Valor predeterminado: false

--ignore-errors <BOOLEAN>

Ignora los errores de síntesis, ya que es probable que generen un resultado no válido.

Obligatorio: no

Valor predeterminado: false

--json, -j <BOOLEAN>

Utiliza JSON en lugar de YAML para las plantillas de AWS CloudFormation que se imprimen en la salida estándar (stdout).

Obligatorio: no

Valor predeterminado: false

--lookups <BOOLEAN>

Realiza búsquedas de contexto.

La síntesis fallará si este valor es false y es necesario realizar búsquedas de contexto.

Obligatorio: no

Valor predeterminado: true

--no-color <BOOLEAN>

Elimina el color y otros estilos de la salida de la consola.

Obligatorio: no

Valor predeterminado: false

--notices <BOOLEAN>

Muestra los avisos relevantes.

Obligatorio: no

Valor predeterminado: false

--output, -o <STRING>

Especifica el directorio en el que se generará el ensamblaje de la nube sintetizado.

Obligatorio: sí

Valor predeterminado: cdk.out

--path-metadata <BOOLEAN>

Incluye los metadatos aws::cdk::path de AWS CloudFormation de cada recurso.

Obligatorio: no

Valor predeterminado: true

--plugin, -p <ARRAY>

Nombra o establece la ruta de un paquete de nodos que amplía las características de CDK. Esta opción se puede proporcionar varias veces en un mismo comando.

Puede configurar esta opción en el archivo cdk.json del proyecto o en ~/.cdk.json en su máquina de desarrollo local:

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

Obligatorio: no

--profile <STRING>

Especifica el nombre del perfil de AWS que contiene la información de su entorno de AWS, para usarlo con la CLI de CDK.

Obligatorio: sí

--proxy <STRING>

Utiliza el proxy indicado.

Si no se proporciona esta opción, la CLI de CDK leerá de la variable de entorno HTTPS_PROXY.

Obligatorio: sí

Valor predeterminado: lee de la variable de entorno HTTPS_PROXY.

--role-arn, -r <STRING>

Es el ARN del rol de IAM que la CLI de CDK asumirá al interactuar con AWS CloudFormation.

Obligatorio: no

--staging <BOOLEAN>

Copia los activos al directorio de salida.

Especifica false para evitar que se copien los activos al directorio de salida. Esto permite que la CLI de AWS SAM haga referencia a los archivos de origen originales al realizar la depuración local.

Obligatorio: no

Valor predeterminado: true

--strict <BOOLEAN>

No crea pilas que contengan advertencias.

Obligatorio: no

Valor predeterminado: false

--trace <BOOLEAN>

Imprime el rastro de las advertencias de pila.

Obligatorio: no

Valor predeterminado: false

--verbose, -v <COUNT>

Muestra los registros de depuración. Puede especificar esta opción varias veces para aumentar el nivel de detalle.

Obligatorio: no

--version <BOOLEAN>

Muestre el número de versión de la CLI de CDK.

Obligatorio: no

Valor predeterminado: false

--version-reporting <BOOLEAN>

Incluya el recurso AWS::CDK::Metadata en las plantillas de AWS CloudFormation sintetizadas.

Obligatorio: no

Valor predeterminado: true

Cómo proporcionar y configurar opciones

Puede transferir las opciones a través de los argumentos de la línea de comandos. Para la mayoría de las opciones, puede configurarlas en un archivo de configuración cdk.json. Cuando se utilizan varias fuentes de configuración, la CLI de CDK sigue la siguiente prioridad:

  1. Valores de la línea de comandos: cualquier opción proporcionada en la línea de comandos anula las opciones configuradas en los archivos cdk.json.

  2. Archivo de configuración del proyecto: es el archivo cdk.json del directorio del proyecto de CDK.

  3. Archivo de configuración de usuario: es el archivo cdk.json ubicado en ~/.cdk.json en su máquina local.

Cómo transferir las opciones en la línea de comandos

Transfiera valores booleanos

En el caso de las opciones que aceptan un valor booleano, puede especificarlas de estas dos maneras:

  • Use los valores true y false: esto proporciona el valor booleano con el comando. A continuación, se muestra un ejemplo:

    $ cdk deploy --watch=true
$ cdk deploy --watch=false

  • Proporcione la contraparte de la opción: esto modifica el nombre de la opción mediante el agregado de no para especificar un valor false. A continuación, se muestra un ejemplo:

    $ cdk deploy --watch
$ cdk deploy --no-watch

  • En el caso de las opciones cuyo valor predeterminado es true ofalse, no es necesario que proporcione la opción a menos que desee cambiar el valor predeterminado.