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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DisableStageTransitionInput as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#pipeline_name ⇒ String

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

Returns:

  • (String) —

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

#reason ⇒ String

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) —

    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.

Returns:

  • (String) —

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

#transition_type ⇒ String

Specifies whether artifacts are 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).

Possible values:

  • Inbound
  • Outbound

Returns:

  • (String) —

    Specifies whether artifacts are 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).