aws-cdk-lib.aws_apigateway.StepFunctionsIntegration

class StepFunctionsIntegration

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.StepFunctionsIntegration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#StepFunctionsIntegration
Javasoftware.amazon.awscdk.services.apigateway.StepFunctionsIntegration
Pythonaws_cdk.aws_apigateway.StepFunctionsIntegration
TypeScript (source)aws-cdk-lib » 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

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