cdk watch - AWS Cloud Development Kit (AWS CDK) v2
UsoArgumentosOpcionesEjemplos

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.

cdk watch

Observe continuamente un AWS CDK proyecto local para ver si hay cambios para realizar despliegues e intercambios en caliente.

Este comando es similar acdk deploy, excepto que puede realizar despliegues continuos e intercambios en caliente mediante un único comando.

Este comando es un método abreviado de. cdk deploy --watch

Para finalizar una cdk watch sesión, interrumpa el proceso pulsandoCtrl+C.

Los archivos que se observan vienen determinados por la "watch" configuración del cdk.json archivo. Tiene dos subclaves "include" y "exclude" acepta una sola cadena o una matriz de cadenas. Cada entrada se interpreta como una ruta relativa a la ubicación del cdk.json archivo. **Se aceptan ambas*.

Si crea un proyecto mediante el cdk init comando, se configura el siguiente comportamiento predeterminado cdk watch en el cdk.json archivo del proyecto:

  • "include"está configurado en"**/*", que incluye todos los archivos y directorios de la raíz del proyecto.

  • "exclude"es opcional, excepto en el caso de los archivos y carpetas que ya se han ignorado de forma predeterminada. Se compone de archivos y directorios que comienzan por., el directorio CDK de salida y el node_modules directorio.

La configuración mínima a configurar watch es"watch": {}.

Si el CDK código o el código de la aplicación requieren un paso de compilación antes de la implementación, cdk watch funciona con la "build" clave del cdk.json archivo.

nota

Este comando se considera experimental y puede tener cambios importantes en el futuro.

Las mismas limitaciones se cdk deploy --hotswap aplican acdk watch. Para obtener más información, consulte cdk deploy --hotswap.

Uso

$ cdk watch <arguments> <options>

Argumentos

CDKID de pila

El ID de construcción de la CDK pila de la aplicación que quieres ver.

Tipo: cadena

Obligatorio: no

Opciones

Para obtener una lista de las opciones globales que funcionan con todas CDK CLI comandos, consulteOpciones globales.

--build-exclude, -E ARRAY

No reconstruya el activo con el ID indicado.

Esta opción se puede especificar varias veces en un solo comando.

Valor predeterminado: []

--change-set-name STRING

El nombre del conjunto de CloudFormation cambios que se va a crear.

--concurrency NUMBER

Implemente e intercambie en caliente varias pilas en paralelo y, al mismo tiempo, tenga en cuenta las dependencias entre pilas. Utilice esta opción para acelerar las implementaciones. Aun así, debe tener en cuenta CloudFormation otros límites Cuenta de AWS de velocidad.

Proporcione un número para especificar el número máximo de despliegues simultáneos (si la dependencia lo permite) que se deben realizar.

Valor predeterminado: 1

--exclusively, -e BOOLEAN

Implemente únicamente las pilas solicitadas y no incluya las dependencias.

--force, -f BOOLEAN

Implemente siempre las pilas, incluso si las plantillas son idénticas.

Valor predeterminado: false

--help, -h BOOLEAN

Muestra la información de referencia del cdk watch comando.

--hotswap BOOLEAN

De forma predeterminada, cdk watch utiliza las implementaciones de hotswap cuando es posible para actualizar los recursos. El CDK CLI intentará realizar una implementación de hotswap y no recurrirá a una CloudFormation implementación completa si no tiene éxito. Se ignoran los cambios detectados que no se puedan actualizar mediante un intercambio en caliente.

Valor predeterminado: true

--hotswap-fallback BOOLEAN

De forma predeterminada, cdk watch intenta realizar despliegues de hotswap e ignora los cambios que requieren despliegues. CloudFormation Se utiliza como alternativa y --hotswap-fallback realizar una CloudFormation implementación completa si la implementación de hotswap no tiene éxito.

--logs BOOLEAN

De forma predeterminada, cdk watch supervisa todos los grupos de CloudWatch registros de la aplicación y transmite los eventos de registro localmente a stdout ellos.

Valor predeterminado: true

--progress STRING

Configure cómo CDK CLI muestra el progreso de la implementación.

  • bar— Muestra los eventos de despliegue de la pila como una barra de progreso, con los eventos del recurso que se está desplegando actualmente.

  • events— Proporcione un historial completo, incluidos todos los CloudFormation eventos.

También puedes configurar esta opción en el cdk.json archivo del proyecto o ~/.cdk.json en tu máquina de desarrollo local:

{
   "progress": "events"
}

Valores válidos: bar, events

Valor predeterminado: bar

--rollback BOOLEAN

Durante la implementación, si no se puede crear o actualizar un recurso, la implementación volverá al estado estable más reciente antes de CDK CLI devuelve. Todos los cambios realizados hasta ese momento se anularán. Los recursos que se crearon se eliminarán y las actualizaciones que se hayan realizado se revertirán.

Utilice --no-rollback o -R para desactivar este comportamiento. Si no se puede crear o actualizar un recurso, CDK CLI dejará en su lugar los cambios realizados hasta ese momento y regresará. Esto puede resultar útil en entornos de desarrollo en los que se realiza una iteración rápida.

nota

Cuandofalse, las implementaciones que provocan la sustitución de recursos siempre fallan. Solo puede usar este valor para las implementaciones que actualicen o creen nuevos recursos.

Valor predeterminado: true

--toolkit-stack-name STRING

El nombre de la pila de kits de CDK herramientas existente.

De forma predeterminada, cdk bootstrap despliega una pila con un nombre CDKToolkit en el entorno especificado AWS . Utilice esta opción para proporcionar un nombre diferente a la pila de bootstrap.

El CDK CLI usa este valor para verificar la versión de la pila de bootstrap.

Ejemplos

Observe si hay cambios en una CDK pila con un identificador DevelopmentStack lógico

$ cdk watch DevelopmentStack
Detected change to 'lambda-code/index.js' (type: change). Triggering 'cdk deploy'
DevelopmentStack: deploying...

 ✅  DevelopmentStack

Configure un archivo cdk.json para saber qué incluir y qué excluir para que no se supervisen los cambios

{
   "app": "mvn -e -q compile exec:java",
   "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
   }
}

Cree un proyecto usando CDK Java antes de la implementación configurando el archivo cdk.json

{
  "app": "mvn -e -q exec:java",
  "build": "mvn package",
  "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
  }
}