Class: AWSCDK::Codepipeline::CfnPipeline::StageTransitionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Codepipeline::CfnPipeline::StageTransitionProperty

Defined in:

codepipeline/cfn_pipeline.rb

Overview

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html

Instance Attribute Summary

• #reason ⇒ String readonly

  The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.

• #stage_name ⇒ String readonly

  The name of the stage where you want to disable the inbound or outbound transition of artifacts.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(reason:, stage_name:) ⇒ StageTransitionProperty constructor

  A new instance of StageTransitionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(reason:, stage_name:) ⇒ StageTransitionProperty

Returns a new instance of StageTransitionProperty.

Parameters:

• reason (String) —

  The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.

• stage_name (String) —

  The name of the stage where you want to disable the inbound or outbound transition of artifacts.

# File 'codepipeline/cfn_pipeline.rb', line 2054

def initialize(reason:, stage_name:)
  @reason = reason
  Jsii::Type.check_type(@reason, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reason")
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName")
end

Instance Attribute Details

#reason ⇒ String (readonly)

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests.

This message is displayed in the pipeline console UI.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-reason

# File 'codepipeline/cfn_pipeline.rb', line 2067

def reason
  @reason
end

#stage_name ⇒ String (readonly)

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagetransition.html#cfn-codepipeline-pipeline-stagetransition-stagename

# File 'codepipeline/cfn_pipeline.rb', line 2072

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 2074

def self.jsii_properties
  {
    :reason => "reason",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'codepipeline/cfn_pipeline.rb', line 2081

def to_jsii
  result = {}
  result.merge!({
    "reason" => @reason,
    "stageName" => @stage_name,
  })
  result.compact
end