Package software.amazon.awscdk.services.events.targets

Class LambdaFunction.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static LambdaFunction.Builder create(IFunction handler)
      Parameters:
      handler - This parameter is required.
      Returns:
      a new instance of LambdaFunction.Builder.

    • deadLetterQueue

      @Stability(Stable) public LambdaFunction.Builder deadLetterQueue(IQueue deadLetterQueue)
      The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.

      The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

      Default: - no dead-letter queue

      Parameters:
      deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. This parameter is required.
      Returns:
      this

    • maxEventAge

      @Stability(Stable) public LambdaFunction.Builder maxEventAge(Duration maxEventAge)
      The maximum age of a request that Lambda sends to a function for processing.

      Minimum value of 60. Maximum value of 86400.

      Default: Duration.hours(24)

      Parameters:
      maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.
      Returns:
      this

    • retryAttempts

      @Stability(Stable) public LambdaFunction.Builder retryAttempts(Number retryAttempts)
      The maximum number of times to retry when the function returns an error.

      Minimum value of 0. Maximum value of 185.

      Default: 185

      Parameters:
      retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.
      Returns:
      this

    • event

      @Stability(Stable) public LambdaFunction.Builder event(RuleTargetInput event)
      The event to send to the Lambda.

      This will be the payload sent to the Lambda Function.

      Default: the entire EventBridge event

      Parameters:
      event - The event to send to the Lambda. This parameter is required.
      Returns:
      this

    • build

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