class StepFunctionsIntegration

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.StepFunctionsIntegration`
Java	`software.amazon.awscdk.services.apigateway.StepFunctionsIntegration`
Python	`aws_cdk.aws_apigateway.StepFunctionsIntegration`
TypeScript (source)	`@aws-cdk/aws-apigateway` » `StepFunctionsIntegration`

Options to integrate with various StepFunction API.

Example

   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));

Initializer

new StepFunctionsIntegration()

Methods

Name	Description
static startExecution(stateMachine, options?)	Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

static startExecution(stateMachine, options?)

public static startExecution(stateMachine: IStateMachine, options?: StepFunctionsExecutionIntegrationOptions): AwsIntegration

Parameters

stateMachine IStateMachine
options StepFunctionsExecutionIntegrationOptions

Returns

AwsIntegration

Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method. Example

   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));