Class: AWSCDK::Pipelines::Wave

Inherits:
Jsii::Object
  • Object
show all
Defined in:
pipelines/wave.rb

Overview

Multiple stages that are deployed in parallel.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, props = nil) ⇒ Wave

Returns a new instance of Wave.

Parameters:



10
11
12
13
14
15
 
# File 'pipelines/wave.rb', line 10

def initialize(id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Pipelines::WaveProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuV2F2ZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
 
# File 'pipelines/wave.rb', line 17

def self.jsii_overridable_methods
  {
    :id => { kind: :property, name: "id", is_optional: false },
    :post => { kind: :property, name: "post", is_optional: false },
    :pre => { kind: :property, name: "pre", is_optional: false },
    :stages => { kind: :property, name: "stages", is_optional: false },
    :add_post => { kind: :method, name: "addPost", is_optional: false },
    :add_pre => { kind: :method, name: "addPre", is_optional: false },
    :add_stage => { kind: :method, name: "addStage", is_optional: false },
  }
end

Instance Method Details

#add_post(*steps) ⇒ void

This method returns an undefined value.

Add an additional step to run after all of the stages in this wave.

Parameters:



61
62
63
64
65
66
 
# File 'pipelines/wave.rb', line 61

def add_post(*steps)
  steps.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "steps[#{index}]")
  end
  jsii_call_method("addPost", [*steps])
end

#add_pre(*steps) ⇒ void

This method returns an undefined value.

Add an additional step to run before any of the stages in this wave.

Parameters:



72
73
74
75
76
77
 
# File 'pipelines/wave.rb', line 72

def add_pre(*steps)
  steps.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuU3RlcCJ9")), "steps[#{index}]")
  end
  jsii_call_method("addPre", [*steps])
end

#add_stage(stage, options = nil) ⇒ AWSCDK::Pipelines::StageDeployment

Add a Stage to this wave.

It will be deployed in parallel with all other stages in this wave.

Parameters:

Returns:



87
88
89
90
91
92
 
# File 'pipelines/wave.rb', line 87

def add_stage(stage, options = nil)
  Jsii::Type.check_type(stage, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TdGFnZSJ9")), "stage")
  options = options.is_a?(Hash) ? ::AWSCDK::Pipelines::AddStageOpts.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5waXBlbGluZXMuQWRkU3RhZ2VPcHRzIn0=")), "options") unless options.nil?
  jsii_call_method("addStage", [stage, options])
end

#id ⇒ String

Identifier for this Wave.

Returns:

  • (String) 


32
33
34
 
# File 'pipelines/wave.rb', line 32

def id()
  jsii_get_property("id")
end

#post ⇒ Array<AWSCDK::Pipelines::Step>

Additional steps that are run after all of the stages in the wave.

Returns:



39
40
41
 
# File 'pipelines/wave.rb', line 39

def post()
  jsii_get_property("post")
end

#pre ⇒ Array<AWSCDK::Pipelines::Step>

Additional steps that are run before any of the stages in the wave.

Returns:



46
47
48
 
# File 'pipelines/wave.rb', line 46

def pre()
  jsii_get_property("pre")
end

#stages ⇒ Array<AWSCDK::Pipelines::StageDeployment>

The stages that are deployed in this wave.

Returns:



53
54
55
 
# File 'pipelines/wave.rb', line 53

def stages()
  jsii_get_property("stages")
end