feat(apigatewayv2-integrations): add PutEvents support for EventBridge integration #35766

jasdeepbhalla · 2025-10-17T03:39:32Z

Issue #35714

Reason for this change

The CDK currently lacks a high-level L2 construct to enable HTTP API integration with EventBridge PutEvents. Users must manually configure the integration, including IAM roles and parameter mapping, which adds complexity and potential for misconfiguration. This feature simplifies usage and aligns with other existing HTTP API integrations like SQS.

Description of changes

Added HttpEventBridgeIntegration class extending HttpRouteIntegration.
Introduced HttpEventBridgeIntegrationProps interface with required parameters: detail, detailType, source; and optional parameters: eventBusName, resources, time, region, traceHeader, invocationRole, description, timeout.
Automatically creates the IAM role with the necessary permissions if invocationRole is not provided.
Implements parameter mapping for EventBridge PutEvents API.
Added unit tests to verify integration behavior.
Updated documentation to include usage examples.

Example usage:

const stack = new Stack();
const bus = new EventBus(stack, 'Events');
const api = new HttpApi(stack, 'HttpApi');
api.addRoutes({
  path: '/default',
  methods: [apigwv2.HttpMethod.POST],
  integration: new HttpEventBridgeIntegration('defaultIntegration', {
    eventBus: bus,
  }),
});

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

Description of how you validated changes

Added unit tests covering successful integration creation and parameter mapping.
Manual testing with a sample stack to verify events are sent correctly to EventBridge.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…e integration

aws-cdk-automation

(This review is outdated)

…e integration

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

jolo-dev · 2025-10-17T16:06:24Z

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/http/eventbridge.ts

+   *
+   * @default HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS
+   */
+  readonly subtype?: apigwv2.HttpIntegrationSubtype;


Shall we fix the HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS? Otherwise, you could pass another subtype here.

Yeah, that’s another valid approach. Keeping it this way allows us to easily extend support to other subtypes in the future.

If an unknown subtype is provided, we already handle it by throwing an error, so that scenario is covered.

Yeah, I understand.
But from the DX-perspective the developer does not know that only HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS is possible.

Perhaps you could create a new type

type HttpEventBridgeIntegrationSubtype = 'EVENTBRIDGE_PUT_EVENTS' // then you could use a discreminator to add more events; export interface HttpEventBridgeIntegrationProps { // .. readonly subtype?: HttpEventBridgeIntegrationSubtype; // ... } export class HttpEventBridgeIntegration extends apigwv2.HttpRouteIntegration { private readonly subtype: apigwv2.HttpIntegrationSubtype; /** * @param id id of the underlying integration construct * @param props properties to configure the integration */ constructor( id: string, private readonly props: HttpEventBridgeIntegrationProps, ) { super(id); this.subtype = this.props.subtype; } public bind(options: apigwv2.HttpRouteIntegrationBindOptions): apigwv2.HttpRouteIntegrationConfig { // ... return { payloadFormatVersion: apigwv2.PayloadFormatVersion.VERSION_1_0, type: apigwv2.HttpIntegrationType.AWS_PROXY, subtype: apigwv2.HttpIntegrationSubtype[this.props.subtype ?? 'EVENTBRIDGE_PUT_EVENTS'], // <-- this needs to be changes credentials: apigwv2.IntegrationCredentials.fromRole(invokeRole), connectionType: apigwv2.HttpConnectionType.INTERNET, parameterMapping: this.props.parameterMapping ?? this.createDefaultParameterMapping(options.scope), }; } }

Good Point, let me update the code

jolo-dev · 2025-10-17T16:22:42Z

@jasdeepbhalla Ah, you were faster than me :D
Good work. I would have done one thing differently.

…e_integrations

…e integration

jasdeepbhalla · 2025-10-29T04:03:32Z

@jolo-dev @pahud This PR is ready for review!

…e_integrations

gasolima · 2026-01-08T08:30:40Z

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/http/eventbridge.ts

+   *
+   * @default HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS
+   */
+  readonly subtype?: HttpIntegrationSubtypeEventBridgePutEvents;


This subtype need to take something more general so if in the future they add another type we can have it without breaking the backward compatibility.

You can find the same principle applied here

Yeah agreed 👍

gasolima · 2026-01-08T08:44:06Z

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/http/eventbridge.ts

