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.30.0 (build adae23f)",
           date="2021-06-30T10:01:43.315Z")
 @Stability(value=Experimental)
public interface LambdaInvokeProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

(experimental) Properties for invoking a Lambda function with LambdaInvoke.

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() (experimental) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
default LambdaInvocationType	getInvocationType() (experimental) Invocation type of the Lambda function.
IFunction	getLambdaFunction() (experimental) Lambda function to invoke.
default TaskInput	getPayload() (experimental) The JSON that will be supplied as input to the Lambda function.
default Boolean	getPayloadResponseOnly() (experimental) Invoke the Lambda in a way that only returns the payload response without additional metadata.
default String	getQualifier() (experimental) Version or alias to invoke a published version of the function.
default Boolean	getRetryOnServiceExceptions() (experimental) 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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLambdaFunction

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

(experimental) Lambda function to invoke.

getClientContext

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

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

Default: - No context

getInvocationType

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

(experimental) Invocation type of the Lambda function.

Default: InvocationType.REQUEST_RESPONSE

getPayload

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

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

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

getPayloadResponseOnly

@Stability(value=Experimental)
 @Nullable
default Boolean getPayloadResponseOnly()

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

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

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

@Stability(value=Experimental)
 @Nullable
default Boolean getRetryOnServiceExceptions()

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

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

Specified by:

builder in interface TaskStateBaseProps

Returns:

a LambdaInvokeProps.Builder of LambdaInvokeProps