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.
Referencia de los comandos AWS CDK CLI
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 también CLI se denomina kit de herramientas CDK.
Uso
$
cdk
<command>
<arguments>
<options>
Comandos
acknowledge, ack
-
Reconozca un aviso por número de publicación y ocúltelo 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
CDKToolkit
, en el entorno. AWS context
-
Administre los valores de contexto almacenados en caché para su aplicación de 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
-
Realice una diferencia para ver los cambios de infraestructura entre las pilas de CDK.
docs, doc
-
Abra la documentación del CDK en su navegador.
doctor
-
Inspeccione y muestre información útil sobre su proyecto de CDK local y su entorno de desarrollo.
import
-
Utilice las importaciones AWS CloudFormation de recursos para importar AWS los recursos existentes a una pila de CDK.
init
-
Cree un nuevo proyecto de CDK a partir de una plantilla.
list, ls
-
Enumere todas las pilas de CDK y sus dependencias de una aplicación de 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
-
Muestre los avisos de su aplicación de 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
-
Observe continuamente un proyecto de CDK local para ver si hay cambios para realizar implementaciones e intercambios en caliente.
Opciones globales
Las siguientes opciones son compatibles con todos los CLI comandos del CDK.
--app, -a
STRING
-
Proporcione 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 de los recursos que utilizan activos.Obligatorio: no
Valor predeterminado:
true
--build
STRING
-
Comando para ejecutar una compilación previa a la síntesis.
Obligatorio: no
--ca-bundle-path
STRING
-
Ruta a un certificado de CA que se utilizará al validar las solicitudes HTTPS.
Si no se proporciona esta opción, la CDK CLI leerá la variable de
AWS_CA_BUNDLE
entorno.Obligatorio: sí
--ci
BOOLEAN
-
Indique que CLI los comandos del CDK se ejecutan en un entorno de integración continua (CI).
Esta opción modifica el comportamiento del CDK CLI 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
-
Agregue parámetros de cadena contextuales como pares clave-valor.
--debug
BOOLEAN
-
Habilite la información de depuración detallada. Esta opción produce un resultado detallado que incluye muchos más detalles sobre lo que hace el CDK entre CLI bastidores.
Obligatorio: no
Valor predeterminado:
false
--ec2creds, -i
BOOLEAN
-
Obligue a la CDK CLI a intentar obtener las credenciales de la instancia de Amazon EC2.
De forma predeterminada, la CDK CLI adivina el estado de la instancia Amazon EC2.
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
-
Ignore los errores de síntesis, ya que probablemente generarán 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 así
false
y es necesario realizar búsquedas de contexto.Obligatorio: no
Valor predeterminado:
true
--no-color
BOOLEAN
-
Elimine 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
-
Especifique el directorio en el que se generará el ensamblaje de nube sintetizado.
Obligatorio: sí
Valor predeterminado:
cdk.out
--path-metadata
BOOLEAN
-
Incluya
aws::cdk::path
AWS CloudFormation los metadatos de 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 solo comando.
Puede configurar esta opción en el
cdk.json
archivo del proyecto o~/.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 CDKCLI.
Obligatorio: sí
--proxy
STRING
-
Utilice el proxy indicado.
Si no se proporciona esta opción, la CDK CLI leerá la variable de
HTTPS_PROXY
entorno.Obligatorio: sí
Valor predeterminado: Leer de la variable de
HTTPS_PROXY
entorno. --role-arn, -r
STRING
-
El ARN de la función de IAM que CLI asumirá la CDK al interactuar con ella. AWS CloudFormation
Obligatorio: no
--staging
BOOLEAN
-
Copie los activos al directorio de salida.
Especifique esta
false
opción para evitar que se copien los activos al directorio de salida. Esto permite AWS SAM CLI hacer referencia a los archivos fuente originales al realizar una depuración local.Obligatorio: no
Valor predeterminado:
true
--strict
BOOLEAN
-
No construya pilas que contengan advertencias.
Obligatorio: no
Valor predeterminado:
false
--trace
BOOLEAN
-
Imprima 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 la verbosidad.
Obligatorio: no
--version
BOOLEAN
-
Muestra el número de versión de la CDK. CLI
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
Proporcionar y configurar opciones
Puede pasar 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 cdk.json
configuración. Cuando se utilizan varias fuentes de configuración, la CDK CLI sigue 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: el
cdk.json
archivo del directorio del proyecto de CDK. -
Archivo de configuración de usuario: el
cdk.json
archivo ubicado~/.cdk.json
en su máquina local.
Pasar las opciones desde la línea de comandos
Pasar valores booleanos
Para las opciones que aceptan un valor booleano, puede especificarlas de las siguientes maneras:
-
Uso
true
yfalse
valores: proporcione 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: modifique el nombre de la opción añadiendo
no
para especificar unfalse
valor. 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.