Class: AWSCDK::Codepipeline::CfnPipeline::StageDeclarationProperty

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

Overview

Represents information about a stage and its definition.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actions:, name:, before_entry: nil, blockers: nil, on_failure: nil, on_success: nil) ⇒ StageDeclarationProperty

Returns a new instance of StageDeclarationProperty.

Parameters:



1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'codepipeline/cfn_pipeline.rb', line 1969

def initialize(actions:, name:, before_entry: nil, blockers: nil, on_failure: nil, on_success: nil)
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLkFjdGlvbkRlY2xhcmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actions")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @before_entry = before_entry.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipeline::BeforeEntryConditionsProperty.new(**before_entry.transform_keys(&:to_sym)) : before_entry
  Jsii::Type.check_type(@before_entry, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuQmVmb3JlRW50cnlDb25kaXRpb25zUHJvcGVydHkifV19fQ==")), "beforeEntry") unless @before_entry.nil?
  @blockers = blockers
  Jsii::Type.check_type(@blockers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZXBpcGVsaW5lLkNmblBpcGVsaW5lLkJsb2NrZXJEZWNsYXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "blockers") unless @blockers.nil?
  @on_failure = on_failure.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipeline::FailureConditionsProperty.new(**on_failure.transform_keys(&:to_sym)) : on_failure
  Jsii::Type.check_type(@on_failure, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuRmFpbHVyZUNvbmRpdGlvbnNQcm9wZXJ0eSJ9XX19")), "onFailure") unless @on_failure.nil?
  @on_success = on_success.is_a?(Hash) ? ::AWSCDK::Codepipeline::CfnPipeline::SuccessConditionsProperty.new(**on_success.transform_keys(&:to_sym)) : on_success
  Jsii::Type.check_type(@on_success, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuU3VjY2Vzc0NvbmRpdGlvbnNQcm9wZXJ0eSJ9XX19")), "onSuccess") unless @on_success.nil?
end

Instance Attribute Details

#actions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Codepipeline::CfnPipeline::ActionDeclarationProperty> (readonly)

The actions included in a stage.

Returns:

See Also:



1988
1989
1990
 
# File 'codepipeline/cfn_pipeline.rb', line 1988

def actions
  @actions
end

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

The method to use when a stage allows entry.

For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

Returns:

See Also:



2000
2001
2002
 
# File 'codepipeline/cfn_pipeline.rb', line 2000

def before_entry
  @before_entry
end

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

Reserved for future use.

Returns:

See Also:



2005
2006
2007
 
# File 'codepipeline/cfn_pipeline.rb', line 2005

def blockers
  @blockers
end

#name ⇒ String (readonly)

The name of the stage.

Returns:

  • (String)

See Also:



1993
1994
1995
 
# File 'codepipeline/cfn_pipeline.rb', line 1993

def name
  @name
end

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

The method to use when a stage has not completed successfully.

For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

Returns:

See Also:



2012
2013
2014
 
# File 'codepipeline/cfn_pipeline.rb', line 2012

def on_failure
  @on_failure
end

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

The method to use when a stage has succeeded.

For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

Returns:

See Also:



2019
2020
2021
 
# File 'codepipeline/cfn_pipeline.rb', line 2019

def on_success
  @on_success
end

Class Method Details

.jsii_properties ⇒ Object 



2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
 
# File 'codepipeline/cfn_pipeline.rb', line 2021

def self.jsii_properties
  {
    :actions => "actions",
    :name => "name",
    :before_entry => "beforeEntry",
    :blockers => "blockers",
    :on_failure => "onFailure",
    :on_success => "onSuccess",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
 
# File 'codepipeline/cfn_pipeline.rb', line 2032

def to_jsii
  result = {}
  result.merge!({
    "actions" => @actions,
    "name" => @name,
    "beforeEntry" => @before_entry,
    "blockers" => @blockers,
    "onFailure" => @on_failure,
    "onSuccess" => @on_success,
  })
  result.compact
end