StageSynthesisOptions

class aws_cdk.StageSynthesisOptions(*, aspect_stabilization=None, error_on_duplicate_synth=None, force=None, skip_validation=None, validate_on_synthesis=None)

Bases: object

Options for assembly synthesis.

Parameters:

  • aspect_stabilization (Optional[bool]) – 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

  • error_on_duplicate_synth (Optional[bool]) – Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth. Default: true

  • force (Optional[bool]) – 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

  • skip_validation (Optional[bool]) – Should we skip construct validation. Default: - false

  • validate_on_synthesis (Optional[bool]) – Whether the stack should be validated after synthesis to check for error metadata. Default: - false

ExampleMetadata:

fixture=_generated

Example:

# 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
)

Attributes

aspect_stabilization

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

error_on_duplicate_synth

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

Default:

true

force

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

skip_validation

Should we skip construct validation.

Default:

  • false

validate_on_synthesis

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

Default:

  • false