aws-cdk-lib.interfaces.aws_events.EventBusReference

EventBusReference Struct

A reference to a EventBus resource.

Source

Generated code

Type last changed

v2.224.0 · 13 Nov 2025

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

eventBusArnstringevent_bus_arnstreventBusArnStringEventBusArnstringEventBusArn*stringrequired#

The ARN of the EventBus resource.

eventBusNamestringevent_bus_namestreventBusNameStringEventBusNamestringEventBusName*stringrequired#

The Name of the EventBus resource.