aws-cdk-lib.aws_apigatewayv2.HttpIntegrationSubtype

HttpIntegrationSubtype Enum

Supported integration subtypes.

Source

aws-apigatewayv2/lib/http/integration.ts

Type last changed

v2.112.0 · 1 Dec 2023

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'),
  }),
});

Members

Member	Description
EVENTBRIDGE_PUT_EVENTS	EventBridge PutEvents integration.
SQS_SEND_MESSAGE	SQS SendMessage integration.
SQS_RECEIVE_MESSAGE	SQS ReceiveMessage integration,.
SQS_DELETE_MESSAGE	SQS DeleteMessage integration,.
SQS_PURGE_QUEUE	SQS PurgeQueue integration.
APPCONFIG_GET_CONFIGURATION	AppConfig GetConfiguration integration.
KINESIS_PUT_RECORD	Kinesis PutRecord integration.
STEPFUNCTIONS_START_EXECUTION	Step Functions StartExecution integration.
STEPFUNCTIONS_START_SYNC_EXECUTION	Step Functions StartSyncExecution integration.
STEPFUNCTIONS_STOP_EXECUTION	Step Functions StopExecution integration.

Referenced by

• HttpEventBridgeIntegrationProps.subtypesubtypesubtypeSubtypeSubtype
• HttpIntegrationProps.integrationSubtypeintegration_subtypeintegrationSubtypeIntegrationSubtypeIntegrationSubtype
• HttpRouteIntegrationConfig.subtypesubtypesubtypeSubtypeSubtype
• HttpSqsIntegrationProps.subtypesubtypesubtypeSubtypeSubtype
• HttpStepFunctionsIntegrationProps.subtypesubtypesubtypeSubtypeSubtype