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

Class StepFunctionsInvokeActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsInvokeActionProps>

Enclosing interface:

StepFunctionsInvokeActionProps

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

A builder for StepFunctionsInvokeActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StepFunctionsInvokeActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
StepFunctionsInvokeActionProps	build()	Builds the configured instance.
StepFunctionsInvokeActionProps.Builder	executionNamePrefix(String executionNamePrefix)	Sets the value of StepFunctionsInvokeActionProps.getExecutionNamePrefix()
StepFunctionsInvokeActionProps.Builder	output(Artifact output)	Sets the value of StepFunctionsInvokeActionProps.getOutput()
StepFunctionsInvokeActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
StepFunctionsInvokeActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
StepFunctionsInvokeActionProps.Builder	stateMachine(IStateMachine stateMachine)	Sets the value of StepFunctionsInvokeActionProps.getStateMachine()
StepFunctionsInvokeActionProps.Builder	stateMachineInput(StateMachineInput stateMachineInput)	Sets the value of StepFunctionsInvokeActionProps.getStateMachineInput()
StepFunctionsInvokeActionProps.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

stateMachine

@Stability(Stable)
public StepFunctionsInvokeActionProps.Builder stateMachine(IStateMachine stateMachine)

Sets the value of StepFunctionsInvokeActionProps.getStateMachine()

Parameters:

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

Returns:

this

executionNamePrefix

@Stability(Stable)
public StepFunctionsInvokeActionProps.Builder executionNamePrefix(String executionNamePrefix)

Sets the value of StepFunctionsInvokeActionProps.getExecutionNamePrefix()

Parameters:

executionNamePrefix - 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.

Returns:

this

output

@Stability(Stable)
public StepFunctionsInvokeActionProps.Builder output(Artifact output)

Sets the value of StepFunctionsInvokeActionProps.getOutput()

Parameters:

output - The optional output Artifact of the Action.

Returns:

this

stateMachineInput

@Stability(Stable)
public StepFunctionsInvokeActionProps.Builder stateMachineInput(StateMachineInput stateMachineInput)

Sets the value of StepFunctionsInvokeActionProps.getStateMachineInput()

Parameters:

stateMachineInput - Represents the input to the StateMachine. This includes input artifact, input type and the statemachine input.

Returns:

this

role

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StepFunctionsInvokeActionProps

Throws:

NullPointerException - if any required attribute was not provided