Package software.amazon.awscdk

Interface StageSynthesisOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StageSynthesisOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:13.022Z")
@Stability(Stable)
public interface StageSynthesisOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.*;
 StageSynthesisOptions stageSynthesisOptions = StageSynthesisOptions.builder()
         .aspectStabilization(false)
         .errorOnDuplicateSynth(false)
         .force(false)
         .skipValidation(false)
         .validateOnSynthesis(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StageSynthesisOptions.Builder	A builder for StageSynthesisOptions
static final class	StageSynthesisOptions.Jsii$Proxy	An implementation for StageSynthesisOptions

Method Summary

Modifier and Type	Method	Description
static StageSynthesisOptions.Builder	builder()
default Boolean	getAspectStabilization()	Whether or not run the stabilization loop while invoking Aspects.
default Boolean	getErrorOnDuplicateSynth()	Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth.
default Boolean	getForce()	Force a re-synth, even if the stage has already been synthesized.
default Boolean	getSkipValidation()	Should we skip construct validation.
default Boolean	getValidateOnSynthesis()	Whether the stack should be validated after synthesis to check for error metadata.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAspectStabilization

@Stability(Stable)
@Nullable
default Boolean getAspectStabilization()

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.

Default: false

getErrorOnDuplicateSynth

@Stability(Stable)
@Nullable
default Boolean getErrorOnDuplicateSynth()

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

Default: true

getForce

@Stability(Stable)
@Nullable
default Boolean getForce()

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.

Default: false

getSkipValidation

@Stability(Stable)
@Nullable
default Boolean getSkipValidation()

Should we skip construct validation.

Default: - false

getValidateOnSynthesis

@Stability(Stable)
@Nullable
default Boolean getValidateOnSynthesis()

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

Default: - false

builder

@Stability(Stable)
static StageSynthesisOptions.Builder builder()

Returns:

a StageSynthesisOptions.Builder of StageSynthesisOptions