interface HttpStepFunctionsIntegrationProps

Language	Type name
.NET	Amazon.CDK.AwsApigatewayv2Integrations.HttpStepFunctionsIntegrationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2integrations#HttpStepFunctionsIntegrationProps
Java	software.amazon.awscdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegrationProps
Python	aws_cdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegrationProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2_integrations » HttpStepFunctionsIntegrationProps

Properties to initialize HttpStepFunctionsIntegration.

Example

import { HttpStepFunctionsIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';

declare const stateMachine: sfn.StateMachine;
declare const httpApi: apigwv2.HttpApi;

httpApi.addRoutes({
  path: '/start',
  methods: [ apigwv2.HttpMethod.POST ],
  integration: new HttpStepFunctionsIntegration('StartExecutionIntegration', {
    stateMachine,
    subtype: apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION,
  }),
});

httpApi.addRoutes({
  path: '/start-sync',
  methods: [ apigwv2.HttpMethod.POST ],
  integration: new HttpStepFunctionsIntegration('StartSyncExecutionIntegration', {
    stateMachine,
    subtype: apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_START_SYNC_EXECUTION,
  }),
});

httpApi.addRoutes({
  path: '/stop',
  methods: [ apigwv2.HttpMethod.POST ],
  integration: new HttpStepFunctionsIntegration('StopExecutionIntegration', {
    stateMachine,
    subtype: apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_STOP_EXECUTION,
    // For the `STOP_EXECUTION` subtype, it is necessary to specify the `executionArn`.
    parameterMapping: new apigwv2.ParameterMapping()
      .custom('ExecutionArn', '$request.querystring.executionArn'),
  }),
});

Properties

Name	Type	Description
stateMachine	StateMachine	Statemachine that Integrates with API Gateway.
parameterMapping?	ParameterMapping	Specifies how to transform HTTP requests before sending them to the backend.
subtype?	HttpIntegrationSubtype	The subtype of the HTTP integration.

---

stateMachine

Type: StateMachine

Statemachine that Integrates with API Gateway.

---

parameterMapping?

Type: ParameterMapping (optional, default: specify only StateMachineArn)

Specifies how to transform HTTP requests before sending them to the backend.

When the subtype is either START_EXECUTION or START_SYNC_EXECUTION, it is necessary to specify the StateMachineArn. Conversely, when the subtype is STOP_EXECUTION, the ExecutionArn must be specified.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

---

subtype?

Type: HttpIntegrationSubtype (optional, default: HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION)

The subtype of the HTTP integration.

Only subtypes starting with STEPFUNCTIONS_ can be specified.