software.amazon.awscdk.services.codepipeline.actions

Class StepFunctionInvokeAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionInvokeAction>

Enclosing class:

StepFunctionInvokeAction

@Stability(value=Experimental)
public static final class StepFunctionInvokeAction.Builder
extends Object
implements software.amazon.jsii.Builder<StepFunctionInvokeAction>

(experimental) A fluent builder for StepFunctionInvokeAction.

Method Summary

Modifier and Type	Method and Description
StepFunctionInvokeAction.Builder	actionName(String actionName) (experimental) The physical, human-readable name of the Action.
StepFunctionInvokeAction	build()
static StepFunctionInvokeAction.Builder	create()
StepFunctionInvokeAction.Builder	executionNamePrefix(String executionNamePrefix) (experimental) Prefix (optional).
StepFunctionInvokeAction.Builder	output(Artifact output) (experimental) The optional output Artifact of the Action.
StepFunctionInvokeAction.Builder	role(IRole role) (experimental) The Role in which context's this Action will be executing in.
StepFunctionInvokeAction.Builder	runOrder(Number runOrder) (experimental) The runOrder property for this Action.
StepFunctionInvokeAction.Builder	stateMachine(IStateMachine stateMachine) (experimental) The state machine to invoke.
StepFunctionInvokeAction.Builder	stateMachineInput(StateMachineInput stateMachineInput) (experimental) Represents the input to the StateMachine.
StepFunctionInvokeAction.Builder	variablesNamespace(String variablesNamespace) (experimental) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static StepFunctionInvokeAction.Builder create()

Returns:

a new instance of StepFunctionInvokeAction.Builder.

actionName

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder actionName(String actionName)

(experimental) The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder runOrder(Number runOrder)

(experimental) The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder variablesNamespace(String variablesNamespace)

(experimental) The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Parameters:

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

Returns:

this

role

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder role(IRole role)

(experimental) 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

stateMachine

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder stateMachine(IStateMachine stateMachine)

(experimental) The state machine to invoke.

Parameters:

stateMachine - The state machine to invoke. This parameter is required.

Returns:

this

executionNamePrefix

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder executionNamePrefix(String executionNamePrefix)

(experimental) Prefix (optional).

By default, the action execution ID is used as the state machine execution name. If a prefix is provided, it is prepended to the action execution ID with a hyphen and together used as the state machine execution name.

Default: - action execution ID

Parameters:

executionNamePrefix - Prefix (optional). This parameter is required.

Returns:

this

output

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder output(Artifact output)

(experimental) The optional output Artifact of the Action.

Default: the Action will not have any outputs

Parameters:

output - The optional output Artifact of the Action. This parameter is required.

Returns:

this

stateMachineInput

@Stability(value=Experimental)
public StepFunctionInvokeAction.Builder stateMachineInput(StateMachineInput stateMachineInput)

(experimental) Represents the input to the StateMachine.

This includes input artifact, input type and the statemachine input.

Default: - none

Parameters:

stateMachineInput - Represents the input to the StateMachine. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public StepFunctionInvokeAction build()

Specified by:

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