AWS CDK Reference

Appearance

v2.275.0

StepFunctionsIntegration Class ​

Options to integrate with various StepFunction API.

Source
aws-apigateway/lib/integrations/stepfunctions.ts
Type last changed
v2.1.0 · 8 Dec 2021

Example ​

ts
   const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {
      stateMachineType: stepfunctions.StateMachineType.EXPRESS,
      definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),
   });

   const api = new apigateway.RestApi(this, 'Api', {
      restApiName: 'MyApi',
   });
   api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));
python
state_machine = stepfunctions.StateMachine(self, "MyStateMachine",
    state_machine_type=stepfunctions.StateMachineType.EXPRESS,
    definition=stepfunctions.Chain.start(stepfunctions.Pass(self, "Pass"))
)

api = apigateway.RestApi(self, "Api",
    rest_api_name="MyApi"
)
api.root.add_method("GET", apigateway.StepFunctionsIntegration.start_execution(state_machine))
java
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));
csharp
// Install: dotnet add package Amazon.CDK.Lib
var stateMachine = new StateMachine(this, "MyStateMachine", new StateMachineProps {
    StateMachineType = StateMachineType.EXPRESS,
    Definition = Chain.Start(new Pass(this, "Pass"))
});

var api = new RestApi(this, "Api", new RestApiProps {
    RestApiName = "MyApi"
});
api.Root.AddMethod("GET", StepFunctionsIntegration.StartExecution(stateMachine));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
stateMachine := stepfunctions.NewStateMachine(this, jsii.String("MyStateMachine"), &StateMachineProps{
	StateMachineType: stepfunctions.StateMachineType_EXPRESS,
	Definition: stepfunctions.Chain_Start(stepfunctions.NewPass(this, jsii.String("Pass"))),
})

api := apigateway.NewRestApi(this, jsii.String("Api"), &RestApiProps{
	RestApiName: jsii.String("MyApi"),
})
api.Root.AddMethod(jsii.String("GET"), apigateway.StepFunctionsIntegration_StartExecution(stateMachine))

Initializer ​

ts
new StepFunctionsIntegration()
python
StepFunctionsIntegration()
java
new StepFunctionsIntegration()
csharp
new StepFunctionsIntegration()
go
NewStepFunctionsIntegration()

Methods ​

startExecution(stateMachine: IStateMachine, options?: StepFunctionsExecutionIntegrationOptions): AwsIntegration@staticmethod def start_execution(state_machine: IStateMachine, options: typing.Optional[StepFunctionsExecutionIntegrationOptions] = None) -> AwsIntegrationpublic static AwsIntegration startExecution(IStateMachine stateMachine, StepFunctionsExecutionIntegrationOptions options)public static AwsIntegration StartExecution(IStateMachine stateMachine, StepFunctionsExecutionIntegrationOptions? options = null)func StartExecution(StateMachine IStateMachine, Options StepFunctionsExecutionIntegrationOptions) AwsIntegrationstatic#
Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.
example
ts
   const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {
      stateMachineType: stepfunctions.StateMachineType.EXPRESS,
      definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),
   });

   const api = new apigateway.RestApi(this, 'Api', {
      restApiName: 'MyApi',
   });
   api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));