Class: AWSCDK::StageSynthesisOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
stage_synthesis_options.rb

Overview

Options for assembly synthesis.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aspect_stabilization: nil, error_on_duplicate_synth: nil, force: nil, skip_validation: nil, validate_on_synthesis: nil) ⇒ StageSynthesisOptions

Returns a new instance of StageSynthesisOptions.

Parameters:

  • aspect_stabilization (Boolean, nil) (defaults to: nil) —

    Whether or not run the stabilization loop while invoking Aspects.

  • error_on_duplicate_synth (Boolean, nil) (defaults to: nil) —

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

  • force (Boolean, nil) (defaults to: nil) —

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

  • skip_validation (Boolean, nil) (defaults to: nil) —

    Should we skip construct validation.

  • validate_on_synthesis (Boolean, nil) (defaults to: nil) —

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



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'stage_synthesis_options.rb', line 12

def initialize(aspect_stabilization: nil, error_on_duplicate_synth: nil, force: nil, skip_validation: nil, validate_on_synthesis: nil)
  @aspect_stabilization = aspect_stabilization
  Jsii::Type.check_type(@aspect_stabilization, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "aspectStabilization") unless @aspect_stabilization.nil?
  @error_on_duplicate_synth = error_on_duplicate_synth
  Jsii::Type.check_type(@error_on_duplicate_synth, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "errorOnDuplicateSynth") unless @error_on_duplicate_synth.nil?
  @force = force
  Jsii::Type.check_type(@force, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "force") unless @force.nil?
  @skip_validation = skip_validation
  Jsii::Type.check_type(@skip_validation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "skipValidation") unless @skip_validation.nil?
  @validate_on_synthesis = validate_on_synthesis
  Jsii::Type.check_type(@validate_on_synthesis, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateOnSynthesis") unless @validate_on_synthesis.nil?
end

Instance Attribute Details

#aspect_stabilization ⇒ Boolean? (readonly)

Note:

Default: false

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.

Returns:

  • (Boolean, nil) 


34
35
36
 
# File 'stage_synthesis_options.rb', line 34

def aspect_stabilization
  @aspect_stabilization
end

#error_on_duplicate_synth ⇒ Boolean? (readonly)

Note:

Default: true

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

Returns:

  • (Boolean, nil) 


39
40
41
 
# File 'stage_synthesis_options.rb', line 39

def error_on_duplicate_synth
  @error_on_duplicate_synth
end

#force ⇒ Boolean? (readonly)

Note:

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.

Returns:

  • (Boolean, nil) 


47
48
49
 
# File 'stage_synthesis_options.rb', line 47

def force
  @force
end

#skip_validation ⇒ Boolean? (readonly)

Note:

Default: - false

Should we skip construct validation.

Returns:

  • (Boolean, nil) 


52
53
54
 
# File 'stage_synthesis_options.rb', line 52

def skip_validation
  @skip_validation
end

#validate_on_synthesis ⇒ Boolean? (readonly)

Note:

Default: - false

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

Returns:

  • (Boolean, nil) 


57
58
59
 
# File 'stage_synthesis_options.rb', line 57

def validate_on_synthesis
  @validate_on_synthesis
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'stage_synthesis_options.rb', line 59

def self.jsii_properties
  {
    :aspect_stabilization => "aspectStabilization",
    :error_on_duplicate_synth => "errorOnDuplicateSynth",
    :force => "force",
    :skip_validation => "skipValidation",
    :validate_on_synthesis => "validateOnSynthesis",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'stage_synthesis_options.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "aspectStabilization" => @aspect_stabilization,
    "errorOnDuplicateSynth" => @error_on_duplicate_synth,
    "force" => @force,
    "skipValidation" => @skip_validation,
    "validateOnSynthesis" => @validate_on_synthesis,
  })
  result.compact
end