software.amazon.awscdk.services.stepfunctions.tasks

Class LambdaInvoke.Builder

java.lang.Object

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

Enclosing class:

LambdaInvoke

@Stability(value=Experimental)
public static final class LambdaInvoke.Builder
extends Object

A fluent builder for LambdaInvoke.

Method Summary

Modifier and Type	Method and Description
LambdaInvoke	build()
LambdaInvoke.Builder	clientContext(String clientContext) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
LambdaInvoke.Builder	comment(String comment) An optional description for this state.
static LambdaInvoke.Builder	create(Construct scope, String id) EXPERIMENTAL
LambdaInvoke.Builder	heartbeat(Duration heartbeat) Timeout for the heartbeat.
LambdaInvoke.Builder	inputPath(String inputPath) JSONPath expression to select part of the state to be the input to this state.
LambdaInvoke.Builder	integrationPattern(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.
LambdaInvoke.Builder	invocationType(LambdaInvocationType invocationType) Invocation type of the Lambda function.
LambdaInvoke.Builder	lambdaFunction(IFunction lambdaFunction) Lambda function to invoke.
LambdaInvoke.Builder	outputPath(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.
LambdaInvoke.Builder	payload(TaskInput payload) The JSON that will be supplied as input to the Lambda function.
LambdaInvoke.Builder	qualifier(String qualifier) Version or alias to invoke a published version of the function.
LambdaInvoke.Builder	resultPath(String resultPath) JSONPath expression to indicate where to inject the state's output.
LambdaInvoke.Builder	timeout(Duration timeout) 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 LambdaInvoke.Builder create(Construct scope,
                                                                         String id)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of LambdaInvoke.Builder.

comment

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

An optional description for this state.

Default: - No comment

EXPERIMENTAL

Parameters:

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

Returns:

this

heartbeat

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

Timeout for the heartbeat.

Default: - None

EXPERIMENTAL

Parameters:

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

Returns:

this

inputPath

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

JSONPath expression to select part of the state to be the input to this state.

May also be the special value DISCARD, which will cause the effective input to be the empty object {}.

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

EXPERIMENTAL

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 LambdaInvoke.Builder integrationPattern(IntegrationPattern integrationPattern)

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

EXPERIMENTAL

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 LambdaInvoke.Builder outputPath(String outputPath)

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value 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 '$')

EXPERIMENTAL

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 LambdaInvoke.Builder resultPath(String resultPath)

JSONPath expression to indicate where to inject the state's output.

May also be the special value DISCARD, which will cause the state's input to become its output.

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

EXPERIMENTAL

Parameters:

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

Returns:

this

timeout

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

Timeout for the state machine.

Default: - None

EXPERIMENTAL

Parameters:

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

Returns:

this

lambdaFunction

@Stability(value=Experimental)
public LambdaInvoke.Builder lambdaFunction(IFunction lambdaFunction)

Lambda function to invoke.

EXPERIMENTAL

Parameters:

lambdaFunction - Lambda function to invoke. This parameter is required.

Returns:

this

clientContext

@Stability(value=Experimental)
public LambdaInvoke.Builder clientContext(String clientContext)

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.

Default: - No context

EXPERIMENTAL

Parameters:

clientContext - Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function. This parameter is required.

Returns:

this

invocationType

@Stability(value=Experimental)
public LambdaInvoke.Builder invocationType(LambdaInvocationType invocationType)

Invocation type of the Lambda function.

Default: InvocationType.REQUEST_RESPONSE

EXPERIMENTAL

Parameters:

invocationType - Invocation type of the Lambda function. This parameter is required.

Returns:

this

payload

@Stability(value=Experimental)
public LambdaInvoke.Builder payload(TaskInput payload)

The JSON that will be supplied as input to the Lambda function.

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

EXPERIMENTAL

Parameters:

payload - The JSON that will be supplied as input to the Lambda function. This parameter is required.

Returns:

this

qualifier

@Stability(value=Experimental)
public LambdaInvoke.Builder qualifier(String qualifier)

Version or alias to invoke a published version of the function.

You only need to supply this if you want the version of the Lambda Function to depend on data in the state machine state. If not, you can pass the appropriate Alias or Version object directly as the lambdaFunction argument.

Default: - Version or alias inherent to the `lambdaFunction` object.

EXPERIMENTAL

Parameters:

qualifier - Version or alias to invoke a published version of the function. This parameter is required.

Returns:

this

build

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