Package software.amazon.awscdk.services.stepfunctions.tasks

Interface LambdaInvokeProps

All Superinterfaces:
AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateBaseProps
All Known Implementing Classes:
LambdaInvokeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:18.947Z") @Stability(Stable) public interface LambdaInvokeProps extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
Properties for invoking a Lambda function with LambdaInvoke.

Example: 

 Function fn;
 LambdaInvoke.Builder.create(this, "Invoke with empty object as payload")
         .lambdaFunction(fn)
         .payload(TaskInput.fromObject(Map.of()))
         .build();
 // use the output of fn as input
 // use the output of fn as input
 LambdaInvoke.Builder.create(this, "Invoke with payload field in the state input")
         .lambdaFunction(fn)
         .payload(TaskInput.fromJsonPathAt("$.Payload"))
         .build();

  • Method Details

    • getLambdaFunction

      @Stability(Stable) @NotNull IFunction getLambdaFunction()
      Lambda function to invoke.

    • getClientContext

      @Stability(Stable) @Nullable default String getClientContext()
      Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.

      Default: - No context

    • getInvocationType

      @Stability(Stable) @Nullable default LambdaInvocationType getInvocationType()
      Invocation type of the Lambda function.

      Default: InvocationType.REQUEST_RESPONSE

    • getPayload

      @Stability(Stable) @Nullable default TaskInput getPayload()
      The JSON that will be supplied as input to the Lambda function.

      Default: - The state input (JSONata: '{% $states.input %}', JSONPath: '$')

    • getPayloadResponseOnly

      @Stability(Stable) @Nullable default 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

      @Stability(Deprecated) @Deprecated @Nullable default 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

      @Stability(Stable) @Nullable default Boolean getRetryOnServiceExceptions()
      Whether to retry on Lambda service exceptions.

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

      Default: true

      See Also:

    • builder

      @Stability(Stable) static LambdaInvokeProps.Builder builder()
      Returns:
      a LambdaInvokeProps.Builder of LambdaInvokeProps