Package software.amazon.awscdk.services.codepipeline.actions

Class PipelineInvokeActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.PipelineInvokeActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PipelineInvokeActionProps>

Enclosing interface:

PipelineInvokeActionProps

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

A builder for PipelineInvokeActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PipelineInvokeActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
PipelineInvokeActionProps	build()	Builds the configured instance.
PipelineInvokeActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
PipelineInvokeActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
PipelineInvokeActionProps.Builder	sourceRevisions(List<? extends SourceRevision> sourceRevisions)	Sets the value of PipelineInvokeActionProps.getSourceRevisions()
PipelineInvokeActionProps.Builder	targetPipeline(IPipeline targetPipeline)	Sets the value of PipelineInvokeActionProps.getTargetPipeline()
PipelineInvokeActionProps.Builder	variables(List<? extends Variable> variables)	Sets the value of PipelineInvokeActionProps.getVariables()
PipelineInvokeActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

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

targetPipeline

@Stability(Stable)
public PipelineInvokeActionProps.Builder targetPipeline(IPipeline targetPipeline)

Sets the value of PipelineInvokeActionProps.getTargetPipeline()

Parameters:

targetPipeline - The pipeline that will, upon running, start the current target pipeline. This parameter is required. You must have already created the invoking pipeline.

Returns:

this

sourceRevisions

@Stability(Stable)
public PipelineInvokeActionProps.Builder sourceRevisions(List<? extends SourceRevision> sourceRevisions)

Sets the value of PipelineInvokeActionProps.getSourceRevisions()

Parameters:

sourceRevisions - The source revisions that you want the target pipeline to use when it is started by the invoking pipeline.

Returns:

this

variables

@Stability(Stable)
public PipelineInvokeActionProps.Builder variables(List<? extends Variable> variables)

Sets the value of PipelineInvokeActionProps.getVariables()

Parameters:

variables - The names and values of variables that you want the action to support.

Returns:

this

role

@Stability(Stable)
public PipelineInvokeActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

Parameters:

role - The Role in which context's this Action will be executing in. The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

Returns:

this

actionName

@Stability(Stable)
public PipelineInvokeActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.

Returns:

this

runOrder

@Stability(Stable)
public PipelineInvokeActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

variablesNamespace

@Stability(Stable)
public PipelineInvokeActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action.

Returns:

this

build

@Stability(Stable)
public PipelineInvokeActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PipelineInvokeActionProps

Throws:

NullPointerException - if any required attribute was not provided