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

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.

cdk synthesize

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

Los ensamblajes en la nube son archivos que incluyen todo lo necesario para implementar la aplicación en su entorno de AWS. Por ejemplo, incluye una plantilla de CloudFormation para cada pila de la aplicación y una copia de los activos de archivos o las imágenes de Docker a los que se hace referencia en la aplicación.

Si la aplicación contiene una sola pila o si se proporciona una sola pila como argumento, la plantilla CloudFormation también se mostrará en la salida estándar (stdout) en formato YAML.

Si la aplicación contiene varias pilas, cdk synth sintetizará el ensamblaje de la nube en cdk.out.

Uso

cdk synthesize <arguments> <options>

Argumentos

ID de pila de CDK

El ID de constructo de la pila del CDK de la aplicación que se va a sintetizar.

Tipo: cadena

Obligatorio: no

Opciones

Para obtener una lista de las opciones globales que funcionan con todos los comandos de la CLI de CDK, consulte Opciones globales.

--exclusively, -e <BOOLEAN>

Sintetice solo las pilas solicitadas, no incluya las dependencias.

--help, -h <BOOLEAN>

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

--quiet, -q <BOOLEAN>

No envíe la plantilla de CloudFormation a stdout.

Esta opción se puede configurar en el archivo cdk.json de proyecto del CDK. A continuación, se muestra un ejemplo:

{
   "quiet": true
}

Valor predeterminado: false

--validation <BOOLEAN>

Valide las plantillas de CloudFormation generadas después de la síntesis mediante comprobaciones adicionales.

También puede configurar esta opción mediante el atributo validateOnSynth o la variable de entorno CDK_VALIDATION.

Valor predeterminado: true

Ejemplos

Sintetice el ensamblaje de la nube para una pila del CDK con el ID lógico MyStackName y envíe la plantilla de CloudFormation a stdout

$ cdk synth MyStackName

Sintetice el ensamblaje en la nube para todas las pilas de una aplicación de CDK y guárdelas en cdk.out

$ cdk synth

Sintetice el ensamblaje en la nube para MyStackName, pero no incluya las dependencias

$ cdk synth MyStackName --exclusively

Sintetice el ensamblaje en la nube para myStackName, pero no envíe la plantilla de CloudFormation a stdout

$ cdk synth MyStackName --quiet