You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::DisableStageTransitionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

When making an API call, you may pass DisableStageTransitionInput data as a hash:

{
  pipeline_name: "PipelineName", # required
  stage_name: "StageName", # required
  transition_type: "Inbound", # required, accepts Inbound, Outbound
  reason: "DisabledReason", # required
}

Represents the input of a DisableStageTransition action.

Instance Attribute Summary collapse

Instance Attribute Details

#pipeline_nameString

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

Returns:

  • (String)


1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1398

class DisableStageTransitionInput < Struct.new(
  :pipeline_name,
  :stage_name,
  :transition_type,
  :reason)
  include Aws::Structure
end

#reasonString

The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

Returns:

  • (String)


1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1398

class DisableStageTransitionInput < Struct.new(
  :pipeline_name,
  :stage_name,
  :transition_type,
  :reason)
  include Aws::Structure
end

#stage_nameString

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

Returns:

  • (String)


1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1398

class DisableStageTransitionInput < Struct.new(
  :pipeline_name,
  :stage_name,
  :transition_type,
  :reason)
  include Aws::Structure
end

#transition_typeString

Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

Returns:

  • (String)


1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1398

class DisableStageTransitionInput < Struct.new(
  :pipeline_name,
  :stage_name,
  :transition_type,
  :reason)
  include Aws::Structure
end