UNPKG

121 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnApiDestination`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html
10 */
11export interface CfnApiDestinationProps {
12 /**
13 * The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn
16 */
17 readonly connectionArn: string;
18 /**
19 * The method to use for the request to the HTTP invocation endpoint.
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod
22 */
23 readonly httpMethod: string;
24 /**
25 * The URL to the HTTP invocation endpoint for the API destination.
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint
28 */
29 readonly invocationEndpoint: string;
30 /**
31 * A description for the API destination to create.
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description
34 */
35 readonly description?: string;
36 /**
37 * The maximum number of requests per second to send to the HTTP invocation endpoint.
38 *
39 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond
40 */
41 readonly invocationRateLimitPerSecond?: number;
42 /**
43 * The name for the API destination to create.
44 *
45 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name
46 */
47 readonly name?: string;
48}
49/**
50 * A CloudFormation `AWS::Events::ApiDestination`
51 *
52 * Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
53 *
54 * When using ApiDesinations with OAuth authentication we recommend these best practices:
55 *
56 * - Create a secret in Secrets Manager with your OAuth credentials.
57 * - Reference that secret in your CloudFormation template for `AWS::Events::Connection` using CloudFormation dynamic reference syntax. For more information, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .
58 *
59 * When the Connection resource is created the secret will be passed to EventBridge and stored in the customer account using “Service Linked Secrets,” effectively creating two secrets. This will minimize the cost because the original secret is only accessed when a CloudFormation template is created or updated, not every time an event is sent to the ApiDestination. The secret stored in the customer account by EventBridge is the one used for each event sent to the ApiDestination and AWS is responsible for the fees.
60 *
61 * > The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.
62 *
63 * For examples of CloudFormation templates that use secrets, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#aws-resource-events-connection--examples) .
64 *
65 * @cloudformationResource AWS::Events::ApiDestination
66 * @stability external
67 *
68 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html
69 */
70export declare class CfnApiDestination extends cdk.CfnResource implements cdk.IInspectable {
71 /**
72 * The CloudFormation resource type name for this resource class.
73 */
74 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::ApiDestination";
75 /**
76 * A factory method that creates a new instance of this class from an object
77 * containing the CloudFormation properties of this resource.
78 * Used in the @aws-cdk/cloudformation-include module.
79 *
80 * @internal
81 */
82 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApiDestination;
83 /**
84 * The ARN of the API destination that was created by the request.
85 * @cloudformationAttribute Arn
86 */
87 readonly attrArn: string;
88 /**
89 * The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
90 *
91 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn
92 */
93 connectionArn: string;
94 /**
95 * The method to use for the request to the HTTP invocation endpoint.
96 *
97 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod
98 */
99 httpMethod: string;
100 /**
101 * The URL to the HTTP invocation endpoint for the API destination.
102 *
103 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint
104 */
105 invocationEndpoint: string;
106 /**
107 * A description for the API destination to create.
108 *
109 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description
110 */
111 description: string | undefined;
112 /**
113 * The maximum number of requests per second to send to the HTTP invocation endpoint.
114 *
115 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond
116 */
117 invocationRateLimitPerSecond: number | undefined;
118 /**
119 * The name for the API destination to create.
120 *
121 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name
122 */
123 name: string | undefined;
124 /**
125 * Create a new `AWS::Events::ApiDestination`.
126 *
127 * @param scope - scope in which this resource is defined
128 * @param id - scoped id of the resource
129 * @param props - resource properties
130 */
131 constructor(scope: cdk.Construct, id: string, props: CfnApiDestinationProps);
132 /**
133 * Examines the CloudFormation resource and discloses attributes.
134 *
135 * @param inspector - tree inspector to collect and process attributes
136 *
137 */
138 inspect(inspector: cdk.TreeInspector): void;
139 protected get cfnProperties(): {
140 [key: string]: any;
141 };
142 protected renderProperties(props: {
143 [key: string]: any;
144 }): {
145 [key: string]: any;
146 };
147}
148/**
149 * Properties for defining a `CfnArchive`
150 *
151 * @struct
152 * @stability external
153 *
154 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
155 */
156export interface CfnArchiveProps {
157 /**
158 * The ARN of the event bus that sends events to the archive.
159 *
160 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn
161 */
162 readonly sourceArn: string;
163 /**
164 * The name for the archive to create.
165 *
166 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename
167 */
168 readonly archiveName?: string;
169 /**
170 * A description for the archive.
171 *
172 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description
173 */
174 readonly description?: string;
175 /**
176 * An event pattern to use to filter events sent to the archive.
177 *
178 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern
179 */
180 readonly eventPattern?: any | cdk.IResolvable;
181 /**
182 * The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
183 *
184 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays
185 */
186 readonly retentionDays?: number;
187}
188/**
189 * A CloudFormation `AWS::Events::Archive`
190 *
191 * Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.
192 *
193 * @cloudformationResource AWS::Events::Archive
194 * @stability external
195 *
196 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
197 */
198export declare class CfnArchive extends cdk.CfnResource implements cdk.IInspectable {
199 /**
200 * The CloudFormation resource type name for this resource class.
201 */
202 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::Archive";
203 /**
204 * A factory method that creates a new instance of this class from an object
205 * containing the CloudFormation properties of this resource.
206 * Used in the @aws-cdk/cloudformation-include module.
207 *
208 * @internal
209 */
210 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnArchive;
211 /**
212 * The ARN of the archive created.
213 * @cloudformationAttribute Arn
214 */
215 readonly attrArn: string;
216 /**
217 * The ARN of the event bus that sends events to the archive.
218 *
219 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn
220 */
221 sourceArn: string;
222 /**
223 * The name for the archive to create.
224 *
225 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename
226 */
227 archiveName: string | undefined;
228 /**
229 * A description for the archive.
230 *
231 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description
232 */
233 description: string | undefined;
234 /**
235 * An event pattern to use to filter events sent to the archive.
236 *
237 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern
238 */
239 eventPattern: any | cdk.IResolvable | undefined;
240 /**
241 * The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
242 *
243 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays
244 */
245 retentionDays: number | undefined;
246 /**
247 * Create a new `AWS::Events::Archive`.
248 *
249 * @param scope - scope in which this resource is defined
250 * @param id - scoped id of the resource
251 * @param props - resource properties
252 */
253 constructor(scope: cdk.Construct, id: string, props: CfnArchiveProps);
254 /**
255 * Examines the CloudFormation resource and discloses attributes.
256 *
257 * @param inspector - tree inspector to collect and process attributes
258 *
259 */
260 inspect(inspector: cdk.TreeInspector): void;
261 protected get cfnProperties(): {
262 [key: string]: any;
263 };
264 protected renderProperties(props: {
265 [key: string]: any;
266 }): {
267 [key: string]: any;
268 };
269}
270/**
271 * Properties for defining a `CfnConnection`
272 *
273 * @struct
274 * @stability external
275 *
276 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
277 */
278export interface CfnConnectionProps {
279 /**
280 * The type of authorization to use for the connection.
281 *
282 * > OAUTH tokens are refreshed when a 401 or 407 response is returned.
283 *
284 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype
285 */
286 readonly authorizationType: string;
287 /**
288 * A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint.
289 *
290 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters
291 */
292 readonly authParameters: CfnConnection.AuthParametersProperty | cdk.IResolvable;
293 /**
294 * A description for the connection to create.
295 *
296 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description
297 */
298 readonly description?: string;
299 /**
300 * The name for the connection to create.
301 *
302 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name
303 */
304 readonly name?: string;
305}
306/**
307 * A CloudFormation `AWS::Events::Connection`
308 *
309 * Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
310 *
311 * @cloudformationResource AWS::Events::Connection
312 * @stability external
313 *
314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html
315 */
316export declare class CfnConnection extends cdk.CfnResource implements cdk.IInspectable {
317 /**
318 * The CloudFormation resource type name for this resource class.
319 */
320 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::Connection";
321 /**
322 * A factory method that creates a new instance of this class from an object
323 * containing the CloudFormation properties of this resource.
324 * Used in the @aws-cdk/cloudformation-include module.
325 *
326 * @internal
327 */
328 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConnection;
329 /**
330 * The ARN of the connection that was created by the request.
331 * @cloudformationAttribute Arn
332 */
333 readonly attrArn: string;
334 /**
335 * The ARN for the secret created for the connection.
336 * @cloudformationAttribute SecretArn
337 */
338 readonly attrSecretArn: string;
339 /**
340 * The type of authorization to use for the connection.
341 *
342 * > OAUTH tokens are refreshed when a 401 or 407 response is returned.
343 *
344 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype
345 */
346 authorizationType: string;
347 /**
348 * A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint.
349 *
350 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters
351 */
352 authParameters: CfnConnection.AuthParametersProperty | cdk.IResolvable;
353 /**
354 * A description for the connection to create.
355 *
356 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description
357 */
358 description: string | undefined;
359 /**
360 * The name for the connection to create.
361 *
362 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name
363 */
364 name: string | undefined;
365 /**
366 * Create a new `AWS::Events::Connection`.
367 *
368 * @param scope - scope in which this resource is defined
369 * @param id - scoped id of the resource
370 * @param props - resource properties
371 */
372 constructor(scope: cdk.Construct, id: string, props: CfnConnectionProps);
373 /**
374 * Examines the CloudFormation resource and discloses attributes.
375 *
376 * @param inspector - tree inspector to collect and process attributes
377 *
378 */
379 inspect(inspector: cdk.TreeInspector): void;
380 protected get cfnProperties(): {
381 [key: string]: any;
382 };
383 protected renderProperties(props: {
384 [key: string]: any;
385 }): {
386 [key: string]: any;
387 };
388}
389export declare namespace CfnConnection {
390 /**
391 * Contains the API key authorization parameters for the connection.
392 *
393 * @struct
394 * @stability external
395 *
396 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html
397 */
398 interface ApiKeyAuthParametersProperty {
399 /**
400 * The name of the API key to use for authorization.
401 *
402 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname
403 */
404 readonly apiKeyName: string;
405 /**
406 * The value for the API key to use for authorization.
407 *
408 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue
409 */
410 readonly apiKeyValue: string;
411 }
412}
413export declare namespace CfnConnection {
414 /**
415 * Contains the authorization parameters to use for the connection.
416 *
417 * @struct
418 * @stability external
419 *
420 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html
421 */
422 interface AuthParametersProperty {
423 /**
424 * The API Key parameters to use for authorization.
425 *
426 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters
427 */
428 readonly apiKeyAuthParameters?: CfnConnection.ApiKeyAuthParametersProperty | cdk.IResolvable;
429 /**
430 * The authorization parameters for Basic authorization.
431 *
432 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters
433 */
434 readonly basicAuthParameters?: CfnConnection.BasicAuthParametersProperty | cdk.IResolvable;
435 /**
436 * Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
437 *
438 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters
439 */
440 readonly invocationHttpParameters?: CfnConnection.ConnectionHttpParametersProperty | cdk.IResolvable;
441 /**
442 * The OAuth parameters to use for authorization.
443 *
444 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters
445 */
446 readonly oAuthParameters?: CfnConnection.OAuthParametersProperty | cdk.IResolvable;
447 }
448}
449export declare namespace CfnConnection {
450 /**
451 * Contains the Basic authorization parameters for the connection.
452 *
453 * @struct
454 * @stability external
455 *
456 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html
457 */
458 interface BasicAuthParametersProperty {
459 /**
460 * The password associated with the user name to use for Basic authorization.
461 *
462 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password
463 */
464 readonly password: string;
465 /**
466 * The user name to use for Basic authorization.
467 *
468 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username
469 */
470 readonly username: string;
471 }
472}
473export declare namespace CfnConnection {
474 /**
475 * Contains the OAuth authorization parameters to use for the connection.
476 *
477 * @struct
478 * @stability external
479 *
480 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html
481 */
482 interface ClientParametersProperty {
483 /**
484 * The client ID to use for OAuth authorization.
485 *
486 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid
487 */
488 readonly clientId: string;
489 /**
490 * The client secret assciated with the client ID to use for OAuth authorization.
491 *
492 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret
493 */
494 readonly clientSecret: string;
495 }
496}
497export declare namespace CfnConnection {
498 /**
499 * Contains additional parameters for the connection.
500 *
501 * @struct
502 * @stability external
503 *
504 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html
505 */
506 interface ConnectionHttpParametersProperty {
507 /**
508 * Contains additional body string parameters for the connection.
509 *
510 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters
511 */
512 readonly bodyParameters?: Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
513 /**
514 * Contains additional header parameters for the connection.
515 *
516 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters
517 */
518 readonly headerParameters?: Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
519 /**
520 * Contains additional query string parameters for the connection.
521 *
522 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters
523 */
524 readonly queryStringParameters?: Array<CfnConnection.ParameterProperty | cdk.IResolvable> | cdk.IResolvable;
525 }
526}
527export declare namespace CfnConnection {
528 /**
529 * Contains the OAuth authorization parameters to use for the connection.
530 *
531 * @struct
532 * @stability external
533 *
534 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html
535 */
536 interface OAuthParametersProperty {
537 /**
538 * The URL to the authorization endpoint when OAuth is specified as the authorization type.
539 *
540 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint
541 */
542 readonly authorizationEndpoint: string;
543 /**
544 * A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization.
545 *
546 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters
547 */
548 readonly clientParameters: CfnConnection.ClientParametersProperty | cdk.IResolvable;
549 /**
550 * The method to use for the authorization request.
551 *
552 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod
553 */
554 readonly httpMethod: string;
555 /**
556 * A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection.
557 *
558 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters
559 */
560 readonly oAuthHttpParameters?: CfnConnection.ConnectionHttpParametersProperty | cdk.IResolvable;
561 }
562}
563export declare namespace CfnConnection {
564 /**
565 * Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
566 *
567 * @struct
568 * @stability external
569 *
570 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html
571 */
572 interface ParameterProperty {
573 /**
574 * Specifies whether the value is secret.
575 *
576 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret
577 */
578 readonly isValueSecret?: boolean | cdk.IResolvable;
579 /**
580 * The key for a query string parameter.
581 *
582 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key
583 */
584 readonly key: string;
585 /**
586 * The value associated with the key for the query string parameter.
587 *
588 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value
589 */
590 readonly value: string;
591 }
592}
593/**
594 * Properties for defining a `CfnEndpoint`
595 *
596 * @struct
597 * @stability external
598 *
599 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html
600 */
601export interface CfnEndpointProps {
602 /**
603 * The event buses being used by the endpoint.
604 *
605 * *Exactly* : `2`
606 *
607 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses
608 */
609 readonly eventBuses: Array<CfnEndpoint.EndpointEventBusProperty | cdk.IResolvable> | cdk.IResolvable;
610 /**
611 * The routing configuration of the endpoint.
612 *
613 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig
614 */
615 readonly routingConfig: CfnEndpoint.RoutingConfigProperty | cdk.IResolvable;
616 /**
617 * A description for the endpoint.
618 *
619 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description
620 */
621 readonly description?: string;
622 /**
623 * The name of the endpoint.
624 *
625 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name
626 */
627 readonly name?: string;
628 /**
629 * Whether event replication was enabled or disabled for this endpoint. The default state is `ENABLED` which means you must supply a `RoleArn` . If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED` .
630 *
631 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig
632 */
633 readonly replicationConfig?: CfnEndpoint.ReplicationConfigProperty | cdk.IResolvable;
634 /**
635 * The ARN of the role used by event replication for the endpoint.
636 *
637 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn
638 */
639 readonly roleArn?: string;
640}
641/**
642 * A CloudFormation `AWS::Events::Endpoint`
643 *
644 * A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the *Amazon EventBridge User Guide* .
645 *
646 * @cloudformationResource AWS::Events::Endpoint
647 * @stability external
648 *
649 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html
650 */
651export declare class CfnEndpoint extends cdk.CfnResource implements cdk.IInspectable {
652 /**
653 * The CloudFormation resource type name for this resource class.
654 */
655 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::Endpoint";
656 /**
657 * A factory method that creates a new instance of this class from an object
658 * containing the CloudFormation properties of this resource.
659 * Used in the @aws-cdk/cloudformation-include module.
660 *
661 * @internal
662 */
663 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEndpoint;
664 /**
665 * The ARN of the endpoint.
666 * @cloudformationAttribute Arn
667 */
668 readonly attrArn: string;
669 /**
670 * The ID of the endpoint.
671 * @cloudformationAttribute EndpointId
672 */
673 readonly attrEndpointId: string;
674 /**
675 * The URL of the endpoint.
676 * @cloudformationAttribute EndpointUrl
677 */
678 readonly attrEndpointUrl: string;
679 /**
680 * The current state of the endpoint.
681 * @cloudformationAttribute State
682 */
683 readonly attrState: string;
684 /**
685 * The reason the endpoint is in its current state.
686 * @cloudformationAttribute StateReason
687 */
688 readonly attrStateReason: string;
689 /**
690 * The event buses being used by the endpoint.
691 *
692 * *Exactly* : `2`
693 *
694 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses
695 */
696 eventBuses: Array<CfnEndpoint.EndpointEventBusProperty | cdk.IResolvable> | cdk.IResolvable;
697 /**
698 * The routing configuration of the endpoint.
699 *
700 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig
701 */
702 routingConfig: CfnEndpoint.RoutingConfigProperty | cdk.IResolvable;
703 /**
704 * A description for the endpoint.
705 *
706 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description
707 */
708 description: string | undefined;
709 /**
710 * The name of the endpoint.
711 *
712 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name
713 */
714 name: string | undefined;
715 /**
716 * Whether event replication was enabled or disabled for this endpoint. The default state is `ENABLED` which means you must supply a `RoleArn` . If you don't have a `RoleArn` or you don't want event replication enabled, set the state to `DISABLED` .
717 *
718 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig
719 */
720 replicationConfig: CfnEndpoint.ReplicationConfigProperty | cdk.IResolvable | undefined;
721 /**
722 * The ARN of the role used by event replication for the endpoint.
723 *
724 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn
725 */
726 roleArn: string | undefined;
727 /**
728 * Create a new `AWS::Events::Endpoint`.
729 *
730 * @param scope - scope in which this resource is defined
731 * @param id - scoped id of the resource
732 * @param props - resource properties
733 */
734 constructor(scope: cdk.Construct, id: string, props: CfnEndpointProps);
735 /**
736 * Examines the CloudFormation resource and discloses attributes.
737 *
738 * @param inspector - tree inspector to collect and process attributes
739 *
740 */
741 inspect(inspector: cdk.TreeInspector): void;
742 protected get cfnProperties(): {
743 [key: string]: any;
744 };
745 protected renderProperties(props: {
746 [key: string]: any;
747 }): {
748 [key: string]: any;
749 };
750}
751export declare namespace CfnEndpoint {
752 /**
753 * The event buses the endpoint is associated with.
754 *
755 * @struct
756 * @stability external
757 *
758 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html
759 */
760 interface EndpointEventBusProperty {
761 /**
762 * The ARN of the event bus the endpoint is associated with.
763 *
764 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html#cfn-events-endpoint-endpointeventbus-eventbusarn
765 */
766 readonly eventBusArn: string;
767 }
768}
769export declare namespace CfnEndpoint {
770 /**
771 * The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
772 *
773 * @struct
774 * @stability external
775 *
776 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html
777 */
778 interface FailoverConfigProperty {
779 /**
780 * The main Region of the endpoint.
781 *
782 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-primary
783 */
784 readonly primary: CfnEndpoint.PrimaryProperty | cdk.IResolvable;
785 /**
786 * The Region that events are routed to when failover is triggered or event replication is enabled.
787 *
788 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-secondary
789 */
790 readonly secondary: CfnEndpoint.SecondaryProperty | cdk.IResolvable;
791 }
792}
793export declare namespace CfnEndpoint {
794 /**
795 * The primary Region of the endpoint.
796 *
797 * @struct
798 * @stability external
799 *
800 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html
801 */
802 interface PrimaryProperty {
803 /**
804 * The ARN of the health check used by the endpoint to determine whether failover is triggered.
805 *
806 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html#cfn-events-endpoint-primary-healthcheck
807 */
808 readonly healthCheck: string;
809 }
810}
811export declare namespace CfnEndpoint {
812 /**
813 * Endpoints can replicate all events to the secondary Region.
814 *
815 * @struct
816 * @stability external
817 *
818 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html
819 */
820 interface ReplicationConfigProperty {
821 /**
822 * The state of event replication.
823 *
824 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html#cfn-events-endpoint-replicationconfig-state
825 */
826 readonly state: string;
827 }
828}
829export declare namespace CfnEndpoint {
830 /**
831 * The routing configuration of the endpoint.
832 *
833 * @struct
834 * @stability external
835 *
836 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html
837 */
838 interface RoutingConfigProperty {
839 /**
840 * The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
841 *
842 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html#cfn-events-endpoint-routingconfig-failoverconfig
843 */
844 readonly failoverConfig: CfnEndpoint.FailoverConfigProperty | cdk.IResolvable;
845 }
846}
847export declare namespace CfnEndpoint {
848 /**
849 * The secondary Region that processes events when failover is triggered or replication is enabled.
850 *
851 * @struct
852 * @stability external
853 *
854 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html
855 */
856 interface SecondaryProperty {
857 /**
858 * Defines the secondary Region.
859 *
860 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html#cfn-events-endpoint-secondary-route
861 */
862 readonly route: string;
863 }
864}
865/**
866 * Properties for defining a `CfnEventBus`
867 *
868 * @struct
869 * @stability external
870 *
871 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
872 */
873export interface CfnEventBusProps {
874 /**
875 * The name of the new event bus.
876 *
877 * Custom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.
878 *
879 * You can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus.
880 *
881 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name
882 */
883 readonly name: string;
884 /**
885 * If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
886 *
887 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename
888 */
889 readonly eventSourceName?: string;
890 /**
891 * Tags to associate with the event bus.
892 *
893 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags
894 */
895 readonly tags?: CfnEventBus.TagEntryProperty[];
896}
897/**
898 * A CloudFormation `AWS::Events::EventBus`
899 *
900 * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.
901 *
902 * @cloudformationResource AWS::Events::EventBus
903 * @stability external
904 *
905 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html
906 */
907export declare class CfnEventBus extends cdk.CfnResource implements cdk.IInspectable {
908 /**
909 * The CloudFormation resource type name for this resource class.
910 */
911 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::EventBus";
912 /**
913 * A factory method that creates a new instance of this class from an object
914 * containing the CloudFormation properties of this resource.
915 * Used in the @aws-cdk/cloudformation-include module.
916 *
917 * @internal
918 */
919 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEventBus;
920 /**
921 * The ARN of the event bus, such as `arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1` .
922 * @cloudformationAttribute Arn
923 */
924 readonly attrArn: string;
925 /**
926 * The name of the event bus, such as `PartnerName/acct1/repo1` .
927 * @cloudformationAttribute Name
928 */
929 readonly attrName: string;
930 /**
931 * The policy for the event bus in JSON form.
932 * @cloudformationAttribute Policy
933 */
934 readonly attrPolicy: string;
935 /**
936 * The name of the new event bus.
937 *
938 * Custom event bus names can't contain the `/` character, but you can use the `/` character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.
939 *
940 * You can't use the name `default` for a custom event bus, as this name is already used for your account's default event bus.
941 *
942 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name
943 */
944 name: string;
945 /**
946 * If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
947 *
948 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename
949 */
950 eventSourceName: string | undefined;
951 /**
952 * Tags to associate with the event bus.
953 *
954 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags
955 */
956 tags: CfnEventBus.TagEntryProperty[] | undefined;
957 /**
958 * Create a new `AWS::Events::EventBus`.
959 *
960 * @param scope - scope in which this resource is defined
961 * @param id - scoped id of the resource
962 * @param props - resource properties
963 */
964 constructor(scope: cdk.Construct, id: string, props: CfnEventBusProps);
965 /**
966 * Examines the CloudFormation resource and discloses attributes.
967 *
968 * @param inspector - tree inspector to collect and process attributes
969 *
970 */
971 inspect(inspector: cdk.TreeInspector): void;
972 protected get cfnProperties(): {
973 [key: string]: any;
974 };
975 protected renderProperties(props: {
976 [key: string]: any;
977 }): {
978 [key: string]: any;
979 };
980}
981export declare namespace CfnEventBus {
982 /**
983 * A key-value pair associated with an AWS resource. In EventBridge, rules and event buses support tagging.
984 *
985 * @struct
986 * @stability external
987 *
988 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html
989 */
990 interface TagEntryProperty {
991 /**
992 * A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
993 *
994 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-key
995 */
996 readonly key: string;
997 /**
998 * The value for the specified tag key.
999 *
1000 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-value
1001 */
1002 readonly value: string;
1003 }
1004}
1005/**
1006 * Properties for defining a `CfnEventBusPolicy`
1007 *
1008 * @struct
1009 * @stability external
1010 *
1011 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html
1012 */
1013export interface CfnEventBusPolicyProps {
1014 /**
1015 * An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this `StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .
1016 *
1017 * > Each `StatementId` must be unique.
1018 *
1019 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid
1020 */
1021 readonly statementId: string;
1022 /**
1023 * The action that you are enabling the other account to perform.
1024 *
1025 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action
1026 */
1027 readonly action?: string;
1028 /**
1029 * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide* .
1030 *
1031 * If you specify `Condition` with an AWS organization ID, and specify "*" as the value for `Principal` , you grant permission to all the accounts in the named organization.
1032 *
1033 * The `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.
1034 *
1035 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition
1036 */
1037 readonly condition?: CfnEventBusPolicy.ConditionProperty | cdk.IResolvable;
1038 /**
1039 * The name of the event bus associated with the rule. If you omit this, the default event bus is used.
1040 *
1041 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname
1042 */
1043 readonly eventBusName?: string;
1044 /**
1045 * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
1046 *
1047 * If you specify "*" without specifying `Condition` , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an `account` field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
1048 *
1049 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal
1050 */
1051 readonly principal?: string;
1052 /**
1053 * A JSON string that describes the permission policy statement. You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.
1054 *
1055 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement
1056 */
1057 readonly statement?: any | cdk.IResolvable;
1058}
1059/**
1060 * A CloudFormation `AWS::Events::EventBusPolicy`
1061 *
1062 * Running `PutPermission` permits the specified AWS account or AWS organization to put events to the specified *event bus* . Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.
1063 *
1064 * For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
1065 *
1066 * To enable multiple AWS accounts to put events to your event bus, run `PutPermission` once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run `PutPermission` once specifying `Principal` as "*" and specifying the AWS organization ID in `Condition` , to grant permissions to all accounts in that organization.
1067 *
1068 * If you grant permissions using an organization, then accounts in that organization must specify a `RoleArn` with proper permissions when they use `PutTarget` to add your account's event bus as a target. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
1069 *
1070 * The permission policy on the event bus cannot exceed 10 KB in size.
1071 *
1072 * @cloudformationResource AWS::Events::EventBusPolicy
1073 * @stability external
1074 *
1075 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html
1076 */
1077export declare class CfnEventBusPolicy extends cdk.CfnResource implements cdk.IInspectable {
1078 /**
1079 * The CloudFormation resource type name for this resource class.
1080 */
1081 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::EventBusPolicy";
1082 /**
1083 * A factory method that creates a new instance of this class from an object
1084 * containing the CloudFormation properties of this resource.
1085 * Used in the @aws-cdk/cloudformation-include module.
1086 *
1087 * @internal
1088 */
1089 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEventBusPolicy;
1090 /**
1091 * An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this `StatementId` when you run [RemovePermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html) .
1092 *
1093 * > Each `StatementId` must be unique.
1094 *
1095 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid
1096 */
1097 statementId: string;
1098 /**
1099 * The action that you are enabling the other account to perform.
1100 *
1101 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action
1102 */
1103 action: string | undefined;
1104 /**
1105 * This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the *AWS Organizations User Guide* .
1106 *
1107 * If you specify `Condition` with an AWS organization ID, and specify "*" as the value for `Principal` , you grant permission to all the accounts in the named organization.
1108 *
1109 * The `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.
1110 *
1111 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition
1112 */
1113 condition: CfnEventBusPolicy.ConditionProperty | cdk.IResolvable | undefined;
1114 /**
1115 * The name of the event bus associated with the rule. If you omit this, the default event bus is used.
1116 *
1117 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname
1118 */
1119 eventBusName: string | undefined;
1120 /**
1121 * The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
1122 *
1123 * If you specify "*" without specifying `Condition` , avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an `account` field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
1124 *
1125 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal
1126 */
1127 principal: string | undefined;
1128 /**
1129 * A JSON string that describes the permission policy statement. You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.
1130 *
1131 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement
1132 */
1133 statement: any | cdk.IResolvable | undefined;
1134 /**
1135 * Create a new `AWS::Events::EventBusPolicy`.
1136 *
1137 * @param scope - scope in which this resource is defined
1138 * @param id - scoped id of the resource
1139 * @param props - resource properties
1140 */
1141 constructor(scope: cdk.Construct, id: string, props: CfnEventBusPolicyProps);
1142 /**
1143 * Examines the CloudFormation resource and discloses attributes.
1144 *
1145 * @param inspector - tree inspector to collect and process attributes
1146 *
1147 */
1148 inspect(inspector: cdk.TreeInspector): void;
1149 protected get cfnProperties(): {
1150 [key: string]: any;
1151 };
1152 protected renderProperties(props: {
1153 [key: string]: any;
1154 }): {
1155 [key: string]: any;
1156 };
1157}
1158export declare namespace CfnEventBusPolicy {
1159 /**
1160 * A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain `Type` , `Key` , and `Value` fields. The `Value` field specifies the ID of the AWS organization. Following is an example value for `Condition` :
1161 *
1162 * `'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'`
1163 *
1164 * @struct
1165 * @stability external
1166 *
1167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html
1168 */
1169 interface ConditionProperty {
1170 /**
1171 * Specifies the key for the condition. Currently the only supported key is `aws:PrincipalOrgID` .
1172 *
1173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key
1174 */
1175 readonly key?: string;
1176 /**
1177 * Specifies the type of condition. Currently the only supported value is `StringEquals` .
1178 *
1179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type
1180 */
1181 readonly type?: string;
1182 /**
1183 * Specifies the value for the key. Currently, this must be the ID of the organization.
1184 *
1185 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value
1186 */
1187 readonly value?: string;
1188 }
1189}
1190/**
1191 * Properties for defining a `CfnRule`
1192 *
1193 * @struct
1194 * @stability external
1195 *
1196 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
1197 */
1198export interface CfnRuleProps {
1199 /**
1200 * The description of the rule.
1201 *
1202 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description
1203 */
1204 readonly description?: string;
1205 /**
1206 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
1207 *
1208 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname
1209 */
1210 readonly eventBusName?: string;
1211 /**
1212 * The event pattern of the rule. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .
1213 *
1214 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern
1215 */
1216 readonly eventPattern?: any | cdk.IResolvable;
1217 /**
1218 * The name of the rule.
1219 *
1220 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name
1221 */
1222 readonly name?: string;
1223 /**
1224 * The Amazon Resource Name (ARN) of the role that is used for target invocation.
1225 *
1226 * If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter.
1227 *
1228 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn
1229 */
1230 readonly roleArn?: string;
1231 /**
1232 * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .
1233 *
1234 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression
1235 */
1236 readonly scheduleExpression?: string;
1237 /**
1238 * The state of the rule.
1239 *
1240 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state
1241 */
1242 readonly state?: string;
1243 /**
1244 * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
1245 *
1246 * Targets are the resources that are invoked when a rule is triggered.
1247 *
1248 * The maximum number of entries per request is 10.
1249 *
1250 * > Each rule can have up to five (5) targets associated with it at one time.
1251 *
1252 * For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .
1253 *
1254 * Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:
1255 *
1256 * - `Amazon EBS CreateSnapshot API call`
1257 * - `Amazon EC2 RebootInstances API call`
1258 * - `Amazon EC2 StopInstances API call`
1259 * - `Amazon EC2 TerminateInstances API call`
1260 *
1261 * For some target types, `PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.
1262 *
1263 * To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
1264 *
1265 * - For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
1266 * - For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` .
1267 *
1268 * For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .
1269 *
1270 * If another AWS account is in the same region and has granted you permission (using `PutPermission` ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets` . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .
1271 *
1272 * > `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.
1273 *
1274 * If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
1275 *
1276 * > If you have an IAM role on a cross-account event bus target, a `PutTargets` call without a role on the same target (same `Id` and `Arn` ) will not remove the role.
1277 *
1278 * For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .
1279 *
1280 * *Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
1281 *
1282 * - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
1283 * - If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.
1284 * - If *InputPath* is specified in the form of JSONPath (for example, `$.detail` ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
1285 * - If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
1286 *
1287 * When you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.
1288 *
1289 * When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
1290 *
1291 * This action can partially fail if too many requests are made at the same time. If that happens, `FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.
1292 *
1293 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets
1294 */
1295 readonly targets?: Array<CfnRule.TargetProperty | cdk.IResolvable> | cdk.IResolvable;
1296}
1297/**
1298 * A CloudFormation `AWS::Events::Rule`
1299 *
1300 * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html) .
1301 *
1302 * A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html) .
1303 *
1304 * If you are updating an existing rule, the rule is replaced with what you specify in this `PutRule` command. If you omit arguments in `PutRule` , the old values for those arguments are not kept. Instead, they are replaced with null values.
1305 *
1306 * When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
1307 *
1308 * A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
1309 *
1310 * Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
1311 *
1312 * In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
1313 *
1314 * To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
1315 *
1316 * An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html) .
1317 *
1318 * @cloudformationResource AWS::Events::Rule
1319 * @stability external
1320 *
1321 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html
1322 */
1323export declare class CfnRule extends cdk.CfnResource implements cdk.IInspectable {
1324 /**
1325 * The CloudFormation resource type name for this resource class.
1326 */
1327 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::Events::Rule";
1328 /**
1329 * A factory method that creates a new instance of this class from an object
1330 * containing the CloudFormation properties of this resource.
1331 * Used in the @aws-cdk/cloudformation-include module.
1332 *
1333 * @internal
1334 */
1335 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRule;
1336 /**
1337 * The ARN of the rule, such as `arn:aws:events:us-east-2:123456789012:rule/example` .
1338 * @cloudformationAttribute Arn
1339 */
1340 readonly attrArn: string;
1341 /**
1342 * The description of the rule.
1343 *
1344 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description
1345 */
1346 description: string | undefined;
1347 /**
1348 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
1349 *
1350 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname
1351 */
1352 eventBusName: string | undefined;
1353 /**
1354 * The event pattern of the rule. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .
1355 *
1356 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern
1357 */
1358 eventPattern: any | cdk.IResolvable | undefined;
1359 /**
1360 * The name of the rule.
1361 *
1362 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name
1363 */
1364 name: string | undefined;
1365 /**
1366 * The Amazon Resource Name (ARN) of the role that is used for target invocation.
1367 *
1368 * If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter.
1369 *
1370 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn
1371 */
1372 roleArn: string | undefined;
1373 /**
1374 * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html) .
1375 *
1376 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression
1377 */
1378 scheduleExpression: string | undefined;
1379 /**
1380 * The state of the rule.
1381 *
1382 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state
1383 */
1384 state: string | undefined;
1385 /**
1386 * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
1387 *
1388 * Targets are the resources that are invoked when a rule is triggered.
1389 *
1390 * The maximum number of entries per request is 10.
1391 *
1392 * > Each rule can have up to five (5) targets associated with it at one time.
1393 *
1394 * For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide* .
1395 *
1396 * Creating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are:
1397 *
1398 * - `Amazon EBS CreateSnapshot API call`
1399 * - `Amazon EC2 RebootInstances API call`
1400 * - `Amazon EC2 StopInstances API call`
1401 * - `Amazon EC2 TerminateInstances API call`
1402 *
1403 * For some target types, `PutTargets` provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field.
1404 *
1405 * To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
1406 *
1407 * - For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
1408 * - For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` .
1409 *
1410 * For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide* .
1411 *
1412 * If another AWS account is in the same region and has granted you permission (using `PutPermission` ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets` . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see [Amazon EventBridge Pricing](https://docs.aws.amazon.com/eventbridge/pricing/) .
1413 *
1414 * > `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.
1415 *
1416 * If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
1417 *
1418 * > If you have an IAM role on a cross-account event bus target, a `PutTargets` call without a role on the same target (same `Id` and `Arn` ) will not remove the role.
1419 *
1420 * For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .
1421 *
1422 * *Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
1423 *
1424 * - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
1425 * - If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.
1426 * - If *InputPath* is specified in the form of JSONPath (for example, `$.detail` ), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
1427 * - If *InputTransformer* is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
1428 *
1429 * When you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.
1430 *
1431 * When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
1432 *
1433 * This action can partially fail if too many requests are made at the same time. If that happens, `FailedEntryCount` is non-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code.
1434 *
1435 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets
1436 */
1437 targets: Array<CfnRule.TargetProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
1438 /**
1439 * Create a new `AWS::Events::Rule`.
1440 *
1441 * @param scope - scope in which this resource is defined
1442 * @param id - scoped id of the resource
1443 * @param props - resource properties
1444 */
1445 constructor(scope: cdk.Construct, id: string, props?: CfnRuleProps);
1446 /**
1447 * Examines the CloudFormation resource and discloses attributes.
1448 *
1449 * @param inspector - tree inspector to collect and process attributes
1450 *
1451 */
1452 inspect(inspector: cdk.TreeInspector): void;
1453 protected get cfnProperties(): {
1454 [key: string]: any;
1455 };
1456 protected renderProperties(props: {
1457 [key: string]: any;
1458 }): {
1459 [key: string]: any;
1460 };
1461}
1462export declare namespace CfnRule {
1463 /**
1464 * This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode.
1465 *
1466 * @struct
1467 * @stability external
1468 *
1469 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html
1470 */
1471 interface AwsVpcConfigurationProperty {
1472 /**
1473 * Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .
1474 *
1475 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip
1476 */
1477 readonly assignPublicIp?: string;
1478 /**
1479 * Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
1480 *
1481 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups
1482 */
1483 readonly securityGroups?: string[];
1484 /**
1485 * Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
1486 *
1487 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets
1488 */
1489 readonly subnets: string[];
1490 }
1491}
1492export declare namespace CfnRule {
1493 /**
1494 * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
1495 *
1496 * @struct
1497 * @stability external
1498 *
1499 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html
1500 */
1501 interface BatchArrayPropertiesProperty {
1502 /**
1503 * The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
1504 *
1505 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size
1506 */
1507 readonly size?: number;
1508 }
1509}
1510export declare namespace CfnRule {
1511 /**
1512 * The custom parameters to be used when the target is an AWS Batch job.
1513 *
1514 * @struct
1515 * @stability external
1516 *
1517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html
1518 */
1519 interface BatchParametersProperty {
1520 /**
1521 * The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
1522 *
1523 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties
1524 */
1525 readonly arrayProperties?: CfnRule.BatchArrayPropertiesProperty | cdk.IResolvable;
1526 /**
1527 * The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
1528 *
1529 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition
1530 */
1531 readonly jobDefinition: string;
1532 /**
1533 * The name to use for this execution of the job, if the target is an AWS Batch job.
1534 *
1535 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname
1536 */
1537 readonly jobName: string;
1538 /**
1539 * The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
1540 *
1541 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy
1542 */
1543 readonly retryStrategy?: CfnRule.BatchRetryStrategyProperty | cdk.IResolvable;
1544 }
1545}
1546export declare namespace CfnRule {
1547 /**
1548 * The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
1549 *
1550 * @struct
1551 * @stability external
1552 *
1553 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html
1554 */
1555 interface BatchRetryStrategyProperty {
1556 /**
1557 * The number of times to attempt to retry, if the job fails. Valid values are 1–10.
1558 *
1559 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts
1560 */
1561 readonly attempts?: number;
1562 }
1563}
1564export declare namespace CfnRule {
1565 /**
1566 * The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.
1567 *
1568 * @struct
1569 * @stability external
1570 *
1571 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html
1572 */
1573 interface CapacityProviderStrategyItemProperty {
1574 /**
1575 * The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
1576 *
1577 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-base
1578 */
1579 readonly base?: number;
1580 /**
1581 * The short name of the capacity provider.
1582 *
1583 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-capacityprovider
1584 */
1585 readonly capacityProvider: string;
1586 /**
1587 * The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
1588 *
1589 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-weight
1590 */
1591 readonly weight?: number;
1592 }
1593}
1594export declare namespace CfnRule {
1595 /**
1596 * A `DeadLetterConfig` object that contains information about a dead-letter queue configuration.
1597 *
1598 * @struct
1599 * @stability external
1600 *
1601 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html
1602 */
1603 interface DeadLetterConfigProperty {
1604 /**
1605 * The ARN of the SQS queue specified as the target for the dead-letter queue.
1606 *
1607 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn
1608 */
1609 readonly arn?: string;
1610 }
1611}
1612export declare namespace CfnRule {
1613 /**
1614 * The custom parameters to be used when the target is an Amazon ECS task.
1615 *
1616 * @struct
1617 * @stability external
1618 *
1619 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html
1620 */
1621 interface EcsParametersProperty {
1622 /**
1623 * The capacity provider strategy to use for the task.
1624 *
1625 * If a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used.
1626 *
1627 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy
1628 */
1629 readonly capacityProviderStrategy?: Array<CfnRule.CapacityProviderStrategyItemProperty | cdk.IResolvable> | cdk.IResolvable;
1630 /**
1631 * Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.
1632 *
1633 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags
1634 */
1635 readonly enableEcsManagedTags?: boolean | cdk.IResolvable;
1636 /**
1637 * Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
1638 *
1639 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand
1640 */
1641 readonly enableExecuteCommand?: boolean | cdk.IResolvable;
1642 /**
1643 * Specifies an ECS task group for the task. The maximum length is 255 characters.
1644 *
1645 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group
1646 */
1647 readonly group?: string;
1648 /**
1649 * Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* .
1650 *
1651 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype
1652 */
1653 readonly launchType?: string;
1654 /**
1655 * Use this structure if the Amazon ECS task uses the `awsvpc` network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks.
1656 *
1657 * If you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails.
1658 *
1659 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration
1660 */
1661 readonly networkConfiguration?: CfnRule.NetworkConfigurationProperty | cdk.IResolvable;
1662 /**
1663 * An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
1664 *
1665 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints
1666 */
1667 readonly placementConstraints?: Array<CfnRule.PlacementConstraintProperty | cdk.IResolvable> | cdk.IResolvable;
1668 /**
1669 * The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
1670 *
1671 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies
1672 */
1673 readonly placementStrategies?: Array<CfnRule.PlacementStrategyProperty | cdk.IResolvable> | cdk.IResolvable;
1674 /**
1675 * Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0` .
1676 *
1677 * This structure is used only if `LaunchType` is `FARGATE` . For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* .
1678 *
1679 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion
1680 */
1681 readonly platformVersion?: string;
1682 /**
1683 * Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
1684 *
1685 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags
1686 */
1687 readonly propagateTags?: string;
1688 /**
1689 * The reference ID to use for the task.
1690 *
1691 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid
1692 */
1693 readonly referenceId?: string;
1694 /**
1695 * The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.
1696 *
1697 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist
1698 */
1699 readonly tagList?: Array<cdk.CfnTag | cdk.IResolvable> | cdk.IResolvable;
1700 /**
1701 * The number of tasks to create based on `TaskDefinition` . The default is 1.
1702 *
1703 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount
1704 */
1705 readonly taskCount?: number;
1706 /**
1707 * The ARN of the task definition to use if the event target is an Amazon ECS task.
1708 *
1709 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn
1710 */
1711 readonly taskDefinitionArn: string;
1712 }
1713}
1714export declare namespace CfnRule {
1715 /**
1716 * These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
1717 *
1718 * @struct
1719 * @stability external
1720 *
1721 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html
1722 */
1723 interface HttpParametersProperty {
1724 /**
1725 * The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
1726 *
1727 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters
1728 */
1729 readonly headerParameters?: {
1730 [key: string]: (string);
1731 } | cdk.IResolvable;
1732 /**
1733 * The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
1734 *
1735 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues
1736 */
1737 readonly pathParameterValues?: string[];
1738 /**
1739 * The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
1740 *
1741 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters
1742 */
1743 readonly queryStringParameters?: {
1744 [key: string]: (string);
1745 } | cdk.IResolvable;
1746 }
1747}
1748export declare namespace CfnRule {
1749 /**
1750 * Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.
1751 *
1752 * @struct
1753 * @stability external
1754 *
1755 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html
1756 */
1757 interface InputTransformerProperty {
1758 /**
1759 * Map of JSON paths to be extracted from the event. You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target.
1760 *
1761 * `InputPathsMap` is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
1762 *
1763 * The keys cannot start with " AWS ."
1764 *
1765 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap
1766 */
1767 readonly inputPathsMap?: {
1768 [key: string]: (string);
1769 } | cdk.IResolvable;
1770 /**
1771 * Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target. Enclose each `InputPathsMaps` value in brackets: < *value* >
1772 *
1773 * If `InputTemplate` is a JSON object (surrounded by curly braces), the following restrictions apply:
1774 *
1775 * - The placeholder cannot be used as an object key.
1776 *
1777 * The following example shows the syntax for using `InputPathsMap` and `InputTemplate` .
1778 *
1779 * `"InputTransformer":`
1780 *
1781 * `{`
1782 *
1783 * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
1784 *
1785 * `"InputTemplate": "<instance> is in state <status>"`
1786 *
1787 * `}`
1788 *
1789 * To have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
1790 *
1791 * `"InputTransformer":`
1792 *
1793 * `{`
1794 *
1795 * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
1796 *
1797 * `"InputTemplate": "<instance> is in state \"<status>\""`
1798 *
1799 * `}`
1800 *
1801 * The `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example:
1802 *
1803 * `"InputTransformer":`
1804 *
1805 * `{`
1806 *
1807 * `"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},`
1808 *
1809 * `"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'`
1810 *
1811 * `}`
1812 *
1813 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate
1814 */
1815 readonly inputTemplate: string;
1816 }
1817}
1818export declare namespace CfnRule {
1819 /**
1820 * This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the `eventId` as the partition key.
1821 *
1822 * @struct
1823 * @stability external
1824 *
1825 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html
1826 */
1827 interface KinesisParametersProperty {
1828 /**
1829 * The JSON path to be extracted from the event and used as the partition key. For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide* .
1830 *
1831 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath
1832 */
1833 readonly partitionKeyPath: string;
1834 }
1835}
1836export declare namespace CfnRule {
1837 /**
1838 * This structure specifies the network configuration for an ECS task.
1839 *
1840 * @struct
1841 * @stability external
1842 *
1843 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html
1844 */
1845 interface NetworkConfigurationProperty {
1846 /**
1847 * Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode.
1848 *
1849 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration
1850 */
1851 readonly awsVpcConfiguration?: CfnRule.AwsVpcConfigurationProperty | cdk.IResolvable;
1852 }
1853}
1854export declare namespace CfnRule {
1855 /**
1856 * An object representing a constraint on task placement. To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.
1857 *
1858 * @struct
1859 * @stability external
1860 *
1861 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html
1862 */
1863 interface PlacementConstraintProperty {
1864 /**
1865 * A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance` . To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.
1866 *
1867 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-expression
1868 */
1869 readonly expression?: string;
1870 /**
1871 * The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
1872 *
1873 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-type
1874 */
1875 readonly type?: string;
1876 }
1877}
1878export declare namespace CfnRule {
1879 /**
1880 * The task placement strategy for a task or service. To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.
1881 *
1882 * @struct
1883 * @stability external
1884 *
1885 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html
1886 */
1887 interface PlacementStrategyProperty {
1888 /**
1889 * The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
1890 *
1891 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-field
1892 */
1893 readonly field?: string;
1894 /**
1895 * The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
1896 *
1897 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-type
1898 */
1899 readonly type?: string;
1900 }
1901}
1902export declare namespace CfnRule {
1903 /**
1904 * These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
1905 *
1906 * @struct
1907 * @stability external
1908 *
1909 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html
1910 */
1911 interface RedshiftDataParametersProperty {
1912 /**
1913 * The name of the database. Required when authenticating using temporary credentials.
1914 *
1915 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database
1916 */
1917 readonly database: string;
1918 /**
1919 * The database user name. Required when authenticating using temporary credentials.
1920 *
1921 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser
1922 */
1923 readonly dbUser?: string;
1924 /**
1925 * The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
1926 *
1927 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn
1928 */
1929 readonly secretManagerArn?: string;
1930 /**
1931 * The SQL statement text to run.
1932 *
1933 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql
1934 */
1935 readonly sql: string;
1936 /**
1937 * The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
1938 *
1939 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname
1940 */
1941 readonly statementName?: string;
1942 /**
1943 * Indicates whether to send an event back to EventBridge after the SQL statement runs.
1944 *
1945 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent
1946 */
1947 readonly withEvent?: boolean | cdk.IResolvable;
1948 }
1949}
1950export declare namespace CfnRule {
1951 /**
1952 * A `RetryPolicy` object that includes information about the retry policy settings.
1953 *
1954 * @struct
1955 * @stability external
1956 *
1957 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html
1958 */
1959 interface RetryPolicyProperty {
1960 /**
1961 * The maximum amount of time, in seconds, to continue to make retry attempts.
1962 *
1963 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds
1964 */
1965 readonly maximumEventAgeInSeconds?: number;
1966 /**
1967 * The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is met.
1968 *
1969 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts
1970 */
1971 readonly maximumRetryAttempts?: number;
1972 }
1973}
1974export declare namespace CfnRule {
1975 /**
1976 * This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
1977 *
1978 * @struct
1979 * @stability external
1980 *
1981 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html
1982 */
1983 interface RunCommandParametersProperty {
1984 /**
1985 * Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
1986 *
1987 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets
1988 */
1989 readonly runCommandTargets: Array<CfnRule.RunCommandTargetProperty | cdk.IResolvable> | cdk.IResolvable;
1990 }
1991}
1992export declare namespace CfnRule {
1993 /**
1994 * Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each `RunCommandTarget` block can include only one key, but this key may specify multiple values.
1995 *
1996 * @struct
1997 * @stability external
1998 *
1999 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html
2000 */
2001 interface RunCommandTargetProperty {
2002 /**
2003 * Can be either `tag:` *tag-key* or `InstanceIds` .
2004 *
2005 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key
2006 */
2007 readonly key: string;
2008 /**
2009 * If `Key` is `tag:` *tag-key* , `Values` is a list of tag values. If `Key` is `InstanceIds` , `Values` is a list of Amazon EC2 instance IDs.
2010 *
2011 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values
2012 */
2013 readonly values: string[];
2014 }
2015}
2016export declare namespace CfnRule {
2017 /**
2018 * Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
2019 *
2020 * @struct
2021 * @stability external
2022 *
2023 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html
2024 */
2025 interface SageMakerPipelineParameterProperty {
2026 /**
2027 * Name of parameter to start execution of a SageMaker Model Building Pipeline.
2028 *
2029 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-name
2030 */
2031 readonly name: string;
2032 /**
2033 * Value of parameter to start execution of a SageMaker Model Building Pipeline.
2034 *
2035 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-value
2036 */
2037 readonly value: string;
2038 }
2039}
2040export declare namespace CfnRule {
2041 /**
2042 * These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.
2043 *
2044 * @struct
2045 * @stability external
2046 *
2047 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html
2048 */
2049 interface SageMakerPipelineParametersProperty {
2050 /**
2051 * List of Parameter names and values for SageMaker Model Building Pipeline execution.
2052 *
2053 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html#cfn-events-rule-sagemakerpipelineparameters-pipelineparameterlist
2054 */
2055 readonly pipelineParameterList?: Array<CfnRule.SageMakerPipelineParameterProperty | cdk.IResolvable> | cdk.IResolvable;
2056 }
2057}
2058export declare namespace CfnRule {
2059 /**
2060 * This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
2061 *
2062 * @struct
2063 * @stability external
2064 *
2065 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html
2066 */
2067 interface SqsParametersProperty {
2068 /**
2069 * The FIFO message group ID to use as the target.
2070 *
2071 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid
2072 */
2073 readonly messageGroupId: string;
2074 }
2075}
2076export declare namespace CfnRule {
2077 /**
2078 * A key-value pair associated with an ECS Target of an EventBridge rule. The tag will be propagated to ECS by EventBridge when starting an ECS task based on a matched event.
2079 *
2080 * > Currently, tags are only available when using ECS with EventBridge .
2081 *
2082 * @struct
2083 * @stability external
2084 *
2085 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html
2086 */
2087 interface TagProperty {
2088 /**
2089 * A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
2090 *
2091 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-key
2092 */
2093 readonly key?: string;
2094 /**
2095 * The value for the specified tag key.
2096 *
2097 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-value
2098 */
2099 readonly value?: string;
2100 }
2101}
2102export declare namespace CfnRule {
2103 /**
2104 * Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see [PutTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html) .
2105 *
2106 * If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide* .
2107 *
2108 * @struct
2109 * @stability external
2110 *
2111 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html
2112 */
2113 interface TargetProperty {
2114 /**
2115 * The Amazon Resource Name (ARN) of the target.
2116 *
2117 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn
2118 */
2119 readonly arn: string;
2120 /**
2121 * If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* .
2122 *
2123 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters
2124 */
2125 readonly batchParameters?: CfnRule.BatchParametersProperty | cdk.IResolvable;
2126 /**
2127 * The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
2128 *
2129 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig
2130 */
2131 readonly deadLetterConfig?: CfnRule.DeadLetterConfigProperty | cdk.IResolvable;
2132 /**
2133 * Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide* .
2134 *
2135 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters
2136 */
2137 readonly ecsParameters?: CfnRule.EcsParametersProperty | cdk.IResolvable;
2138 /**
2139 * Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
2140 *
2141 * If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
2142 *
2143 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters
2144 */
2145 readonly httpParameters?: CfnRule.HttpParametersProperty | cdk.IResolvable;
2146 /**
2147 * The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
2148 *
2149 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id
2150 */
2151 readonly id: string;
2152 /**
2153 * Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .
2154 *
2155 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input
2156 */
2157 readonly input?: string;
2158 /**
2159 * The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) .
2160 *
2161 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath
2162 */
2163 readonly inputPath?: string;
2164 /**
2165 * Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
2166 *
2167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer
2168 */
2169 readonly inputTransformer?: CfnRule.InputTransformerProperty | cdk.IResolvable;
2170 /**
2171 * The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the `eventId` as the partition key.
2172 *
2173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters
2174 */
2175 readonly kinesisParameters?: CfnRule.KinesisParametersProperty | cdk.IResolvable;
2176 /**
2177 * Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
2178 *
2179 * If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
2180 *
2181 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters
2182 */
2183 readonly redshiftDataParameters?: CfnRule.RedshiftDataParametersProperty | cdk.IResolvable;
2184 /**
2185 * The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
2186 *
2187 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy
2188 */
2189 readonly retryPolicy?: CfnRule.RetryPolicyProperty | cdk.IResolvable;
2190 /**
2191 * The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
2192 *
2193 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn
2194 */
2195 readonly roleArn?: string;
2196 /**
2197 * Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
2198 *
2199 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters
2200 */
2201 readonly runCommandParameters?: CfnRule.RunCommandParametersProperty | cdk.IResolvable;
2202 /**
2203 * Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
2204 *
2205 * If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
2206 *
2207 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sagemakerpipelineparameters
2208 */
2209 readonly sageMakerPipelineParameters?: CfnRule.SageMakerPipelineParametersProperty | cdk.IResolvable;
2210 /**
2211 * Contains the message group ID to use when the target is a FIFO queue.
2212 *
2213 * If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
2214 *
2215 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters
2216 */
2217 readonly sqsParameters?: CfnRule.SqsParametersProperty | cdk.IResolvable;
2218 }
2219}