| 1 | import { IResource, Resource } from '@aws-cdk/core';
|
| 2 | import { Construct } from 'constructs';
|
| 3 | import { HttpMethod, IConnection } from './connection';
|
| 4 | /**
|
| 5 | * The event API Destination properties
|
| 6 | */
|
| 7 | export interface ApiDestinationProps {
|
| 8 | /**
|
| 9 | * The name for the API destination.
|
| 10 | * @default - A unique name will be generated
|
| 11 | */
|
| 12 | readonly apiDestinationName?: string;
|
| 13 | /**
|
| 14 | * A description for the API destination.
|
| 15 | *
|
| 16 | * @default - none
|
| 17 | */
|
| 18 | readonly description?: string;
|
| 19 | /**
|
| 20 | * The ARN of the connection to use for the API destination
|
| 21 | */
|
| 22 | readonly connection: IConnection;
|
| 23 | /**
|
| 24 | * The URL to the HTTP invocation endpoint for the API destination..
|
| 25 | */
|
| 26 | readonly endpoint: string;
|
| 27 | /**
|
| 28 | * The method to use for the request to the HTTP invocation endpoint.
|
| 29 | *
|
| 30 | * @default HttpMethod.POST
|
| 31 | */
|
| 32 | readonly httpMethod?: HttpMethod;
|
| 33 | /**
|
| 34 | * The maximum number of requests per second to send to the HTTP invocation endpoint.
|
| 35 | *
|
| 36 | * @default - Not rate limited
|
| 37 | */
|
| 38 | readonly rateLimitPerSecond?: number;
|
| 39 | }
|
| 40 | /**
|
| 41 | * Interface for API Destinations
|
| 42 | */
|
| 43 | export interface IApiDestination extends IResource {
|
| 44 | /**
|
| 45 | * The Name of the Api Destination created.
|
| 46 | * @attribute
|
| 47 | */
|
| 48 | readonly apiDestinationName: string;
|
| 49 | /**
|
| 50 | * The ARN of the Api Destination created.
|
| 51 | * @attribute
|
| 52 | */
|
| 53 | readonly apiDestinationArn: string;
|
| 54 | }
|
| 55 | /**
|
| 56 | * Define an EventBridge Api Destination
|
| 57 | *
|
| 58 | * @resource AWS::Events::ApiDestination
|
| 59 | */
|
| 60 | export declare class ApiDestination extends Resource implements IApiDestination {
|
| 61 | /**
|
| 62 | * The Connection to associate with Api Destination
|
| 63 | */
|
| 64 | readonly connection: IConnection;
|
| 65 | /**
|
| 66 | * The Name of the Api Destination created.
|
| 67 | * @attribute
|
| 68 | */
|
| 69 | readonly apiDestinationName: string;
|
| 70 | /**
|
| 71 | * The ARN of the Api Destination created.
|
| 72 | * @attribute
|
| 73 | */
|
| 74 | readonly apiDestinationArn: string;
|
| 75 | constructor(scope: Construct, id: string, props: ApiDestinationProps);
|
| 76 | }
|