Interface IStageSynthesisOptions

Options for assembly synthesis.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IStageSynthesisOptions

Syntax (vb)

Public Interface IStageSynthesisOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// 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
};

Synopsis

Properties

AspectStabilization	Whether or not run the stabilization loop while invoking Aspects.
ErrorOnDuplicateSynth	Whether or not to throw a warning instead of an error if the construct tree has been mutated since the last synth.
Force	Force a re-synth, even if the stage has already been synthesized.
SkipValidation	Should we skip construct validation.
ValidateOnSynthesis	Whether the stack should be validated after synthesis to check for error metadata.

Properties

AspectStabilization

Whether or not run the stabilization loop while invoking Aspects.

virtual Nullable<bool> AspectStabilization { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

ErrorOnDuplicateSynth

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

virtual Nullable<bool> ErrorOnDuplicateSynth { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

Force

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

virtual Nullable<bool> Force { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: false

SkipValidation

Should we skip construct validation.

virtual Nullable<bool> SkipValidation { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

ValidateOnSynthesis

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

virtual Nullable<bool> ValidateOnSynthesis { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false