Class: AWSCDK::Codepipeline::FailureConditions

Inherits:
Conditions
  • Object
show all
Defined in:
codepipeline/failure_conditions.rb

Overview

The configuration that specifies the result, such as rollback, to occur upon stage failure.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conditions: nil, result: nil, retry_mode: nil) ⇒ FailureConditions

Returns a new instance of FailureConditions.

Parameters:

  • conditions (Array<AWSCDK::Codepipeline::Condition>, nil) (defaults to: nil) —

    The conditions that are configured as entry conditions, making check to succeed the stage, or fail the stage.

  • result (AWSCDK::Codepipeline::Result, nil) (defaults to: nil) —

    The specified result for when the failure conditions are met, such as rolling back the stage.

  • retry_mode (AWSCDK::Codepipeline::RetryMode, nil) (defaults to: nil) —

    The method that you want to configure for automatic stage retry on stage failure.



10
11
12
13
14
15
16
17
 
# File 'codepipeline/failure_conditions.rb', line 10

def initialize(conditions: nil, result: nil, retry_mode: nil)
  @conditions = conditions.is_a?(Array) ? conditions.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::Codepipeline::Condition.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : conditions
  Jsii::Type.check_type(@conditions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ29uZGl0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "conditions") unless @conditions.nil?
  @result = result
  Jsii::Type.check_type(@result, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLlJlc3VsdCJ9")), "result") unless @result.nil?
  @retry_mode = retry_mode
  Jsii::Type.check_type(@retry_mode, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLlJldHJ5TW9kZSJ9")), "retryMode") unless @retry_mode.nil?
end

Instance Attribute Details

#conditions ⇒ Array<AWSCDK::Codepipeline::Condition>? (readonly)

Note:

Default: - No conditions are configured

The conditions that are configured as entry conditions, making check to succeed the stage, or fail the stage.

Returns:



23
24
25
 
# File 'codepipeline/failure_conditions.rb', line 23

def conditions
  @conditions
end

#result ⇒ AWSCDK::Codepipeline::Result? (readonly)

Note:

Default: FAIL

The specified result for when the failure conditions are met, such as rolling back the stage.

Returns:



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

def result
  @result
end

#retry_mode ⇒ AWSCDK::Codepipeline::RetryMode? (readonly)

Note:

Default: ALL_ACTIONS

The method that you want to configure for automatic stage retry on stage failure.

Returns:



33
34
35
 
# File 'codepipeline/failure_conditions.rb', line 33

def retry_mode
  @retry_mode
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'codepipeline/failure_conditions.rb', line 35

def self.jsii_properties
  {
    :conditions => "conditions",
    :result => "result",
    :retry_mode => "retryMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'codepipeline/failure_conditions.rb', line 43

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "conditions" => @conditions,
    "result" => @result,
    "retryMode" => @retry_mode,
  })
  result.compact
end