aws-cdk-lib.StageSynthesisOptions

interface StageSynthesisOptions

LanguageType name
.NETAmazon.CDK.StageSynthesisOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2#StageSynthesisOptions
Javasoftware.amazon.awscdk.StageSynthesisOptions
Pythonaws_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 = {
  force: false,
  skipValidation: false,
  validateOnSynthesis: false,
};

Properties

NameTypeDescription
force?booleanForce a re-synth, even if the stage has already been synthesized.
skipValidation?booleanShould we skip construct validation.
validateOnSynthesis?booleanWhether the stack should be validated after synthesis to check for error metadata.

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.