1 | import * as events from '@aws-cdk/aws-events';
|
2 | import * as iam from '@aws-cdk/aws-iam';
|
3 | import { TargetBaseProps } from './util';
|
4 | /**
|
5 | * Customize the EventBridge Api Destinations Target
|
6 | */
|
7 | export interface ApiDestinationProps extends TargetBaseProps {
|
8 | /**
|
9 | * The event to send
|
10 | *
|
11 | * @default - the entire EventBridge event
|
12 | */
|
13 | readonly event?: events.RuleTargetInput;
|
14 | /**
|
15 | * The role to assume before invoking the target
|
16 | *
|
17 | * @default - a new role will be created
|
18 | */
|
19 | readonly eventRole?: iam.IRole;
|
20 | /**
|
21 | * Additional headers sent to the API Destination
|
22 | *
|
23 | * These are merged with headers specified on the Connection, with
|
24 | * the headers on the Connection taking precedence.
|
25 | *
|
26 | * You can only specify secret values on the Connection.
|
27 | *
|
28 | * @default - none
|
29 | */
|
30 | readonly headerParameters?: Record<string, string>;
|
31 | /**
|
32 | * Path parameters to insert in place of path wildcards (`*`).
|
33 | *
|
34 | * If the API destination has a wilcard in the path, these path parts
|
35 | * will be inserted in that place.
|
36 | *
|
37 | * @default - none
|
38 | */
|
39 | readonly pathParameterValues?: string[];
|
40 | /**
|
41 | * Additional query string parameters sent to the API Destination
|
42 | *
|
43 | * These are merged with headers specified on the Connection, with
|
44 | * the headers on the Connection taking precedence.
|
45 | *
|
46 | * You can only specify secret values on the Connection.
|
47 | *
|
48 | * @default - none
|
49 | */
|
50 | readonly queryStringParameters?: Record<string, string>;
|
51 | }
|
52 | /**
|
53 | * Use an API Destination rule target.
|
54 | */
|
55 | export declare class ApiDestination implements events.IRuleTarget {
|
56 | private readonly apiDestination;
|
57 | private readonly props;
|
58 | constructor(apiDestination: events.IApiDestination, props?: ApiDestinationProps);
|
59 | /**
|
60 | * Returns a RuleTarget that can be used to trigger API destinations
|
61 | * from an EventBridge event.
|
62 | */
|
63 | bind(_rule: events.IRule, _id?: string): events.RuleTargetConfig;
|
64 | }
|