Interface StageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
StageOptions
- All Known Implementing Classes:
StageOptions.Jsii$Proxy
,StageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
date="2024-04-24T21:00:27.261Z")
@Stability(Stable)
public interface StageProps
extends software.amazon.jsii.JsiiSerializable
Construction properties of a Pipeline Stage.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.codepipeline.*; Action action; StageProps stageProps = StageProps.builder() .stageName("stageName") // the properties below are optional .actions(List.of(action)) .transitionDisabledReason("transitionDisabledReason") .transitionToEnabled(false) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forStageProps
static final class
An implementation forStageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic StageProps.Builder
builder()
The list of Actions to create this Stage with.The physical, human-readable name to assign to this Pipeline Stage.default String
The reason for disabling transition to this stage.default Boolean
Whether to enable transition to this stage.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getStageName
The physical, human-readable name to assign to this Pipeline Stage. -
getActions
The list of Actions to create this Stage with.You can always add more Actions later by calling
IStage#addAction
. -
getTransitionDisabledReason
The reason for disabling transition to this stage.Only applicable if
transitionToEnabled
is set tofalse
.Default: 'Transition disabled'
-
getTransitionToEnabled
Whether to enable transition to this stage.Default: true
-
builder
- Returns:
- a
StageProps.Builder
ofStageProps
-