Class: AWSCDK::Codepipeline::CfnPipeline::FailureConditionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
codepipeline/cfn_pipeline.rb

Overview

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

For more information about conditions, see Stage conditions and How do stage conditions work? .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conditions: nil, result: nil, retry_configuration: nil) ⇒ FailureConditionsProperty

Returns a new instance of FailureConditionsProperty.

Parameters:



1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'codepipeline/cfn_pipeline.rb', line 1277

def initialize(conditions: nil, result: nil, retry_configuration: nil)
  @conditions = conditions
  Jsii::Type.check_type(@conditions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLkNvbmRpdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "conditions") unless @conditions.nil?
  @result = result
  Jsii::Type.check_type(@result, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "result") unless @result.nil?
  @retry_configuration = retry_configuration.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipeline::RetryConfigurationProperty.new(**retry_configuration.transform_keys(&:to_sym)) : retry_configuration
  Jsii::Type.check_type(@retry_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuUmV0cnlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "retryConfiguration") unless @retry_configuration.nil?
end

Instance Attribute Details

#conditions ⇒ AWSCDK::IResolvable, ... (readonly)

The conditions that are configured as failure conditions.

For more information about conditions, see Stage conditions and How do stage conditions work? .

Returns:

See Also:



1292
1293
1294
 
# File 'codepipeline/cfn_pipeline.rb', line 1292

def conditions
  @conditions
end

#result ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1297
1298
1299
 
# File 'codepipeline/cfn_pipeline.rb', line 1297

def result
  @result
end

#retry_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

Returns:

See Also:



1302
1303
1304
 
# File 'codepipeline/cfn_pipeline.rb', line 1302

def retry_configuration
  @retry_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1304
1305
1306
1307
1308
1309
1310
 
# File 'codepipeline/cfn_pipeline.rb', line 1304

def self.jsii_properties
  {
    :conditions => "conditions",
    :result => "result",
    :retry_configuration => "retryConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'codepipeline/cfn_pipeline.rb', line 1312

def to_jsii
  result = {}
  result.merge!({
    "conditions" => @conditions,
    "result" => @result,
    "retryConfiguration" => @retry_configuration,
  })
  result.compact
end