software.amazon.awscdk.services.stepfunctions.tasks

Interface LambdaInvokeProps

All Superinterfaces:

TaskStateBaseProps

All Known Implementing Classes:

LambdaInvokeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:44.523Z")
public interface LambdaInvokeProps
extends TaskStateBaseProps

Properties for invoking a Lambda function with LambdaInvoke.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function orderFn;
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "InvokeOrderProcessor")
         .lambdaFunction(orderFn)
         .payload(TaskInput.fromObject(Map.of(
                 "OrderId", JsonPath.stringAt("$.OrderId"))))
         .build();
 

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 java.lang.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 java.lang.Boolean	getPayloadResponseOnly() Invoke the Lambda in a way that only returns the payload response without additional metadata.
default java.lang.String	getQualifier() Deprecated. pass a Version or Alias object as lambdaFunction instead
default java.lang.Boolean	getRetryOnServiceExceptions() Whether to retry on Lambda service exceptions.

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

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

Method Detail

getLambdaFunction

IFunction getLambdaFunction()

Lambda function to invoke.

getClientContext

default java.lang.String getClientContext()

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

Default: - No context

getInvocationType

default LambdaInvocationType getInvocationType()

Invocation type of the Lambda function.

Default: InvocationType.REQUEST_RESPONSE

getPayload

default TaskInput getPayload()

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

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

getPayloadResponseOnly

default java.lang.Boolean getPayloadResponseOnly()

Invoke the Lambda in a way that only returns the payload response without additional metadata.

The payloadResponseOnly property cannot be used if integrationPattern, invocationType, clientContext, or qualifier are specified. It always uses the REQUEST_RESPONSE behavior.

Default: false

getQualifier

@Deprecated
default java.lang.String getQualifier()

Deprecated. pass a Version or Alias object as lambdaFunction instead

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

getRetryOnServiceExceptions

default java.lang.Boolean getRetryOnServiceExceptions()

Whether to retry on Lambda service exceptions.

This handles Lambda.ServiceException, Lambda.AWSLambdaException and Lambda.SdkClientException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.

Default: true

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html

builder

static LambdaInvokeProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a LambdaInvokeProps.Builder of LambdaInvokeProps