AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DisableStageTransition operation. Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodePipeline.AmazonCodePipelineRequest
      Amazon.CodePipeline.Model.DisableStageTransitionRequest

Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public class DisableStageTransitionRequest : AmazonCodePipelineRequest
         IAmazonWebServiceRequest

The DisableStageTransitionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property PipelineName System.String

Gets and sets the property PipelineName.

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

Public Property Reason System.String

Gets and sets the property Reason.

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.

Public Property StageName System.String

Gets and sets the property StageName.

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

Public Property TransitionType Amazon.CodePipeline.StageTransitionType

Gets and sets the property TransitionType.

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

Examples

This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.

Disable transitions into or out of a stage


var response = client.DisableStageTransition(new DisableStageTransitionRequest 
{
    PipelineName = "MyFirstPipeline",
    Reason = "An example reason",
    StageName = "Beta",
    TransitionType = "Inbound" // Valid values are Inbound, which prevents artifacts from transitioning into the stage and being processed by the actions in that stage, or Outbound, which prevents artifacts from transitioning out of the stage after they have been processed by the actions in that stage.
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms