Package software.amazon.awscdk.services.codepipeline

Class StageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.StageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StageOptions>

Enclosing interface:

StageOptions

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

A builder for StageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StageOptions.Builder	actions(List<? extends IAction> actions)	Sets the value of StageProps.getActions()
StageOptions	build()	Builds the configured instance.
StageOptions.Builder	placement(StagePlacement placement)	Sets the value of StageOptions.getPlacement()
StageOptions.Builder	stageName(String stageName)	Sets the value of StageProps.getStageName()
StageOptions.Builder	transitionDisabledReason(String transitionDisabledReason)	Sets the value of StageProps.getTransitionDisabledReason()
StageOptions.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

placement

@Stability(Stable)
public StageOptions.Builder placement(StagePlacement placement)

Sets the value of StageOptions.getPlacement()

Parameters:

placement - the value to be set.

Returns:

this

stageName

@Stability(Stable)
public StageOptions.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 StageOptions.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(software.amazon.awscdk.services.codepipeline.IAction).

Returns:

this

transitionDisabledReason

@Stability(Stable)
public StageOptions.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 StageOptions.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 StageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StageOptions

Throws:

NullPointerException - if any required attribute was not provided