Skip to content
v2.278.0

StageSynthesisOptions Struct ​

Options for assembly synthesis.

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

stage_synthesis_options = cdk.StageSynthesisOptions(
    aspect_stabilization=False,
    error_on_duplicate_synth=False,
    force=False,
    skip_validation=False,
    validate_on_synthesis=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

StageSynthesisOptions stageSynthesisOptions = StageSynthesisOptions.builder()
        .aspectStabilization(false)
        .errorOnDuplicateSynth(false)
        .force(false)
        .skipValidation(false)
        .validateOnSynthesis(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var stageSynthesisOptions = new StageSynthesisOptions {
    AspectStabilization = false,
    ErrorOnDuplicateSynth = false,
    Force = false,
    SkipValidation = false,
    ValidateOnSynthesis = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

stageSynthesisOptions := &StageSynthesisOptions{
	AspectStabilization: jsii.Boolean(false),
	ErrorOnDuplicateSynth: jsii.Boolean(false),
	Force: jsii.Boolean(false),
	SkipValidation: jsii.Boolean(false),
	ValidateOnSynthesis: jsii.Boolean(false),
}

Properties ​

aspectStabilizationoptionalbooleanaspect_stabilizationoptionalboolaspectStabilizationoptionalBooleanAspectStabilizationoptionalboolAspectStabilizationoptional*bool = false #
Whether or not run the stabilization loop while invoking Aspects.
notes

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.

errorOnDuplicateSynthoptionalbooleanerror_on_duplicate_synthoptionalboolerrorOnDuplicateSynthoptionalBooleanErrorOnDuplicateSynthoptionalboolErrorOnDuplicateSynthoptional*bool = true #
Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth.
forceoptionalbooleanforceoptionalboolforceoptionalBooleanForceoptionalboolForceoptional*bool = 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.

skipValidationoptionalbooleanskip_validationoptionalboolskipValidationoptionalBooleanSkipValidationoptionalboolSkipValidationoptional*bool = false #
Should we skip construct validation.
validateOnSynthesisoptionalbooleanvalidate_on_synthesisoptionalboolvalidateOnSynthesisoptionalBooleanValidateOnSynthesisoptionalboolValidateOnSynthesisoptional*bool = false #
Whether the stack should be validated after synthesis to check for error metadata.