interface HttpEventBridgeIntegrationProps

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

Properties to initialize HttpEventBridgeIntegration.

Example

import * as events from 'aws-cdk-lib/aws-events';
import { HttpEventBridgeIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

declare const bus: events.IEventBus;
declare const httpApi: apigwv2.HttpApi;

// default integration (PutEvents)
httpApi.addRoutes({
  path: '/default',
  methods: [apigwv2.HttpMethod.POST],
  integration: new HttpEventBridgeIntegration('DefaultEventBridgeIntegration', {
    eventBusRef: bus.eventBusRef,
  }),
});

// explicit subtype
httpApi.addRoutes({
  path: '/put-events',
  methods: [apigwv2.HttpMethod.POST],
  integration: new HttpEventBridgeIntegration('ExplicitSubtypeIntegration', {
    eventBusRef: bus.eventBusRef,
    subtype: apigwv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
  }),
});

Properties

Name	Type	Description
eventBusRef	`EventBusReference`	EventBridge event bus 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.

eventBusRef

Type: EventBusReference

EventBridge event bus that integrates with API Gateway.

parameterMapping?

Type: ParameterMapping (optional, default: set Detail to $request.body.Detail, DetailType to $request.body.DetailType, Source to $request.body.Source, and EventBusName to the event bus name from eventBusRef.)

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

When not provided, a default mapping will be used that expects the incoming request body to contain the fields Detail, DetailType, and Source.

The EventBusName is automatically included from eventBusRef in all cases, even when a custom parameterMapping is provided (unless explicitly overridden). This ensures consistency and eliminates redundant configuration.

subtype?

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

The subtype of the HTTP integration.

Only subtypes starting with EVENTBRIDGE_ can be specified.

AWS CDK