interface StageSynthesisOptions

Language	Type name
.NET	Amazon.CDK.StageSynthesisOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2#StageSynthesisOptions
Java	software.amazon.awscdk.StageSynthesisOptions
Python	aws_cdk.StageSynthesisOptions
TypeScript (source)	aws-cdk-lib » StageSynthesisOptions

Options for assembly 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-lib';
const stageSynthesisOptions: cdk.StageSynthesisOptions = {
  aspectStabilization: false,
  errorOnDuplicateSynth: false,
  force: false,
  skipValidation: false,
  validateOnSynthesis: false,
};

Properties

Name	Type	Description
aspectStabilization?	boolean	Whether or not run the stabilization loop while invoking Aspects.
errorOnDuplicateSynth?	boolean	Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth.
force?	boolean	Force a re-synth, even if the stage has already been synthesized.
skipValidation?	boolean	Should we skip construct validation.
validateOnSynthesis?	boolean	Whether the stack should be validated after synthesis to check for error metadata.

---

aspectStabilization?

Type: boolean (optional, default: false)

Whether or not run the stabilization loop while invoking Aspects.

The stabilization loop runs multiple passes of the construct tree when invoking Aspects. Without the stabilization loop, Aspects that are created by other Aspects are not run and new nodes that are created at higher points on the construct tree by an Aspect will not inherit their parent aspects.

---

errorOnDuplicateSynth?

Type: boolean (optional, default: true)

Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth.

---

force?

Type: boolean (optional, default: false)

Force a re-synth, even if the stage has already been synthesized.

This is used by tests to allow for incremental verification of the output. Do not use in production.

---

skipValidation?

Type: boolean (optional, default: false)

Should we skip construct validation.

---

validateOnSynthesis?

Type: boolean (optional, default: false)

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