Package software.amazon.awscdk.aws_apigatewayv2_integrations

Interface HttpEventBridgeIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpEventBridgeIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:19:39.134Z")
@Stability(Stable)
public interface HttpEventBridgeIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize HttpEventBridgeIntegration.

Example:

 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpEventBridgeIntegration;
 IEventBus bus;
 HttpApi httpApi;
 // default integration (PutEvents)
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/default")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpEventBridgeIntegration.Builder.create("DefaultEventBridgeIntegration")
                 .eventBusRef(bus.getEventBusRef())
                 .build())
         .build());
 // explicit subtype
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/put-events")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpEventBridgeIntegration.Builder.create("ExplicitSubtypeIntegration")
                 .eventBusRef(bus.getEventBusRef())
                 .subtype(HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpEventBridgeIntegrationProps.Builder	A builder for HttpEventBridgeIntegrationProps
static final class	HttpEventBridgeIntegrationProps.Jsii$Proxy	An implementation for HttpEventBridgeIntegrationProps

Method Summary

Modifier and Type	Method	Description
static HttpEventBridgeIntegrationProps.Builder	builder()
EventBusReference	getEventBusRef()	EventBridge event bus that integrates with API Gateway.
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
default HttpIntegrationSubtype	getSubtype()	The subtype of the HTTP integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventBusRef

@Stability(Stable)
@NotNull
EventBusReference getEventBusRef()

EventBridge event bus that integrates with API Gateway.

getParameterMapping

@Stability(Stable)
@Nullable
default ParameterMapping getParameterMapping()

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.

Default: - set `Detail` to `$request.body.Detail`, `DetailType` to `$request.body.DetailType`, and `Source` to `$request.body.Source`.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html

getSubtype

@Stability(Stable)
@Nullable
default HttpIntegrationSubtype getSubtype()

The subtype of the HTTP integration.

Only subtypes starting with EVENTBRIDGE_ can be specified.

Default: HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS

builder

@Stability(Stable)
static HttpEventBridgeIntegrationProps.Builder builder()

Returns:

a HttpEventBridgeIntegrationProps.Builder of HttpEventBridgeIntegrationProps