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

Class ScheduleTargetBaseProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • deadLetterQueue

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

    • input

      @Stability(Experimental) public ScheduleTargetBaseProps.Builder input(ScheduleTargetInput input)
      Sets the value of ScheduleTargetBaseProps.getInput()
      Parameters:
      input - Input passed to the target.
      Returns:
      this

    • maxEventAge

      @Stability(Experimental) public ScheduleTargetBaseProps.Builder maxEventAge(Duration maxEventAge)
      Sets the value of ScheduleTargetBaseProps.getMaxEventAge()
      Parameters:
      maxEventAge - The maximum age of a request that Scheduler sends to a target for processing. Minimum value of 60. Maximum value of 86400.
      Returns:
      this

    • retryAttempts

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

    • role

      @Stability(Experimental) public ScheduleTargetBaseProps.Builder role(IRole role)
      Sets the value of ScheduleTargetBaseProps.getRole()
      Parameters:
      role - 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.

      Universal target automatically create an IAM role if you do not specify your own IAM role. However, in comparison with templated targets, for universal targets you must grant the required IAM permissions yourself.

      Returns:
      this

    • build

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