interface SynthesisOptions ⚠️

Language	Type name
.NET	`Amazon.CDK.SynthesisOptions`
Java	`software.amazon.awscdk.core.SynthesisOptions`
Python	`aws_cdk.core.SynthesisOptions`
TypeScript (source)	`@aws-cdk/core` » `SynthesisOptions`

⚠️ Deprecated: use app.synth() or stage.synth() instead

Options for synthesis.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from '@aws-cdk/core';
const synthesisOptions: cdk.SynthesisOptions = {
  outdir: 'outdir',
  runtimeInfo: {
    libraries: {
      librariesKey: 'libraries',
    },
  },
  skipValidation: false,
  validateOnSynthesis: false,
};

Properties

Name	Type	Description
outdir?⚠️	`string`	The output directory into which to synthesize the cloud assembly.
runtimeInfo?⚠️	`RuntimeInfo`	Include the specified runtime information (module versions) in manifest.
skipValidation?⚠️	`boolean`	Whether synthesis should skip the validation phase.
validateOnSynthesis?⚠️	`boolean`	Whether the stack should be validated after synthesis to check for error metadata.

outdir?⚠️

⚠️ Deprecated: use app.synth() or stage.synth() instead

Type: string (optional, default: creates a temporary directory)

The output directory into which to synthesize the cloud assembly.

runtimeInfo?⚠️

⚠️ Deprecated: All template modifications that should result from this should have already been inserted into the template.

Type: RuntimeInfo (optional, default: if this option is not specified, runtime info will not be included)

Include the specified runtime information (module versions) in manifest.

skipValidation?⚠️

⚠️ Deprecated: use app.synth() or stage.synth() instead

Type: boolean (optional, default: false)

Whether synthesis should skip the validation phase.

validateOnSynthesis?⚠️

⚠️ Deprecated: use app.synth() or stage.synth() instead

Type: boolean (optional, default: false)

Whether the stack should be validated after synthesis to check for error metadata.