Module: AWSCDK::Codepipeline::IStage

Defined in:
codepipeline/i_stage.rb

Overview

The abstract interface of a Pipeline Stage that is used by Actions.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'codepipeline/i_stage.rb', line 45

def self.jsii_overridable_methods
  {
    :actions => { kind: :property, name: "actions", is_optional: false },
    :pipeline => { kind: :property, name: "pipeline", is_optional: false },
    :stage_name => { kind: :property, name: "stageName", is_optional: false },
    :add_action => { kind: :method, name: "addAction", is_optional: false },
    :on_state_change => { kind: :method, name: "onStateChange", is_optional: false },
  }
end

Instance Method Details

#actions ⇒ Array<AWSCDK::Codepipeline::IAction>

The actions belonging to this stage.

Returns:



10
11
12
 
# File 'codepipeline/i_stage.rb', line 10

def actions()
  jsii_get_property("actions")
end

#add_action(action) ⇒ void

This method returns an undefined value.

Parameters:



28
29
30
31
 
# File 'codepipeline/i_stage.rb', line 28

def add_action(action)
  Jsii::Type.check_type(action, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLklBY3Rpb24ifQ==")), "action")
  jsii_call_method("addAction", [action])
end

#on_state_change(name, target = nil, options = nil) ⇒ AWSCDK::Events::Rule

Parameters:

Returns:



37
38
39
40
41
42
43
 
# File 'codepipeline/i_stage.rb', line 37

def on_state_change(name, target = nil, options = nil)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLklSdWxlVGFyZ2V0In0=")), "target") unless target.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::Events::RuleProps.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLlJ1bGVQcm9wcyJ9")), "options") unless options.nil?
  jsii_call_method("onStateChange", [name, target, options])
end

#pipeline ⇒ AWSCDK::Codepipeline::IPipeline

Returns:



15
16
17
 
# File 'codepipeline/i_stage.rb', line 15

def pipeline()
  jsii_get_property("pipeline")
end

#stage_name ⇒ String

The physical, human-readable name of this Pipeline Stage.

Returns:

  • (String) 


22
23
24
 
# File 'codepipeline/i_stage.rb', line 22

def stage_name()
  jsii_get_property("stageName")
end