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

Class LambdaInvoke.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.LambdaInvoke.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<LambdaInvoke>
Enclosing class:
LambdaInvoke
@Stability(Stable) public static final class LambdaInvoke.Builder extends Object implements software.amazon.jsii.Builder<LambdaInvoke>
A fluent builder for LambdaInvoke.

  • Method Details

    • create

      @Stability(Stable) public static LambdaInvoke.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of LambdaInvoke.Builder.

    • comment

      @Stability(Stable) public LambdaInvoke.Builder comment(String comment)
      A comment describing this state.

      Default: No comment

      Parameters:
      comment - A comment describing this state. This parameter is required.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public LambdaInvoke.Builder queryLanguage(QueryLanguage queryLanguage)
      The name of the query language used by the state.

      If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

      Default: - JSONPath

      Parameters:
      queryLanguage - The name of the query language used by the state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public LambdaInvoke.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public LambdaInvoke.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public LambdaInvoke.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public LambdaInvoke.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • integrationPattern

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

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
      Returns:
      this
      See Also:

    • taskTimeout

      @Stability(Stable) public LambdaInvoke.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public LambdaInvoke.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • assign

      @Stability(Stable) public LambdaInvoke.Builder assign(Map<String,? extends Object> assign)
      Workflow variables to store in this step.

      Using workflow variables, you can store data in a step and retrieve that data in future steps.

      Default: - Not assign variables

      Parameters:
      assign - Workflow variables to store in this step. This parameter is required.
      Returns:
      this
      See Also:

    • inputPath

      @Stability(Stable) 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 JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

      Default: $

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • outputPath

      @Stability(Stable) public LambdaInvoke.Builder outputPath(String outputPath)
      JSONPath expression to select part of the state to be the output to this state.

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

      Default: $

      Parameters:
      outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.
      Returns:
      this

    • outputs

      @Stability(Stable) public LambdaInvoke.Builder outputs(Object outputs)
      Used to specify and transform output from the state.

      When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

      Default: - $states.result or $states.errorOutput

      Parameters:
      outputs - Used to specify and transform output from the state. This parameter is required.
      Returns:
      this
      See Also:

    • resultPath

      @Stability(Stable) public LambdaInvoke.Builder resultPath(String resultPath)
      JSONPath expression to indicate where to inject the state's output.

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

      Default: $

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

    • resultSelector

      @Stability(Stable) public LambdaInvoke.Builder resultSelector(Map<String,? extends Object> resultSelector)
      The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

      You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

      Default: - None

      Parameters:
      resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
      Returns:
      this
      See Also:

    • lambdaFunction

      @Stability(Stable) public LambdaInvoke.Builder lambdaFunction(IFunction lambdaFunction)
      Lambda function to invoke.

      Parameters:
      lambdaFunction - Lambda function to invoke. This parameter is required.
      Returns:
      this

    • clientContext

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

      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(Stable) public LambdaInvoke.Builder invocationType(LambdaInvocationType invocationType)
      Invocation type of the Lambda function.

      Default: InvocationType.REQUEST_RESPONSE

      Parameters:
      invocationType - Invocation type of the Lambda function. This parameter is required.
      Returns:
      this

    • payload

      @Stability(Stable) public LambdaInvoke.Builder payload(TaskInput payload)
      The JSON that will be supplied as input to the Lambda function.

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

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

    • payloadResponseOnly

      @Stability(Stable) public LambdaInvoke.Builder payloadResponseOnly(Boolean payloadResponseOnly)
      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

      Parameters:
      payloadResponseOnly - Invoke the Lambda in a way that only returns the payload response without additional metadata. This parameter is required.
      Returns:
      this

    • qualifier

      @Stability(Deprecated) @Deprecated public LambdaInvoke.Builder qualifier(String qualifier)
      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.

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

    • retryOnServiceExceptions

      @Stability(Stable) public LambdaInvoke.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)
      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

      Parameters:
      retryOnServiceExceptions - Whether to retry on Lambda service exceptions. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Stable) public LambdaInvoke build()
      Specified by:
      build in interface software.amazon.jsii.Builder<LambdaInvoke>
      Returns:
      a newly built instance of LambdaInvoke.