AWS CDK CLI Referencia de los comandos

Modo de enfoque

AWS CDK CLI Referencia de los comandos - AWS Cloud Development Kit (AWS CDK) v2

Uso Comandos Opciones globales Cómo proporcionar y configurar opciones Cómo transferir las opciones en la línea de comandos

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

Esta sección contiene información de referencia de comandos para la interfaz de línea de AWS Cloud Development Kit (AWS CDK) comandos (CLI). El CDK CLI también se conoce como el kit de herramientas 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: Prepare un AWS entorno para las implementaciones de CDK mediante la implementación de la pila bootstrap de CDK, denominada, en el entorno. CDKToolkit 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. AWS
destroy: Elimine una o más pilas de CDK de su entorno. 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.
import: Utilice las importaciones AWS CloudFormation de recursos para importar AWS los recursos 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 AWS los recursos, las AWS CloudFormation pilas y AWS CloudFormation las plantillas a un nuevo proyecto de CDK.
notices: Muestra los avisos de su aplicación CDK.
synthesize, synth: Sintetice una aplicación de CDK para crear un ensamblaje en la nube que incluya una AWS CloudFormation plantilla 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 CDK CLI comandos.

--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 aws:asset:* AWS CloudFormation metadatos 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, el CDK CLI leerá desde la variable de AWS_CA_BUNDLE entorno.

Obligatorio: sí

--ci BOOLEAN

Indique ese CDK CLI los comandos se ejecutan en un entorno de integración continua (CI).

Esta opción modifica el comportamiento de la CDK CLI para adaptarse 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 detallado que incluye muchos más detalles sobre lo que es el CDK CLI está haciendo entre bastidores.

Obligatorio: no

Valor predeterminado: false

--ec2creds, -i BOOLEAN

Forza el CDK CLI para intentar obtener las credenciales de la EC2 instancia de Amazon.

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

Obligatorio: no

Valor predeterminado: false

--help, -h BOOLEAN

Muestra la información de referencia de comandos del CDK CLI.

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

Usa JSON en lugar de YAML para AWS CloudFormation las plantillas 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 aws::cdk::path AWS CloudFormation metadatos para cada recurso.

Obligatorio: no

Valor predeterminado: true

--plugin, -p ARRAY

Nombre o ruta de un node paquete que amplía las funciones 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

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

Obligatorio: sí

--proxy STRING

Utiliza el proxy indicado.

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

Obligatorio: sí

Valor predeterminado: lee de la variable de entorno HTTPS_PROXY.

--role-arn, -r STRING

El ARN de la función de IAM que desempeña el CDK CLI 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 AWS SAM CLI para hacer referencia a los archivos fuente originales al realizar una 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 CDK CLI número de versión.

Obligatorio: no

Valor predeterminado: false

--version-reporting BOOLEAN

Incluya el AWS::CDK::Metadata recurso en las AWS CloudFormation plantillas 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 CDK CLI se ajusta a la siguiente prioridad:

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.
Archivo de configuración del proyecto: es el archivo cdk.json del directorio del proyecto de CDK.
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.