L2 Construct

ApiDestination

Define an EventBridge Api Destination.

Import

import { ApiDestination } from 'aws-cdk-lib/aws-events';

Or use the module namespace:

import * as events from 'aws-cdk-lib/aws-events';
// events.ApiDestination

Configuration passed to the constructor as ApiDestinationProps.

connectionRequired

IConnectionRef

The ARN of the connection to use for the API destination.

endpointRequired

string

The URL to the HTTP invocation endpoint for the API destination..

apiDestinationNameOptional

string

The name for the API destination.

Default: - A unique name will be generated

descriptionOptional

string

A description for the API destination.

Default: - none

httpMethodOptional

HttpMethod

The method to use for the request to the HTTP invocation endpoint.

Default: HttpMethod.POST

rateLimitPerSecondOptional

number

The maximum number of requests per second to send to the HTTP invocation endpoint.

Default: - Not rate limited

Everything you need to know about Amazon EventBridge on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-events

Properties6