Class StageProps
Construction properties of a Pipeline Stage.
Inheritance
System.Object
StageProps
Implements
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StageProps : Object, IStageProps
Syntax (vb)
Public Class StageProps
Inherits Object
Implements IStageProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;
Action action;
var stageProps = new StageProps {
StageName = "stageName",
// the properties below are optional
Actions = new [] { action },
TransitionDisabledReason = "transitionDisabledReason",
TransitionToEnabled = false
};
Synopsis
Constructors
StageProps() |
Properties
Actions | The list of Actions to create this Stage with. |
StageName | The physical, human-readable name to assign to this Pipeline Stage. |
TransitionDisabledReason | The reason for disabling transition to this stage. |
TransitionToEnabled | Whether to enable transition to this stage. |
Constructors
StageProps()
public StageProps()
Properties
Actions
The list of Actions to create this Stage with.
public IAction[] Actions { get; set; }
Property Value
IAction[]
Remarks
You can always add more Actions later by calling IStage#addAction
.
StageName
The physical, human-readable name to assign to this Pipeline Stage.
public string StageName { get; set; }
Property Value
System.String
TransitionDisabledReason
The reason for disabling transition to this stage.
public string TransitionDisabledReason { get; set; }
Property Value
System.String
Remarks
Only applicable
if transitionToEnabled
is set to false
.
Default: 'Transition disabled'
TransitionToEnabled
Whether to enable transition to this stage.
public Nullable<bool> TransitionToEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true