Package software.amazon.awscdk.services.codepipeline

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.110.0 (build 336b265)",
           date="2025-04-22T23:08:09.291Z")
@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;
 Rule rule;
 StageProps stageProps = StageProps.builder()
         .stageName("stageName")
         // the properties below are optional
         .actions(List.of(action))
         .beforeEntry(Conditions.builder()
                 .conditions(List.of(Condition.builder()
                         .result(Result.ROLLBACK)
                         .rules(List.of(rule))
                         .build()))
                 .build())
         .onFailure(FailureConditions.builder()
                 .conditions(List.of(Condition.builder()
                         .result(Result.ROLLBACK)
                         .rules(List.of(rule))
                         .build()))
                 .result(Result.ROLLBACK)
                 .retryMode(RetryMode.ALL_ACTIONS)
                 .build())
         .onSuccess(Conditions.builder()
                 .conditions(List.of(Condition.builder()
                         .result(Result.ROLLBACK)
                         .rules(List.of(rule))
                         .build()))
                 .build())
         .transitionDisabledReason("transitionDisabledReason")
         .transitionToEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StageProps.Builder	A builder for StageProps
static final class	StageProps.Jsii$Proxy	An implementation for StageProps

Method Summary

Modifier and Type	Method	Description
static StageProps.Builder	builder()
default List<IAction>	getActions()	The list of Actions to create this Stage with.
default Conditions	getBeforeEntry()	The method to use when a stage allows entry.
default FailureConditions	getOnFailure()	The method to use when a stage has not completed successfully.
default Conditions	getOnSuccess()	The method to use when a stage has succeeded.
String	getStageName()	The physical, human-readable name to assign to this Pipeline Stage.
default String	getTransitionDisabledReason()	The reason for disabling transition to this stage.
default Boolean	getTransitionToEnabled()	Whether to enable transition to this stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStageName

@Stability(Stable)
@NotNull
String getStageName()

The physical, human-readable name to assign to this Pipeline Stage.

getActions

@Stability(Stable)
@Nullable
default List<IAction> getActions()

The list of Actions to create this Stage with.

You can always add more Actions later by calling IStage#addAction.

getBeforeEntry

@Stability(Stable)
@Nullable
default Conditions getBeforeEntry()

The method to use when a stage allows entry.

Default: - No conditions are applied before stage entry

getOnFailure

@Stability(Stable)
@Nullable
default FailureConditions getOnFailure()

The method to use when a stage has not completed successfully.

Default: - No failure conditions are applied

getOnSuccess

@Stability(Stable)
@Nullable
default Conditions getOnSuccess()

The method to use when a stage has succeeded.

Default: - No success conditions are applied

getTransitionDisabledReason

@Stability(Stable)
@Nullable
default String getTransitionDisabledReason()

The reason for disabling transition to this stage.

Only applicable if transitionToEnabled is set to false.

Default: 'Transition disabled'

getTransitionToEnabled

@Stability(Stable)
@Nullable
default Boolean getTransitionToEnabled()

Whether to enable transition to this stage.

Default: true

builder

@Stability(Stable)
static StageProps.Builder builder()

Returns:

a StageProps.Builder of StageProps