software.amazon.awscdk.services.stepfunctions.tasks

Class StepFunctionsStartExecutionProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.StepFunctionsStartExecutionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsStartExecutionProps>

Enclosing interface:

StepFunctionsStartExecutionProps

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

A builder for StepFunctionsStartExecutionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StepFunctionsStartExecutionProps	build() Builds the configured instance.
StepFunctionsStartExecutionProps.Builder	comment(String comment) Sets the value of TaskStateBaseProps.getComment()
StepFunctionsStartExecutionProps.Builder	heartbeat(Duration heartbeat) Sets the value of TaskStateBaseProps.getHeartbeat()
StepFunctionsStartExecutionProps.Builder	input(TaskInput input) Sets the value of StepFunctionsStartExecutionProps.getInput()
StepFunctionsStartExecutionProps.Builder	inputPath(String inputPath) Sets the value of TaskStateBaseProps.getInputPath()
StepFunctionsStartExecutionProps.Builder	integrationPattern(IntegrationPattern integrationPattern) Sets the value of TaskStateBaseProps.getIntegrationPattern()
StepFunctionsStartExecutionProps.Builder	name(String name) Sets the value of StepFunctionsStartExecutionProps.getName()
StepFunctionsStartExecutionProps.Builder	outputPath(String outputPath) Sets the value of TaskStateBaseProps.getOutputPath()
StepFunctionsStartExecutionProps.Builder	resultPath(String resultPath) Sets the value of TaskStateBaseProps.getResultPath()
StepFunctionsStartExecutionProps.Builder	resultSelector(Map<String,? extends Object> resultSelector) Sets the value of TaskStateBaseProps.getResultSelector()
StepFunctionsStartExecutionProps.Builder	stateMachine(IStateMachine stateMachine) Sets the value of StepFunctionsStartExecutionProps.getStateMachine()
StepFunctionsStartExecutionProps.Builder	timeout(Duration timeout) Sets the value of TaskStateBaseProps.getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

stateMachine

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

Sets the value of StepFunctionsStartExecutionProps.getStateMachine()

Parameters:

stateMachine - The Step Functions state machine to start the execution on. This parameter is required.

Returns:

this

input

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder input(TaskInput input)

Sets the value of StepFunctionsStartExecutionProps.getInput()

Parameters:

input - The JSON input for the execution, same as that of StartExecution.

Returns:

this

name

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder name(String name)

Sets the value of StepFunctionsStartExecutionProps.getName()

Parameters:

name - The name of the execution, same as that of StartExecution.

Returns:

this

comment

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

integrationPattern

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns

Returns:

this

outputPath

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

timeout

@Stability(value=Experimental)
public StepFunctionsStartExecutionProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StepFunctionsStartExecutionProps

Throws:

NullPointerException - if any required attribute was not provided