software.amazon.awscdk.services.stepfunctions.tasks

Interface LambdaInvokeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

LambdaInvokeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-21T11:02:02.772Z")
 @Stability(value=Experimental)
public interface LambdaInvokeProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for invoking a Lambda function with LambdaInvoke.

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LambdaInvokeProps.Builder A builder for LambdaInvokeProps
static class	LambdaInvokeProps.Jsii$Proxy An implementation for LambdaInvokeProps

Method Summary

Modifier and Type	Method and Description
static LambdaInvokeProps.Builder	builder()
default String	getClientContext() Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
default LambdaInvocationType	getInvocationType() Invocation type of the Lambda function.
IFunction	getLambdaFunction() Lambda function to invoke.
default TaskInput	getPayload() The JSON that will be supplied as input to the Lambda function.
default String	getQualifier() Version or alias to invoke a published version of the function.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLambdaFunction

@Stability(value=Experimental)
 @NotNull
IFunction getLambdaFunction()

Lambda function to invoke.

EXPERIMENTAL

getClientContext

@Stability(value=Experimental)
 @Nullable
default String getClientContext()

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

Default: - No context

EXPERIMENTAL

getInvocationType

@Stability(value=Experimental)
 @Nullable
default LambdaInvocationType getInvocationType()

Invocation type of the Lambda function.

Default: InvocationType.REQUEST_RESPONSE

EXPERIMENTAL

getPayload

@Stability(value=Experimental)
 @Nullable
default TaskInput getPayload()

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

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

EXPERIMENTAL

getQualifier

@Stability(value=Experimental)
 @Nullable
default String getQualifier()

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

builder

@Stability(value=Experimental)
static LambdaInvokeProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a LambdaInvokeProps.Builder of LambdaInvokeProps