class ApiGatewayV2

Language	Type name
.NET	Amazon.CDK.AWS.Events.Targets.ApiGatewayV2
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#ApiGatewayV2
Java	software.amazon.awscdk.services.events.targets.ApiGatewayV2
Python	aws_cdk.aws_events_targets.ApiGatewayV2
TypeScript (source)	aws-cdk-lib » aws_events_targets » ApiGatewayV2

Implements IRuleTarget

Use an API Gateway V2 HTTP APIs as a target for Amazon EventBridge rules.

Example

import * as apigwv2 from 'aws-cdk-lib/aws-apigatewayv2';

declare const httpApi: apigwv2.HttpApi;
declare const rule: events.Rule;

rule.addTarget(new targets.ApiGatewayV2(httpApi));

Initializer

new ApiGatewayV2(httpApi: IHttpApi, props?: ApiGatewayProps)

Parameters

• httpApi IHttpApi — - IHttpApi implementation to use as event target.
• props ApiGatewayProps — - Properties to configure the APIGateway target.

Properties

Name	Type	Description
iHttpApi	IHttpApi	Returns the target IHttpApi.

---

iHttpApi

Type: IHttpApi

Returns the target IHttpApi.

Methods

Name	Description
bind(rule, _id?)	Returns a RuleTarget that can be used to trigger this API Gateway HTTP APIs as a result from an EventBridge event.

---

bind(rule, _id?)

public bind(rule: IRule, _id?: string): RuleTargetConfig

Parameters

• rule IRule
• _id string

Returns

• RuleTargetConfig

Returns a RuleTarget that can be used to trigger this API Gateway HTTP APIs as a result from an EventBridge event.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-use-resource-based.html#eb-api-gateway-permissions