Package software.amazon.awscdk.services.apigateway

Class StepFunctionsIntegration

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.StepFunctionsIntegration
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.599Z") @Stability(Stable) public class StepFunctionsIntegration extends software.amazon.jsii.JsiiObject
Options to integrate with various StepFunction API.

Example: 

 StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
         .stateMachineType(StateMachineType.EXPRESS)
         .definition(Chain.start(new Pass(this, "Pass")))
         .build();
 RestApi api = RestApi.Builder.create(this, "Api")
         .restApiName("MyApi")
         .build();
 api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    StepFunctionsIntegration()
     
    protected
    StepFunctionsIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    StepFunctionsIntegration(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static AwsIntegration
    startExecution(IStateMachine stateMachine)
    Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.
    static AwsIntegration
    startExecution(IStateMachine stateMachine, StepFunctionsExecutionIntegrationOptions options)
    Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • StepFunctionsIntegration

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

    • StepFunctionsIntegration

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

    • StepFunctionsIntegration

      @Stability(Stable) public StepFunctionsIntegration()

  • Method Details

    • startExecution

      @Stability(Stable) @NotNull public static AwsIntegration startExecution(@NotNull IStateMachine stateMachine, @Nullable StepFunctionsExecutionIntegrationOptions options)
      Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

      Example: 

       StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
         .stateMachineType(StateMachineType.EXPRESS)
         .definition(Chain.start(new Pass(this, "Pass")))
         .build();
 RestApi api = RestApi.Builder.create(this, "Api")
         .restApiName("MyApi")
         .build();
 api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));

      Parameters:
      stateMachine - This parameter is required.
      options -

    • startExecution

      @Stability(Stable) @NotNull public static AwsIntegration startExecution(@NotNull IStateMachine stateMachine)
      Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

      Example: 

       StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
         .stateMachineType(StateMachineType.EXPRESS)
         .definition(Chain.start(new Pass(this, "Pass")))
         .build();
 RestApi api = RestApi.Builder.create(this, "Api")
         .restApiName("MyApi")
         .build();
 api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));

      Parameters:
      stateMachine - This parameter is required.