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

Version 2 of the AWS Cloud Development Kit library

import * as apigwv2 from '../../../aws-apigatewayv2';
import type * as events from '../../../aws-events';
/**
 * Properties to initialize `HttpEventBridgeIntegration`.
 */
export interface HttpEventBridgeIntegrationProps {
    /**
     * 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`.
     *
     * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
     * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
     *
     * @default - set `Detail` to `$request.body.Detail`,
     * `DetailType` to `$request.body.DetailType`, and `Source` to `$request.body.Source`.
     */
    readonly parameterMapping?: apigwv2.ParameterMapping;
    /**
     * The subtype of the HTTP integration.
     *
     * Only subtypes starting with EVENTBRIDGE_ can be specified.
     *
     * @default HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS
     */
    readonly subtype?: apigwv2.HttpIntegrationSubtype;
    /**
     * EventBridge event bus that integrates with API Gateway
     */
    readonly eventBusRef: events.EventBusReference;
}
/**
 * The EventBridge PutEvents integration resource for HTTP API
 */
export declare class HttpEventBridgeIntegration extends apigwv2.HttpRouteIntegration {
    private readonly props;
    private readonly subtype;
    /**
     * @param id id of the underlying integration construct
     * @param props properties to configure the integration
     */
    constructor(id: string, props: HttpEventBridgeIntegrationProps);
    bind(options: apigwv2.HttpRouteIntegrationBindOptions): apigwv2.HttpRouteIntegrationConfig;
    private createDefaultParameterMapping;
}