Package software.amazon.awscdk.services.scheduler.targets.alpha

Class SqsSendMessage.Builder

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

  • Method Details

    • create

      @Stability(Experimental) public static SqsSendMessage.Builder create(IQueue queue)
      Parameters:
      queue - This parameter is required.
      Returns:
      a new instance of SqsSendMessage.Builder.

    • deadLetterQueue

      @Stability(Experimental) public SqsSendMessage.Builder deadLetterQueue(IQueue deadLetterQueue)
      (experimental) The SQS queue to be used as deadLetterQueue.

      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. This parameter is required.
      Returns:
      this

    • input

      @Stability(Experimental) public SqsSendMessage.Builder input(ScheduleTargetInput input)
      (experimental) Input passed to the target.

      Default: - no input.

      Parameters:
      input - Input passed to the target. This parameter is required.
      Returns:
      this

    • maxEventAge

      @Stability(Experimental) public SqsSendMessage.Builder maxEventAge(Duration maxEventAge)
      (experimental) The maximum age of a request that Scheduler sends to a target for processing.

      Minimum value of 60. Maximum value of 86400.

      Default: Duration.hours(24)

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

    • retryAttempts

      @Stability(Experimental) public SqsSendMessage.Builder retryAttempts(Number retryAttempts)
      (experimental) The maximum number of times to retry when the target returns an error.

      Minimum value of 0. Maximum value of 185.

      Default: 185

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

    • role

      @Stability(Experimental) public SqsSendMessage.Builder role(IRole role)
      (experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.

      If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.

      Default: - created by target

      Parameters:
      role - An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf. This parameter is required.
      Returns:
      this

    • messageGroupId

      @Stability(Experimental) public SqsSendMessage.Builder messageGroupId(String messageGroupId)
      (experimental) The FIFO message group ID to use as the target.

      This must be specified when the target is a FIFO queue. If you specify a FIFO queue as a target, the queue must have content-based deduplication enabled.

      A length of messageGroupId must be between 1 and 128.

      Default: - no message group ID

      Parameters:
      messageGroupId - The FIFO message group ID to use as the target. This parameter is required.
      Returns:
      this
      See Also:

    • build

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