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

Class LambdaInvokeProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • lambdaFunction

      @Stability(Stable) public LambdaInvokeProps.Builder lambdaFunction(software.amazon.awscdk.services.lambda.IFunction lambdaFunction)
      Sets the value of LambdaInvokeProps.getLambdaFunction()
      Parameters:
      lambdaFunction - Lambda function to invoke. This parameter is required.
      Returns:
      this

    • clientContext

      @Stability(Stable) public LambdaInvokeProps.Builder clientContext(String clientContext)
      Sets the value of LambdaInvokeProps.getClientContext()
      Parameters:
      clientContext - Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function.
      Returns:
      this

    • invocationType

      @Stability(Stable) public LambdaInvokeProps.Builder invocationType(LambdaInvocationType invocationType)
      Sets the value of LambdaInvokeProps.getInvocationType()
      Parameters:
      invocationType - Invocation type of the Lambda function.
      Returns:
      this

    • payload

      @Stability(Stable) public LambdaInvokeProps.Builder payload(TaskInput payload)
      Sets the value of LambdaInvokeProps.getPayload()
      Parameters:
      payload - The JSON that will be supplied as input to the Lambda function.
      Returns:
      this

    • payloadResponseOnly

      @Stability(Stable) public LambdaInvokeProps.Builder payloadResponseOnly(Boolean payloadResponseOnly)
      Sets the value of LambdaInvokeProps.getPayloadResponseOnly()
      Parameters:
      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.
      Returns:
      this

    • qualifier

      @Stability(Deprecated) @Deprecated public LambdaInvokeProps.Builder qualifier(String qualifier)
      Deprecated.
      pass a Version or Alias object as lambdaFunction instead
      Sets the value of LambdaInvokeProps.getQualifier()
      Parameters:
      qualifier - 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.
      Returns:
      this

    • retryOnServiceExceptions

      @Stability(Stable) public LambdaInvokeProps.Builder retryOnServiceExceptions(Boolean retryOnServiceExceptions)
      Sets the value of LambdaInvokeProps.getRetryOnServiceExceptions()
      Parameters:
      retryOnServiceExceptions - 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.
      Returns:
      this

    • comment

      @Stability(Stable) public LambdaInvokeProps.Builder comment(String comment)
      Sets the value of TaskStateBaseProps.getComment()
      Parameters:
      comment - An optional description for this state.
      Returns:
      this

    • heartbeat

      @Stability(Stable) public LambdaInvokeProps.Builder heartbeat(software.amazon.awscdk.core.Duration heartbeat)
      Sets the value of TaskStateBaseProps.getHeartbeat()
      Parameters:
      heartbeat - Timeout for the heartbeat.
      Returns:
      this

    • inputPath

      @Stability(Stable) public LambdaInvokeProps.Builder inputPath(String inputPath)
      Sets the value of TaskStateBaseProps.getInputPath()
      Parameters:
      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 {}.
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public LambdaInvokeProps.Builder integrationPattern(IntegrationPattern integrationPattern)
      Sets the value of TaskStateBaseProps.getIntegrationPattern()
      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns
      Returns:
      this

    • outputPath

      @Stability(Stable) public LambdaInvokeProps.Builder outputPath(String outputPath)
      Sets the value of TaskStateBaseProps.getOutputPath()
      Parameters:
      outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
      Returns:
      this

    • resultPath

      @Stability(Stable) public LambdaInvokeProps.Builder resultPath(String resultPath)
      Sets the value of TaskStateBaseProps.getResultPath()
      Parameters:
      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.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public LambdaInvokeProps.Builder resultSelector(Map<String,? extends Object> resultSelector)
      Sets the value of TaskStateBaseProps.getResultSelector()
      Parameters:
      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.
      Returns:
      this

    • timeout

      @Stability(Stable) public LambdaInvokeProps.Builder timeout(software.amazon.awscdk.core.Duration timeout)
      Sets the value of TaskStateBaseProps.getTimeout()
      Parameters:
      timeout - Timeout for the state machine.
      Returns:
      this

    • build

      @Stability(Stable) public LambdaInvokeProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<LambdaInvokeProps>
      Returns:
      a new instance of LambdaInvokeProps
      Throws:
      NullPointerException - if any required attribute was not provided