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

Class SqsQueueProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • message

      @Stability(Stable) public SqsQueueProps.Builder message(RuleTargetInput message)
      Sets the value of SqsQueueProps.getMessage()
      Parameters:
      message - The message to send to the queue. Must be a valid JSON text passed to the target queue.
      Returns:
      this

    • messageGroupId

      @Stability(Stable) public SqsQueueProps.Builder messageGroupId(String messageGroupId)
      Sets the value of SqsQueueProps.getMessageGroupId()
      Parameters:
      messageGroupId - Message Group ID for messages sent to this queue. Required for FIFO queues. For standard queues, this parameter is optional and can be used for SQS fair queue feature and deduplication.
      Returns:
      this

    • deadLetterQueue

      @Stability(Stable) public SqsQueueProps.Builder deadLetterQueue(IQueue deadLetterQueue)
      Sets the value of TargetBaseProps.getDeadLetterQueue()
      Parameters:
      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.
      Returns:
      this

    • maxEventAge

      @Stability(Stable) public SqsQueueProps.Builder maxEventAge(Duration maxEventAge)
      Sets the value of TargetBaseProps.getMaxEventAge()
      Parameters:
      maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.
      Returns:
      this

    • retryAttempts

      @Stability(Stable) public SqsQueueProps.Builder retryAttempts(Number retryAttempts)
      Sets the value of TargetBaseProps.getRetryAttempts()
      Parameters:
      retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.
      Returns:
      this

    • build

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