software.amazon.awscdk.services.stepfunctions.tasks

Class StepFunctionsStartExecution.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsStartExecution>

Enclosing class:

StepFunctionsStartExecution

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

(experimental) A fluent builder for StepFunctionsStartExecution.

Method Summary

Modifier and Type	Method and Description
StepFunctionsStartExecution	build()
StepFunctionsStartExecution.Builder	comment(String comment) (experimental) An optional description for this state.
static StepFunctionsStartExecution.Builder	create(software.constructs.Construct scope, String id)
StepFunctionsStartExecution.Builder	heartbeat(Duration heartbeat) (experimental) Timeout for the heartbeat.
StepFunctionsStartExecution.Builder	input(TaskInput input) (experimental) The JSON input for the execution, same as that of StartExecution.
StepFunctionsStartExecution.Builder	inputPath(String inputPath) (experimental) JSONPath expression to select part of the state to be the input to this state.
StepFunctionsStartExecution.Builder	integrationPattern(IntegrationPattern integrationPattern) (experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
StepFunctionsStartExecution.Builder	name(String name) (experimental) The name of the execution, same as that of StartExecution.
StepFunctionsStartExecution.Builder	outputPath(String outputPath) (experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
StepFunctionsStartExecution.Builder	resultPath(String resultPath) (experimental) JSONPath expression to indicate where to inject the state's output.
StepFunctionsStartExecution.Builder	resultSelector(Map<String,? extends Object> resultSelector) (experimental) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
StepFunctionsStartExecution.Builder	stateMachine(IStateMachine stateMachine) (experimental) The Step Functions state machine to start the execution on.
StepFunctionsStartExecution.Builder	timeout(Duration timeout) (experimental) Timeout for the state machine.

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 StepFunctionsStartExecution.Builder create(software.constructs.Construct scope,
                                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StepFunctionsStartExecution.Builder.

comment

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

(experimental) An optional description for this state.

Default: - No comment

Parameters:

comment - An optional description for this state. This parameter is required.

Returns:

this

heartbeat

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

(experimental) Timeout for the heartbeat.

Default: - None

Parameters:

heartbeat - Timeout for the heartbeat. This parameter is required.

Returns:

this

inputPath

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

(experimental) 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 {}.

Default: - The entire task input (JSON path '$')

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.

Returns:

this

integrationPattern

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

(experimental) AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

Default: IntegrationPattern.REQUEST_RESPONSE

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

outputPath

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

(experimental) 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 {}.

Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.

Returns:

this

resultPath

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

(experimental) 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.

Default: - Replaces the entire input with the result (JSON path '$')

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.

Returns:

this

resultSelector

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

(experimental) 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.

Default: - None

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

timeout

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

(experimental) Timeout for the state machine.

Default: - None

Parameters:

timeout - Timeout for the state machine. This parameter is required.

Returns:

this

stateMachine

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

(experimental) The Step Functions state machine to start the execution on.

Parameters:

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

Returns:

this

input

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

(experimental) The JSON input for the execution, same as that of StartExecution.

Default: - The state input (JSON path '$')

Parameters:

input - The JSON input for the execution, same as that of StartExecution. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html

name

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

(experimental) The name of the execution, same as that of StartExecution.

Default: - None

Parameters:

name - The name of the execution, same as that of StartExecution. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html

build

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

Specified by:

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