Package software.amazon.awscdk.customresources

Class WaiterStateMachine

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.customresources.WaiterStateMachine
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:25.122Z") @Stability(Stable) public class WaiterStateMachine extends software.constructs.Construct
A very simple StateMachine construct highly customized to the provider framework.

We previously used CfnResource instead of CfnStateMachine to avoid depending on aws-stepfunctions module, but now it is okay.

The state machine continuously calls the isCompleteHandler, until it succeeds or times out. The handler is called maxAttempts times with an interval duration and a backoffRate rate.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.customresources.*;
 Function function_;
 LogGroup logGroup;
 WaiterStateMachine waiterStateMachine = WaiterStateMachine.Builder.create(this, "MyWaiterStateMachine")
         .backoffRate(123)
         .interval(Duration.minutes(30))
         .isCompleteHandler(function_)
         .maxAttempts(123)
         .timeoutHandler(function_)
         // the properties below are optional
         .disableLogging(false)
         .logOptions(LogOptions.builder()
                 .destination(logGroup)
                 .includeExecutionData(false)
                 .level(LogLevel.OFF)
                 .build())
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WaiterStateMachine.Builder
    A fluent builder for WaiterStateMachine.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    WaiterStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    WaiterStateMachine(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    WaiterStateMachine(software.constructs.Construct scope, String id, WaiterStateMachineProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getStateMachineArn()
    The ARN of the state machine.
    Grant
    grantStartExecution(IGrantable identity)
    Grant the given identity permissions on StartExecution of the state machine.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • WaiterStateMachine

      protected WaiterStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

    • WaiterStateMachine

      protected WaiterStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • WaiterStateMachine

      @Stability(Stable) public WaiterStateMachine(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull WaiterStateMachineProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • grantStartExecution

      @Stability(Stable) @NotNull public Grant grantStartExecution(@NotNull IGrantable identity)
      Grant the given identity permissions on StartExecution of the state machine.

      Parameters:
      identity - This parameter is required.

    • getStateMachineArn

      @Stability(Stable) @NotNull public String getStateMachineArn()
      The ARN of the state machine.