+    switch (this.subtype) {
+      case apigwv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS:
+        return new apigwv2.ParameterMapping()
+          .custom('EventBusName', this.props.eventBus.eventBusName)


is there any reason for adding non required field for the default parameters? In the case of not sending any bus name falling back to the default one, i believe we can get the information needed by From functions

Also can we add in code comment the link for the required parameters field table, this will help maintainers in case there's a problem to fix

No, you are right, we should just keep the default ones in there. Updated the code and added comments to keep future readers informed about the required params

gasolima · 2026-01-08T08:50:21Z

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/http/eventbridge.ts

+  /**
+   * EventBridge event bus that integrates with API Gateway
+   */
+  readonly eventBus: events.IEventBus;


It's a new thing in CDK, from now on we're using refs as much as possible, so can you change it to use IEventBusRef

Thats a good point, updated.

…e_integrations

Pull request has been modified.

github-actions · 2026-01-10T03:19:27Z

⚠️ Experimental Feature: This security report is currently in experimental phase. Results may include false positives and the rules are being actively refined.
Please try merge from main to avoid findings unrelated to the PR.

	Tests	Passed ✅	Skipped	Failed
Security Guardian Results	48 ran	48 passed

Test	Result
No test annotations available

View Security Guardian Results

github-actions · 2026-01-10T03:19:30Z

⚠️ Experimental Feature: This security report is currently in experimental phase. Results may include false positives and the rules are being actively refined.
Please try merge from main to avoid findings unrelated to the PR.

	Tests	Passed ✅	Skipped	Failed
Security Guardian Results with resolved templates	48 ran	48 passed

Test	Result
No test annotations available

View Security Guardian Results with resolved templates

…e integration

mergify · 2026-01-12T11:38:25Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2026-01-12T11:39:00Z

…e_integrations

github-actions · 2026-01-12T14:57:45Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

707b748

…e integration

aws-cdk-automation requested a review from a team October 17, 2025 03:39

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Oct 17, 2025

aws-cdk-automation previously requested changes Oct 17, 2025

View reviewed changes

jasdeepbhalla mentioned this pull request Oct 17, 2025

apigatewayv2-integrations: Add support for PutEvents to Eventbridge integration #35714

Closed

2 tasks

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

15668ba

…e integration

jolo-dev reviewed Oct 17, 2025

View reviewed changes

jasdeepbhalla added 2 commits October 28, 2025 20:44

Merge branch 'main' into support_putevents_in_apigatewayv2_eventbridg…

b8990cd

…e_integrations

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

3cb751f

…e integration

jasdeepbhalla force-pushed the support_putevents_in_apigatewayv2_eventbridge_integrations branch from 7a23efc to 3cb751f Compare October 29, 2025 04:01

aws-cdk-automation added the pr/needs-further-review PR requires additional review from our team specialists due to the scope or complexity of changes. label Oct 29, 2025

github-actions bot mentioned this pull request Nov 1, 2025

Monthly PR metrics report #35917

Open

pahud mentioned this pull request Nov 13, 2025

docs(contributing): add section explaining PR review process #36044

Open

1 task

Merge branch 'main' into support_putevents_in_apigatewayv2_eventbridg…

8bb6806

…e_integrations

pahud mentioned this pull request Nov 17, 2025

CI Pending Approval - 23 PR(s) pahud/aws-cdk#11

Open

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 18, 2025

gasolima previously requested changes Jan 8, 2026

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 8, 2026

Merge branch 'main' into support_putevents_in_apigatewayv2_eventbridg…

5f57a6d

…e_integrations

pahud mentioned this pull request Jan 10, 2026

Failed CodeBuild CI - 29 PR(s) pahud/aws-cdk#17

Open

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

a663e35

…e integration

jasdeepbhalla added 2 commits January 10, 2026 14:20

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

fadec12

…e integration

feat(apigatewayv2-integrations): add PutEvents support for EventBridg…

958d03e

…e integration

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 10, 2026

gasolima added the pr/needs-integration-tests-deployment Requires the PR to deploy the integration test snapshots. label Jan 12, 2026

gasolima temporarily deployed to deployment-integ-test January 12, 2026 11:04 — with GitHub Actions Inactive

gasolima approved these changes Jan 12, 2026

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 12, 2026

Merge branch 'main' into support_putevents_in_apigatewayv2_eventbridg…

a3f49d9

…e_integrations

mergify bot temporarily deployed to deployment-integ-test January 12, 2026 13:39 Inactive

mergify bot merged commit d879e4d into aws:main Jan 12, 2026
24 of 25 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Jan 12, 2026

feat(apigatewayv2-integrations): add PutEvents support for EventBridge integration #35766

feat(apigatewayv2-integrations): add PutEvents support for EventBridge integration #35766

Uh oh!

Conversation

jasdeepbhalla commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue #35714

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jolo-dev Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jolo-dev commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasdeepbhalla commented Oct 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergify bot commented Jan 12, 2026

Uh oh!

mergify bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Uh oh!

Uh oh!

github-actions bot commented Jan 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jasdeepbhalla commented Oct 17, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

jolo-dev Oct 17, 2025 •

edited

Loading

jolo-dev commented Oct 17, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2026 •

edited

Loading

github-actions bot commented Jan 10, 2026 •

edited

Loading

mergify bot commented Jan 12, 2026 •

edited

Loading