Package software.amazon.awscdk.customresources

Class WaiterStateMachine.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static WaiterStateMachine.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of WaiterStateMachine.Builder.

    • backoffRate

      @Stability(Stable) public WaiterStateMachine.Builder backoffRate(Number backoffRate)
      Backoff between attempts.

      Parameters:
      backoffRate - Backoff between attempts. This parameter is required.
      Returns:
      this

    • interval

      @Stability(Stable) public WaiterStateMachine.Builder interval(Duration interval)
      The interval to wait between attempts.

      Parameters:
      interval - The interval to wait between attempts. This parameter is required.
      Returns:
      this

    • isCompleteHandler

      @Stability(Stable) public WaiterStateMachine.Builder isCompleteHandler(IFunction isCompleteHandler)
      The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.

      Parameters:
      isCompleteHandler - The main handler that notifies if the waiter to decide 'complete' or 'incomplete'. This parameter is required.
      Returns:
      this

    • maxAttempts

      @Stability(Stable) public WaiterStateMachine.Builder maxAttempts(Number maxAttempts)
      Number of attempts.

      Parameters:
      maxAttempts - Number of attempts. This parameter is required.
      Returns:
      this

    • timeoutHandler

      @Stability(Stable) public WaiterStateMachine.Builder timeoutHandler(IFunction timeoutHandler)
      The handler to call if the waiter times out and is incomplete.

      Parameters:
      timeoutHandler - The handler to call if the waiter times out and is incomplete. This parameter is required.
      Returns:
      this

    • disableLogging

      @Stability(Stable) public WaiterStateMachine.Builder disableLogging(Boolean disableLogging)
      Whether logging for the state machine is disabled.

      Default: - false

      Parameters:
      disableLogging - Whether logging for the state machine is disabled. This parameter is required.
      Returns:
      this

    • logOptions

      @Stability(Stable) public WaiterStateMachine.Builder logOptions(LogOptions logOptions)
      Defines what execution history events are logged and where they are logged.

      Default: - A default log group will be created if logging is enabled.

      Parameters:
      logOptions - Defines what execution history events are logged and where they are logged. This parameter is required.
      Returns:
      this

    • build

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