Package software.amazon.awscdk.services.codepipeline

Class StageProps.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.StageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StageProps>

Enclosing interface:

StageProps

@Stability(Stable)
public static final class StageProps.Builder
extends Object
implements software.amazon.jsii.Builder<StageProps>

A builder for StageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StageProps.Builder	actions(List<? extends IAction> actions)	Sets the value of StageProps.getActions()
StageProps.Builder	beforeEntry(Conditions beforeEntry)	Sets the value of StageProps.getBeforeEntry()
StageProps	build()	Builds the configured instance.
StageProps.Builder	onFailure(FailureConditions onFailure)	Sets the value of StageProps.getOnFailure()
StageProps.Builder	onSuccess(Conditions onSuccess)	Sets the value of StageProps.getOnSuccess()
StageProps.Builder	stageName(String stageName)	Sets the value of StageProps.getStageName()
StageProps.Builder	transitionDisabledReason(String transitionDisabledReason)	Sets the value of StageProps.getTransitionDisabledReason()
StageProps.Builder	transitionToEnabled(Boolean transitionToEnabled)	Sets the value of StageProps.getTransitionToEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

stageName

@Stability(Stable)
public StageProps.Builder stageName(String stageName)

Sets the value of StageProps.getStageName()

Parameters:

stageName - The physical, human-readable name to assign to this Pipeline Stage. This parameter is required.

Returns:

this

actions

@Stability(Stable)
public StageProps.Builder actions(List<? extends IAction> actions)

Sets the value of StageProps.getActions()

Parameters:

actions - The list of Actions to create this Stage with. You can always add more Actions later by calling IStage#addAction.

Returns:

this

beforeEntry

@Stability(Stable)
public StageProps.Builder beforeEntry(Conditions beforeEntry)

Sets the value of StageProps.getBeforeEntry()

Parameters:

beforeEntry - The method to use when a stage allows entry.

Returns:

this

onFailure

@Stability(Stable)
public StageProps.Builder onFailure(FailureConditions onFailure)

Sets the value of StageProps.getOnFailure()

Parameters:

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

Returns:

this

onSuccess

@Stability(Stable)
public StageProps.Builder onSuccess(Conditions onSuccess)

Sets the value of StageProps.getOnSuccess()

Parameters:

onSuccess - The method to use when a stage has succeeded.

Returns:

this

transitionDisabledReason

@Stability(Stable)
public StageProps.Builder transitionDisabledReason(String transitionDisabledReason)

Sets the value of StageProps.getTransitionDisabledReason()

Parameters:

transitionDisabledReason - The reason for disabling transition to this stage. Only applicable if transitionToEnabled is set to false.

Returns:

this

transitionToEnabled

@Stability(Stable)
public StageProps.Builder transitionToEnabled(Boolean transitionToEnabled)

Sets the value of StageProps.getTransitionToEnabled()

Parameters:

transitionToEnabled - Whether to enable transition to this stage.

Returns:

this

build

@Stability(Stable)
public StageProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<StageProps>

Returns:

a new instance of StageProps

Throws:

NullPointerException - if any required attribute was not provided