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(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, Lambda.SdkClientException, and Lambda.ClientExecutionTimeoutException with an interval of 2 seconds, a back-off rate of 2 and 6 maximum attempts.
      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

    • comment

      @Stability(Stable) public LambdaInvokeProps.Builder comment(String comment)
      Sets the value of StateBaseProps.getComment()
      Parameters:
      comment - A comment describing this state.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public LambdaInvokeProps.Builder queryLanguage(QueryLanguage queryLanguage)
      Sets the value of StateBaseProps.getQueryLanguage()
      Parameters:
      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.
      Returns:
      this

    • stateName

      @Stability(Stable) public LambdaInvokeProps.Builder stateName(String stateName)
      Sets the value of StateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • credentials

      @Stability(Stable) public LambdaInvokeProps.Builder credentials(Credentials credentials)
      Sets the value of TaskStateBaseOptions.getCredentials()
      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.
      Returns:
      this

    • heartbeat

      @Stability(Deprecated) @Deprecated public LambdaInvokeProps.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use `heartbeatTimeout`
      Sets the value of TaskStateBaseOptions.getHeartbeat()
      Parameters:
      heartbeat - Timeout for the heartbeat.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public LambdaInvokeProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public LambdaInvokeProps.Builder integrationPattern(IntegrationPattern integrationPattern)
      Sets the value of TaskStateBaseOptions.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.

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

      Returns:
      this

    • taskTimeout

      @Stability(Stable) public LambdaInvokeProps.Builder taskTimeout(Timeout taskTimeout)
      Sets the value of TaskStateBaseOptions.getTaskTimeout()
      Parameters:
      taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public LambdaInvokeProps.Builder timeout(Duration timeout)
      Deprecated.
      use `taskTimeout`
      Sets the value of TaskStateBaseOptions.getTimeout()
      Parameters:
      timeout - Timeout for the task.
      Returns:
      this

    • assign

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

    • inputPath

      @Stability(Stable) public LambdaInvokeProps.Builder inputPath(String inputPath)
      Sets the value of JsonPathCommonOptions.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

    • outputPath

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

    • outputs

      @Stability(Stable) public LambdaInvokeProps.Builder outputs(Object outputs)
      Sets the value of JsonataCommonOptions.getOutputs()
      Parameters:
      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.
      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