Interface SqsEventSourceProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.847Z") @Stability(Stable) public interface SqsEventSourceProps extends

 Function fn;
 Queue queue = Queue.Builder.create(this, "MyQueue")
         .visibilityTimeout(Duration.seconds(30)) // default,
         .batchSize(10) // default
  • Method Details

    • getBatchSize

      @Stability(Stable) @Nullable default Number getBatchSize()
      The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.

      Your function receives an event with all the retrieved records.

      Valid Range: Minimum value of 1. Maximum value of 10. If maxBatchingWindow is configured, this value can go up to 10,000.

      Default: 10

    • getEnabled

      @Stability(Stable) @Nullable default Boolean getEnabled()
      If the SQS event source mapping should be enabled.

      Default: true

    • getMaxBatchingWindow

      @Stability(Stable) @Nullable default Duration getMaxBatchingWindow()
      The maximum amount of time to gather records before invoking the function.

      Valid Range: Minimum value of 0 minutes. Maximum value of 5 minutes.

      Default: - no batching window. The lambda function will be invoked immediately with the records that are available.

    • getReportBatchItemFailures

      @Stability(Stable) @Nullable default Boolean getReportBatchItemFailures()
      Allow functions to return partially successful responses for a batch of records.

      Default: false

      See Also:
    • builder

      @Stability(Stable) static SqsEventSourceProps.Builder builder()
      a SqsEventSourceProps.Builder of SqsEventSourceProps