UNPKG

436 kBPlain TextView Raw
1{
2 "author": {
3 "name": "Amazon Web Services",
4 "organization": true,
5 "roles": [
6 "author"
7 ],
8 "url": "https://aws.amazon.com"
9 },
10 "dependencies": {
11 "@aws-cdk/aws-iam": "1.155.0",
12 "@aws-cdk/core": "1.155.0",
13 "constructs": "^3.3.69"
14 },
15 "dependencyClosure": {
16 "@aws-cdk/aws-iam": {
17 "targets": {
18 "dotnet": {
19 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
20 "namespace": "Amazon.CDK.AWS.IAM",
21 "packageId": "Amazon.CDK.AWS.IAM"
22 },
23 "java": {
24 "maven": {
25 "artifactId": "iam",
26 "groupId": "software.amazon.awscdk"
27 },
28 "package": "software.amazon.awscdk.services.iam"
29 },
30 "js": {
31 "npm": "@aws-cdk/aws-iam"
32 },
33 "python": {
34 "classifiers": [
35 "Framework :: AWS CDK",
36 "Framework :: AWS CDK :: 1"
37 ],
38 "distName": "aws-cdk.aws-iam",
39 "module": "aws_cdk.aws_iam"
40 }
41 }
42 },
43 "@aws-cdk/cloud-assembly-schema": {
44 "targets": {
45 "dotnet": {
46 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
47 "namespace": "Amazon.CDK.CloudAssembly.Schema",
48 "packageId": "Amazon.CDK.CloudAssembly.Schema"
49 },
50 "java": {
51 "maven": {
52 "artifactId": "cdk-cloud-assembly-schema",
53 "groupId": "software.amazon.awscdk"
54 },
55 "package": "software.amazon.awscdk.cloudassembly.schema"
56 },
57 "js": {
58 "npm": "@aws-cdk/cloud-assembly-schema"
59 },
60 "python": {
61 "classifiers": [
62 "Framework :: AWS CDK",
63 "Framework :: AWS CDK :: 1"
64 ],
65 "distName": "aws-cdk.cloud-assembly-schema",
66 "module": "aws_cdk.cloud_assembly_schema"
67 }
68 }
69 },
70 "@aws-cdk/core": {
71 "targets": {
72 "dotnet": {
73 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
74 "namespace": "Amazon.CDK",
75 "packageId": "Amazon.CDK"
76 },
77 "java": {
78 "maven": {
79 "artifactId": "core",
80 "groupId": "software.amazon.awscdk"
81 },
82 "package": "software.amazon.awscdk.core"
83 },
84 "js": {
85 "npm": "@aws-cdk/core"
86 },
87 "python": {
88 "classifiers": [
89 "Framework :: AWS CDK",
90 "Framework :: AWS CDK :: 1"
91 ],
92 "distName": "aws-cdk.core",
93 "module": "aws_cdk.core"
94 }
95 }
96 },
97 "@aws-cdk/cx-api": {
98 "targets": {
99 "dotnet": {
100 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
101 "namespace": "Amazon.CDK.CXAPI",
102 "packageId": "Amazon.CDK.CXAPI"
103 },
104 "java": {
105 "maven": {
106 "artifactId": "cdk-cx-api",
107 "groupId": "software.amazon.awscdk"
108 },
109 "package": "software.amazon.awscdk.cxapi"
110 },
111 "js": {
112 "npm": "@aws-cdk/cx-api"
113 },
114 "python": {
115 "classifiers": [
116 "Framework :: AWS CDK",
117 "Framework :: AWS CDK :: 1"
118 ],
119 "distName": "aws-cdk.cx-api",
120 "module": "aws_cdk.cx_api"
121 }
122 }
123 },
124 "@aws-cdk/region-info": {
125 "targets": {
126 "dotnet": {
127 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
128 "namespace": "Amazon.CDK.RegionInfo",
129 "packageId": "Amazon.CDK.RegionInfo"
130 },
131 "java": {
132 "maven": {
133 "artifactId": "cdk-region-info",
134 "groupId": "software.amazon.awscdk"
135 },
136 "package": "software.amazon.awscdk.regioninfo"
137 },
138 "js": {
139 "npm": "@aws-cdk/region-info"
140 },
141 "python": {
142 "classifiers": [
143 "Framework :: AWS CDK",
144 "Framework :: AWS CDK :: 1"
145 ],
146 "distName": "aws-cdk.region-info",
147 "module": "aws_cdk.region_info"
148 }
149 }
150 },
151 "constructs": {
152 "targets": {
153 "dotnet": {
154 "namespace": "Constructs",
155 "packageId": "Constructs"
156 },
157 "go": {
158 "moduleName": "github.com/aws/constructs-go"
159 },
160 "java": {
161 "maven": {
162 "artifactId": "constructs",
163 "groupId": "software.constructs"
164 },
165 "package": "software.constructs"
166 },
167 "js": {
168 "npm": "constructs"
169 },
170 "python": {
171 "distName": "constructs",
172 "module": "constructs"
173 }
174 }
175 }
176 },
177 "description": "Amazon EventBridge Construct Library",
178 "docs": {
179 "stability": "stable"
180 },
181 "homepage": "https://github.com/aws/aws-cdk",
182 "jsiiVersion": "1.57.0 (build f614666)",
183 "keywords": [
184 "aws",
185 "cdk",
186 "constructs",
187 "cloudwatch",
188 "events",
189 "eventbridge"
190 ],
191 "license": "Apache-2.0",
192 "metadata": {
193 "jsii": {
194 "compiledWithDeprecationWarnings": true,
195 "pacmak": {
196 "hasDefaultInterfaces": true
197 },
198 "rosetta": {
199 "strict": true
200 }
201 }
202 },
203 "name": "@aws-cdk/aws-events",
204 "readme": {
205 "markdown": "# Amazon EventBridge Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n<!--END STABILITY BANNER-->\n\nAmazon EventBridge delivers a near real-time stream of system events that\ndescribe changes in AWS resources. For example, an AWS CodePipeline emits the\n[State\nChange](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html#codepipeline-event-type)\nevent when the pipeline changes its state.\n\n* __Events__: An event indicates a change in your AWS environment. AWS resources\n can generate events when their state changes. For example, Amazon EC2\n generates an event when the state of an EC2 instance changes from pending to\n running, and Amazon EC2 Auto Scaling generates events when it launches or\n terminates instances. AWS CloudTrail publishes events when you make API calls.\n You can generate custom application-level events and publish them to\n EventBridge. You can also set up scheduled events that are generated on\n a periodic basis. For a list of services that generate events, and sample\n events from each service, see [EventBridge Event Examples From Each\n Supported\n Service](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html).\n* __Targets__: A target processes events. Targets can include Amazon EC2\n instances, AWS Lambda functions, Kinesis streams, Amazon ECS tasks, Step\n Functions state machines, Amazon SNS topics, Amazon SQS queues, Amazon CloudWatch LogGroups, and built-in\n targets. A target receives events in JSON format.\n* __Rules__: A rule matches incoming events and routes them to targets for\n processing. A single rule can route to multiple targets, all of which are\n processed in parallel. Rules are not processed in a particular order. This\n enables different parts of an organization to look for and process the events\n that are of interest to them. A rule can customize the JSON sent to the\n target, by passing only certain parts or by overwriting it with a constant.\n* __EventBuses__: An event bus can receive events from your own custom applications\n or it can receive events from applications and services created by AWS SaaS partners.\n See [Creating an Event Bus](https://docs.aws.amazon.com/eventbridge/latest/userguide/create-event-bus.html).\n\n## Rule\n\nThe `Rule` construct defines an EventBridge rule which monitors an\nevent based on an [event\npattern](https://docs.aws.amazon.com/eventbridge/latest/userguide/filtering-examples-structure.html)\nand invoke __event targets__ when the pattern is matched against a triggered\nevent. Event targets are objects that implement the `IRuleTarget` interface.\n\nNormally, you will use one of the `source.onXxx(name[, target[, options]]) ->\nRule` methods on the event source to define an event rule associated with\nthe specific activity. You can targets either via props, or add targets using\n`rule.addTarget`.\n\nFor example, to define an rule that triggers a CodeBuild project build when a\ncommit is pushed to the \"master\" branch of a CodeCommit repository:\n\n```ts\ndeclare const repo: codecommit.Repository;\ndeclare const project: codebuild.Project;\n\nconst onCommitRule = repo.onCommit('OnCommit', {\n target: new targets.CodeBuildProject(project),\n branches: ['master']\n});\n```\n\nYou can add additional targets, with optional [input\ntransformer](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_InputTransformer.html)\nusing `eventRule.addTarget(target[, input])`. For example, we can add a SNS\ntopic target which formats a human-readable message for the commit.\n\nFor example, this adds an SNS topic as a target:\n\n```ts\ndeclare const onCommitRule: events.Rule;\ndeclare const topic: sns.Topic;\n\nonCommitRule.addTarget(new targets.SnsTopic(topic, {\n message: events.RuleTargetInput.fromText(\n `A commit was pushed to the repository ${codecommit.ReferenceEvent.repositoryName} on branch ${codecommit.ReferenceEvent.referenceName}`\n )\n}));\n```\n\nOr using an Object:\n\n```ts\ndeclare const onCommitRule: events.Rule;\ndeclare const topic: sns.Topic;\n\nonCommitRule.addTarget(new targets.SnsTopic(topic, {\n message: events.RuleTargetInput.fromObject(\n {\n DataType: `custom_${events.EventField.fromPath('$.detail-type')}`\n }\n )\n}));\n```\n\n## Scheduling\n\nYou can configure a Rule to run on a schedule (cron or rate).\nRate must be specified in minutes, hours or days.\n\nThe following example runs a task every day at 4am:\n\n```ts fixture=basic\nimport { Rule, Schedule } from '@aws-cdk/aws-events';\nimport { EcsTask } from '@aws-cdk/aws-events-targets';\nimport { Cluster, TaskDefinition } from '@aws-cdk/aws-ecs';\nimport { Role } from '@aws-cdk/aws-iam';\n\ndeclare const cluster: Cluster;\ndeclare const taskDefinition: TaskDefinition;\ndeclare const role: Role;\n\nconst ecsTaskTarget = new EcsTask({ cluster, taskDefinition, role });\n\nnew Rule(this, 'ScheduleRule', {\n schedule: Schedule.cron({ minute: '0', hour: '4' }),\n targets: [ecsTaskTarget],\n});\n```\n\nIf you want to specify Fargate platform version, set `platformVersion` in EcsTask's props like the following example:\n\n```ts\ndeclare const cluster: ecs.Cluster;\ndeclare const taskDefinition: ecs.TaskDefinition;\ndeclare const role: iam.Role;\n\nconst platformVersion = ecs.FargatePlatformVersion.VERSION1_4;\nconst ecsTaskTarget = new targets.EcsTask({ cluster, taskDefinition, role, platformVersion });\n```\n\n## Event Targets\n\nThe `@aws-cdk/aws-events-targets` module includes classes that implement the `IRuleTarget`\ninterface for various AWS services.\n\nThe following targets are supported:\n\n* `targets.CodeBuildProject`: Start an AWS CodeBuild build\n* `targets.CodePipeline`: Start an AWS CodePipeline pipeline execution\n* `targets.EcsTask`: Start a task on an Amazon ECS cluster\n* `targets.LambdaFunction`: Invoke an AWS Lambda function\n* `targets.SnsTopic`: Publish into an SNS topic\n* `targets.SqsQueue`: Send a message to an Amazon SQS Queue\n* `targets.SfnStateMachine`: Trigger an AWS Step Functions state machine\n* `targets.BatchJob`: Queue an AWS Batch Job\n* `targets.AwsApi`: Make an AWS API call\n* `targets.ApiGateway`: Invoke an AWS API Gateway\n* `targets.ApiDestination`: Make an call to an external destination\n\n### Cross-account and cross-region targets\n\nIt's possible to have the source of the event and a target in separate AWS accounts and regions:\n\n```ts nofixture\nimport { App, Stack } from '@aws-cdk/core';\nimport * as codebuild from '@aws-cdk/aws-codebuild';\nimport * as codecommit from '@aws-cdk/aws-codecommit';\nimport * as targets from '@aws-cdk/aws-events-targets';\n\nconst app = new App();\n\nconst account1 = '11111111111';\nconst account2 = '22222222222';\n\nconst stack1 = new Stack(app, 'Stack1', { env: { account: account1, region: 'us-west-1' } });\nconst repo = new codecommit.Repository(stack1, 'Repository', {\n repositoryName: 'myrepository',\n});\n\nconst stack2 = new Stack(app, 'Stack2', { env: { account: account2, region: 'us-east-1' } });\nconst project = new codebuild.Project(stack2, 'Project', {\n // ...\n});\n\nrepo.onCommit('OnCommit', {\n target: new targets.CodeBuildProject(project),\n});\n```\n\nIn this situation, the CDK will wire the 2 accounts together:\n\n* It will generate a rule in the source stack with the event bus of the target account as the target\n* It will generate a rule in the target stack, with the provided target\n* It will generate a separate stack that gives the source account permissions to publish events\n to the event bus of the target account in the given region,\n and make sure its deployed before the source stack\n\nFor more information, see the\n[AWS documentation on cross-account events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html).\n\n## Archiving\n\nIt is possible to archive all or some events sent to an event bus. It is then possible to [replay these events](https://aws.amazon.com/blogs/aws/new-archive-and-replay-events-with-amazon-eventbridge/).\n\n```ts\nconst bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});\n```\n\n## Granting PutEvents to an existing EventBus\n\nTo import an existing EventBus into your CDK application, use `EventBus.fromEventBusArn`, `EventBus.fromEventBusAttributes`\nor `EventBus.fromEventBusName` factory method.\n\nThen, you can use the `grantPutEventsTo` method to grant `event:PutEvents` to the eventBus.\n\n```ts\ndeclare const lambdaFunction: lambda.Function;\n\nconst eventBus = events.EventBus.fromEventBusArn(this, 'ImportedEventBus', 'arn:aws:events:us-east-1:111111111:event-bus/my-event-bus');\n\n// now you can just call methods on the eventbus\neventBus.grantPutEventsTo(lambdaFunction);\n```\n"
206 },
207 "repository": {
208 "directory": "packages/@aws-cdk/aws-events",
209 "type": "git",
210 "url": "https://github.com/aws/aws-cdk.git"
211 },
212 "schema": "jsii/0.10.0",
213 "targets": {
214 "dotnet": {
215 "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
216 "namespace": "Amazon.CDK.AWS.Events",
217 "packageId": "Amazon.CDK.AWS.Events"
218 },
219 "java": {
220 "maven": {
221 "artifactId": "events",
222 "groupId": "software.amazon.awscdk"
223 },
224 "package": "software.amazon.awscdk.services.events"
225 },
226 "js": {
227 "npm": "@aws-cdk/aws-events"
228 },
229 "python": {
230 "classifiers": [
231 "Framework :: AWS CDK",
232 "Framework :: AWS CDK :: 1"
233 ],
234 "distName": "aws-cdk.aws-events",
235 "module": "aws_cdk.aws_events"
236 }
237 },
238 "types": {
239 "@aws-cdk/aws-events.ApiDestination": {
240 "assembly": "@aws-cdk/aws-events",
241 "base": "@aws-cdk/core.Resource",
242 "docs": {
243 "custom": {
244 "exampleMetadata": "infused",
245 "resource": "AWS::Events::ApiDestination"
246 },
247 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
248 "stability": "stable",
249 "summary": "Define an EventBridge Api Destination."
250 },
251 "fqn": "@aws-cdk/aws-events.ApiDestination",
252 "initializer": {
253 "docs": {
254 "stability": "stable"
255 },
256 "locationInModule": {
257 "filename": "lib/api-destination.ts",
258 "line": 88
259 },
260 "parameters": [
261 {
262 "name": "scope",
263 "type": {
264 "fqn": "constructs.Construct"
265 }
266 },
267 {
268 "name": "id",
269 "type": {
270 "primitive": "string"
271 }
272 },
273 {
274 "name": "props",
275 "type": {
276 "fqn": "@aws-cdk/aws-events.ApiDestinationProps"
277 }
278 }
279 ]
280 },
281 "interfaces": [
282 "@aws-cdk/aws-events.IApiDestination"
283 ],
284 "kind": "class",
285 "locationInModule": {
286 "filename": "lib/api-destination.ts",
287 "line": 70
288 },
289 "name": "ApiDestination",
290 "properties": [
291 {
292 "docs": {
293 "custom": {
294 "attribute": "true"
295 },
296 "stability": "stable",
297 "summary": "The ARN of the Api Destination created."
298 },
299 "immutable": true,
300 "locationInModule": {
301 "filename": "lib/api-destination.ts",
302 "line": 86
303 },
304 "name": "apiDestinationArn",
305 "overrides": "@aws-cdk/aws-events.IApiDestination",
306 "type": {
307 "primitive": "string"
308 }
309 },
310 {
311 "docs": {
312 "custom": {
313 "attribute": "true"
314 },
315 "stability": "stable",
316 "summary": "The Name of the Api Destination created."
317 },
318 "immutable": true,
319 "locationInModule": {
320 "filename": "lib/api-destination.ts",
321 "line": 80
322 },
323 "name": "apiDestinationName",
324 "overrides": "@aws-cdk/aws-events.IApiDestination",
325 "type": {
326 "primitive": "string"
327 }
328 },
329 {
330 "docs": {
331 "stability": "stable",
332 "summary": "The Connection to associate with Api Destination."
333 },
334 "immutable": true,
335 "locationInModule": {
336 "filename": "lib/api-destination.ts",
337 "line": 74
338 },
339 "name": "connection",
340 "type": {
341 "fqn": "@aws-cdk/aws-events.IConnection"
342 }
343 }
344 ],
345 "symbolId": "lib/api-destination:ApiDestination"
346 },
347 "@aws-cdk/aws-events.ApiDestinationProps": {
348 "assembly": "@aws-cdk/aws-events",
349 "datatype": true,
350 "docs": {
351 "custom": {
352 "exampleMetadata": "infused"
353 },
354 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
355 "stability": "stable",
356 "summary": "The event API Destination properties."
357 },
358 "fqn": "@aws-cdk/aws-events.ApiDestinationProps",
359 "kind": "interface",
360 "locationInModule": {
361 "filename": "lib/api-destination.ts",
362 "line": 9
363 },
364 "name": "ApiDestinationProps",
365 "properties": [
366 {
367 "abstract": true,
368 "docs": {
369 "stability": "stable",
370 "summary": "The ARN of the connection to use for the API destination."
371 },
372 "immutable": true,
373 "locationInModule": {
374 "filename": "lib/api-destination.ts",
375 "line": 26
376 },
377 "name": "connection",
378 "type": {
379 "fqn": "@aws-cdk/aws-events.IConnection"
380 }
381 },
382 {
383 "abstract": true,
384 "docs": {
385 "stability": "stable",
386 "summary": "The URL to the HTTP invocation endpoint for the API destination.."
387 },
388 "immutable": true,
389 "locationInModule": {
390 "filename": "lib/api-destination.ts",
391 "line": 31
392 },
393 "name": "endpoint",
394 "type": {
395 "primitive": "string"
396 }
397 },
398 {
399 "abstract": true,
400 "docs": {
401 "default": "- A unique name will be generated",
402 "stability": "stable",
403 "summary": "The name for the API destination."
404 },
405 "immutable": true,
406 "locationInModule": {
407 "filename": "lib/api-destination.ts",
408 "line": 14
409 },
410 "name": "apiDestinationName",
411 "optional": true,
412 "type": {
413 "primitive": "string"
414 }
415 },
416 {
417 "abstract": true,
418 "docs": {
419 "default": "- none",
420 "stability": "stable",
421 "summary": "A description for the API destination."
422 },
423 "immutable": true,
424 "locationInModule": {
425 "filename": "lib/api-destination.ts",
426 "line": 21
427 },
428 "name": "description",
429 "optional": true,
430 "type": {
431 "primitive": "string"
432 }
433 },
434 {
435 "abstract": true,
436 "docs": {
437 "default": "HttpMethod.POST",
438 "stability": "stable",
439 "summary": "The method to use for the request to the HTTP invocation endpoint."
440 },
441 "immutable": true,
442 "locationInModule": {
443 "filename": "lib/api-destination.ts",
444 "line": 38
445 },
446 "name": "httpMethod",
447 "optional": true,
448 "type": {
449 "fqn": "@aws-cdk/aws-events.HttpMethod"
450 }
451 },
452 {
453 "abstract": true,
454 "docs": {
455 "default": "- Not rate limited",
456 "stability": "stable",
457 "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint."
458 },
459 "immutable": true,
460 "locationInModule": {
461 "filename": "lib/api-destination.ts",
462 "line": 45
463 },
464 "name": "rateLimitPerSecond",
465 "optional": true,
466 "type": {
467 "primitive": "number"
468 }
469 }
470 ],
471 "symbolId": "lib/api-destination:ApiDestinationProps"
472 },
473 "@aws-cdk/aws-events.Archive": {
474 "assembly": "@aws-cdk/aws-events",
475 "base": "@aws-cdk/core.Resource",
476 "docs": {
477 "custom": {
478 "resource": "AWS::Events::Archive",
479 "exampleMetadata": "fixture=_generated"
480 },
481 "stability": "stable",
482 "summary": "Define an EventBridge Archive.",
483 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const detail: any;\ndeclare const eventBus: events.EventBus;\nconst archive = new events.Archive(this, 'MyArchive', {\n eventPattern: {\n account: ['account'],\n detail: {\n detailKey: detail,\n },\n detailType: ['detailType'],\n id: ['id'],\n region: ['region'],\n resources: ['resources'],\n source: ['source'],\n time: ['time'],\n version: ['version'],\n },\n sourceEventBus: eventBus,\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n retention: cdk.Duration.minutes(30),\n});"
484 },
485 "fqn": "@aws-cdk/aws-events.Archive",
486 "initializer": {
487 "docs": {
488 "stability": "stable"
489 },
490 "locationInModule": {
491 "filename": "lib/archive.ts",
492 "line": 64
493 },
494 "parameters": [
495 {
496 "name": "scope",
497 "type": {
498 "fqn": "constructs.Construct"
499 }
500 },
501 {
502 "name": "id",
503 "type": {
504 "primitive": "string"
505 }
506 },
507 {
508 "name": "props",
509 "type": {
510 "fqn": "@aws-cdk/aws-events.ArchiveProps"
511 }
512 }
513 ]
514 },
515 "kind": "class",
516 "locationInModule": {
517 "filename": "lib/archive.ts",
518 "line": 51
519 },
520 "name": "Archive",
521 "properties": [
522 {
523 "docs": {
524 "custom": {
525 "attribute": "true"
526 },
527 "stability": "stable",
528 "summary": "The ARN of the archive created."
529 },
530 "immutable": true,
531 "locationInModule": {
532 "filename": "lib/archive.ts",
533 "line": 62
534 },
535 "name": "archiveArn",
536 "type": {
537 "primitive": "string"
538 }
539 },
540 {
541 "docs": {
542 "custom": {
543 "attribute": "true"
544 },
545 "stability": "stable",
546 "summary": "The archive name."
547 },
548 "immutable": true,
549 "locationInModule": {
550 "filename": "lib/archive.ts",
551 "line": 56
552 },
553 "name": "archiveName",
554 "type": {
555 "primitive": "string"
556 }
557 }
558 ],
559 "symbolId": "lib/archive:Archive"
560 },
561 "@aws-cdk/aws-events.ArchiveProps": {
562 "assembly": "@aws-cdk/aws-events",
563 "datatype": true,
564 "docs": {
565 "stability": "stable",
566 "summary": "The event archive properties.",
567 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const detail: any;\ndeclare const eventBus: events.EventBus;\nconst archiveProps: events.ArchiveProps = {\n eventPattern: {\n account: ['account'],\n detail: {\n detailKey: detail,\n },\n detailType: ['detailType'],\n id: ['id'],\n region: ['region'],\n resources: ['resources'],\n source: ['source'],\n time: ['time'],\n version: ['version'],\n },\n sourceEventBus: eventBus,\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n retention: cdk.Duration.minutes(30),\n};",
568 "custom": {
569 "exampleMetadata": "fixture=_generated"
570 }
571 },
572 "fqn": "@aws-cdk/aws-events.ArchiveProps",
573 "interfaces": [
574 "@aws-cdk/aws-events.BaseArchiveProps"
575 ],
576 "kind": "interface",
577 "locationInModule": {
578 "filename": "lib/archive.ts",
579 "line": 39
580 },
581 "name": "ArchiveProps",
582 "properties": [
583 {
584 "abstract": true,
585 "docs": {
586 "stability": "stable",
587 "summary": "The event source associated with the archive."
588 },
589 "immutable": true,
590 "locationInModule": {
591 "filename": "lib/archive.ts",
592 "line": 43
593 },
594 "name": "sourceEventBus",
595 "type": {
596 "fqn": "@aws-cdk/aws-events.IEventBus"
597 }
598 }
599 ],
600 "symbolId": "lib/archive:ArchiveProps"
601 },
602 "@aws-cdk/aws-events.Authorization": {
603 "abstract": true,
604 "assembly": "@aws-cdk/aws-events",
605 "docs": {
606 "custom": {
607 "exampleMetadata": "infused"
608 },
609 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
610 "stability": "stable",
611 "summary": "Authorization type for an API Destination Connection."
612 },
613 "fqn": "@aws-cdk/aws-events.Authorization",
614 "initializer": {
615 "docs": {
616 "stability": "stable"
617 }
618 },
619 "kind": "class",
620 "locationInModule": {
621 "filename": "lib/connection.ts",
622 "line": 55
623 },
624 "methods": [
625 {
626 "docs": {
627 "remarks": "API key authorization has two components: an API key name and an API key value.\nWhat these are depends on the target of your connection.",
628 "stability": "stable",
629 "summary": "Use API key authorization."
630 },
631 "locationInModule": {
632 "filename": "lib/connection.ts",
633 "line": 62
634 },
635 "name": "apiKey",
636 "parameters": [
637 {
638 "name": "apiKeyName",
639 "type": {
640 "primitive": "string"
641 }
642 },
643 {
644 "name": "apiKeyValue",
645 "type": {
646 "fqn": "@aws-cdk/core.SecretValue"
647 }
648 }
649 ],
650 "returns": {
651 "type": {
652 "fqn": "@aws-cdk/aws-events.Authorization"
653 }
654 },
655 "static": true
656 },
657 {
658 "docs": {
659 "stability": "stable",
660 "summary": "Use username and password authorization."
661 },
662 "locationInModule": {
663 "filename": "lib/connection.ts",
664 "line": 81
665 },
666 "name": "basic",
667 "parameters": [
668 {
669 "name": "username",
670 "type": {
671 "primitive": "string"
672 }
673 },
674 {
675 "name": "password",
676 "type": {
677 "fqn": "@aws-cdk/core.SecretValue"
678 }
679 }
680 ],
681 "returns": {
682 "type": {
683 "fqn": "@aws-cdk/aws-events.Authorization"
684 }
685 },
686 "static": true
687 },
688 {
689 "docs": {
690 "stability": "stable",
691 "summary": "Use OAuth authorization."
692 },
693 "locationInModule": {
694 "filename": "lib/connection.ts",
695 "line": 100
696 },
697 "name": "oauth",
698 "parameters": [
699 {
700 "name": "props",
701 "type": {
702 "fqn": "@aws-cdk/aws-events.OAuthAuthorizationProps"
703 }
704 }
705 ],
706 "returns": {
707 "type": {
708 "fqn": "@aws-cdk/aws-events.Authorization"
709 }
710 },
711 "static": true
712 }
713 ],
714 "name": "Authorization",
715 "symbolId": "lib/connection:Authorization"
716 },
717 "@aws-cdk/aws-events.BaseArchiveProps": {
718 "assembly": "@aws-cdk/aws-events",
719 "datatype": true,
720 "docs": {
721 "custom": {
722 "exampleMetadata": "infused"
723 },
724 "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});",
725 "stability": "stable",
726 "summary": "The event archive base properties."
727 },
728 "fqn": "@aws-cdk/aws-events.BaseArchiveProps",
729 "kind": "interface",
730 "locationInModule": {
731 "filename": "lib/archive.ts",
732 "line": 11
733 },
734 "name": "BaseArchiveProps",
735 "properties": [
736 {
737 "abstract": true,
738 "docs": {
739 "stability": "stable",
740 "summary": "An event pattern to use to filter events sent to the archive."
741 },
742 "immutable": true,
743 "locationInModule": {
744 "filename": "lib/archive.ts",
745 "line": 27
746 },
747 "name": "eventPattern",
748 "type": {
749 "fqn": "@aws-cdk/aws-events.EventPattern"
750 }
751 },
752 {
753 "abstract": true,
754 "docs": {
755 "default": "- Automatically generated",
756 "stability": "stable",
757 "summary": "The name of the archive."
758 },
759 "immutable": true,
760 "locationInModule": {
761 "filename": "lib/archive.ts",
762 "line": 17
763 },
764 "name": "archiveName",
765 "optional": true,
766 "type": {
767 "primitive": "string"
768 }
769 },
770 {
771 "abstract": true,
772 "docs": {
773 "default": "- none",
774 "stability": "stable",
775 "summary": "A description for the archive."
776 },
777 "immutable": true,
778 "locationInModule": {
779 "filename": "lib/archive.ts",
780 "line": 23
781 },
782 "name": "description",
783 "optional": true,
784 "type": {
785 "primitive": "string"
786 }
787 },
788 {
789 "abstract": true,
790 "docs": {
791 "default": "- Infinite",
792 "remarks": "Default value is 0. If set to 0, events are retained indefinitely.",
793 "stability": "stable",
794 "summary": "The number of days to retain events for."
795 },
796 "immutable": true,
797 "locationInModule": {
798 "filename": "lib/archive.ts",
799 "line": 32
800 },
801 "name": "retention",
802 "optional": true,
803 "type": {
804 "fqn": "@aws-cdk/core.Duration"
805 }
806 }
807 ],
808 "symbolId": "lib/archive:BaseArchiveProps"
809 },
810 "@aws-cdk/aws-events.CfnApiDestination": {
811 "assembly": "@aws-cdk/aws-events",
812 "base": "@aws-cdk/core.CfnResource",
813 "docs": {
814 "custom": {
815 "cloudformationResource": "AWS::Events::ApiDestination",
816 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html",
817 "exampleMetadata": "fixture=_generated"
818 },
819 "remarks": "Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.\n\nWhen using ApiDesinations with OAuth authentication we recommend these best practices:\n\n- Create a secret in Secrets Manager with your OAuth credentials.\n- 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) .\n\nWhen 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.\n\n> The secret stored in the customer account by EventBridge can’t be updated directly, only when a CloudFormation template is updated.\n\nFor 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) .",
820 "stability": "external",
821 "summary": "A CloudFormation `AWS::Events::ApiDestination`.",
822 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnApiDestination = new events.CfnApiDestination(this, 'MyCfnApiDestination', {\n connectionArn: 'connectionArn',\n httpMethod: 'httpMethod',\n invocationEndpoint: 'invocationEndpoint',\n\n // the properties below are optional\n description: 'description',\n invocationRateLimitPerSecond: 123,\n name: 'name',\n});"
823 },
824 "fqn": "@aws-cdk/aws-events.CfnApiDestination",
825 "initializer": {
826 "docs": {
827 "stability": "external",
828 "summary": "Create a new `AWS::Events::ApiDestination`."
829 },
830 "locationInModule": {
831 "filename": "lib/events.generated.ts",
832 "line": 228
833 },
834 "parameters": [
835 {
836 "docs": {
837 "summary": "- scope in which this resource is defined."
838 },
839 "name": "scope",
840 "type": {
841 "fqn": "@aws-cdk/core.Construct"
842 }
843 },
844 {
845 "docs": {
846 "summary": "- scoped id of the resource."
847 },
848 "name": "id",
849 "type": {
850 "primitive": "string"
851 }
852 },
853 {
854 "docs": {
855 "summary": "- resource properties."
856 },
857 "name": "props",
858 "type": {
859 "fqn": "@aws-cdk/aws-events.CfnApiDestinationProps"
860 }
861 }
862 ]
863 },
864 "interfaces": [
865 "@aws-cdk/core.IInspectable"
866 ],
867 "kind": "class",
868 "locationInModule": {
869 "filename": "lib/events.generated.ts",
870 "line": 148
871 },
872 "methods": [
873 {
874 "docs": {
875 "stability": "external",
876 "summary": "Examines the CloudFormation resource and discloses attributes."
877 },
878 "locationInModule": {
879 "filename": "lib/events.generated.ts",
880 "line": 249
881 },
882 "name": "inspect",
883 "overrides": "@aws-cdk/core.IInspectable",
884 "parameters": [
885 {
886 "docs": {
887 "summary": "- tree inspector to collect and process attributes."
888 },
889 "name": "inspector",
890 "type": {
891 "fqn": "@aws-cdk/core.TreeInspector"
892 }
893 }
894 ]
895 },
896 {
897 "docs": {
898 "stability": "external"
899 },
900 "locationInModule": {
901 "filename": "lib/events.generated.ts",
902 "line": 265
903 },
904 "name": "renderProperties",
905 "overrides": "@aws-cdk/core.CfnResource",
906 "parameters": [
907 {
908 "name": "props",
909 "type": {
910 "collection": {
911 "elementtype": {
912 "primitive": "any"
913 },
914 "kind": "map"
915 }
916 }
917 }
918 ],
919 "protected": true,
920 "returns": {
921 "type": {
922 "collection": {
923 "elementtype": {
924 "primitive": "any"
925 },
926 "kind": "map"
927 }
928 }
929 }
930 }
931 ],
932 "name": "CfnApiDestination",
933 "properties": [
934 {
935 "const": true,
936 "docs": {
937 "stability": "external",
938 "summary": "The CloudFormation resource type name for this resource class."
939 },
940 "immutable": true,
941 "locationInModule": {
942 "filename": "lib/events.generated.ts",
943 "line": 152
944 },
945 "name": "CFN_RESOURCE_TYPE_NAME",
946 "static": true,
947 "type": {
948 "primitive": "string"
949 }
950 },
951 {
952 "docs": {
953 "custom": {
954 "cloudformationAttribute": "Arn"
955 },
956 "stability": "external",
957 "summary": "The ARN of the API destination that was created by the request."
958 },
959 "immutable": true,
960 "locationInModule": {
961 "filename": "lib/events.generated.ts",
962 "line": 177
963 },
964 "name": "attrArn",
965 "type": {
966 "primitive": "string"
967 }
968 },
969 {
970 "docs": {
971 "stability": "external"
972 },
973 "immutable": true,
974 "locationInModule": {
975 "filename": "lib/events.generated.ts",
976 "line": 254
977 },
978 "name": "cfnProperties",
979 "overrides": "@aws-cdk/core.CfnResource",
980 "protected": true,
981 "type": {
982 "collection": {
983 "elementtype": {
984 "primitive": "any"
985 },
986 "kind": "map"
987 }
988 }
989 },
990 {
991 "docs": {
992 "custom": {
993 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn"
994 },
995 "remarks": "The destination endpoint must support the authorization type specified for the connection.",
996 "stability": "external",
997 "summary": "The ARN of the connection to use for the API destination."
998 },
999 "locationInModule": {
1000 "filename": "lib/events.generated.ts",
1001 "line": 184
1002 },
1003 "name": "connectionArn",
1004 "type": {
1005 "primitive": "string"
1006 }
1007 },
1008 {
1009 "docs": {
1010 "custom": {
1011 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod"
1012 },
1013 "stability": "external",
1014 "summary": "The method to use for the request to the HTTP invocation endpoint."
1015 },
1016 "locationInModule": {
1017 "filename": "lib/events.generated.ts",
1018 "line": 191
1019 },
1020 "name": "httpMethod",
1021 "type": {
1022 "primitive": "string"
1023 }
1024 },
1025 {
1026 "docs": {
1027 "custom": {
1028 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint"
1029 },
1030 "stability": "external",
1031 "summary": "The URL to the HTTP invocation endpoint for the API destination."
1032 },
1033 "locationInModule": {
1034 "filename": "lib/events.generated.ts",
1035 "line": 198
1036 },
1037 "name": "invocationEndpoint",
1038 "type": {
1039 "primitive": "string"
1040 }
1041 },
1042 {
1043 "docs": {
1044 "custom": {
1045 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description"
1046 },
1047 "stability": "external",
1048 "summary": "A description for the API destination to create."
1049 },
1050 "locationInModule": {
1051 "filename": "lib/events.generated.ts",
1052 "line": 205
1053 },
1054 "name": "description",
1055 "optional": true,
1056 "type": {
1057 "primitive": "string"
1058 }
1059 },
1060 {
1061 "docs": {
1062 "custom": {
1063 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond"
1064 },
1065 "stability": "external",
1066 "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint."
1067 },
1068 "locationInModule": {
1069 "filename": "lib/events.generated.ts",
1070 "line": 212
1071 },
1072 "name": "invocationRateLimitPerSecond",
1073 "optional": true,
1074 "type": {
1075 "primitive": "number"
1076 }
1077 },
1078 {
1079 "docs": {
1080 "custom": {
1081 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name"
1082 },
1083 "stability": "external",
1084 "summary": "The name for the API destination to create."
1085 },
1086 "locationInModule": {
1087 "filename": "lib/events.generated.ts",
1088 "line": 219
1089 },
1090 "name": "name",
1091 "optional": true,
1092 "type": {
1093 "primitive": "string"
1094 }
1095 }
1096 ],
1097 "symbolId": "lib/events.generated:CfnApiDestination"
1098 },
1099 "@aws-cdk/aws-events.CfnApiDestinationProps": {
1100 "assembly": "@aws-cdk/aws-events",
1101 "datatype": true,
1102 "docs": {
1103 "custom": {
1104 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html",
1105 "exampleMetadata": "fixture=_generated"
1106 },
1107 "stability": "external",
1108 "summary": "Properties for defining a `CfnApiDestination`.",
1109 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnApiDestinationProps: events.CfnApiDestinationProps = {\n connectionArn: 'connectionArn',\n httpMethod: 'httpMethod',\n invocationEndpoint: 'invocationEndpoint',\n\n // the properties below are optional\n description: 'description',\n invocationRateLimitPerSecond: 123,\n name: 'name',\n};"
1110 },
1111 "fqn": "@aws-cdk/aws-events.CfnApiDestinationProps",
1112 "kind": "interface",
1113 "locationInModule": {
1114 "filename": "lib/events.generated.ts",
1115 "line": 19
1116 },
1117 "name": "CfnApiDestinationProps",
1118 "properties": [
1119 {
1120 "abstract": true,
1121 "docs": {
1122 "custom": {
1123 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-connectionarn"
1124 },
1125 "remarks": "The destination endpoint must support the authorization type specified for the connection.",
1126 "stability": "external",
1127 "summary": "The ARN of the connection to use for the API destination."
1128 },
1129 "immutable": true,
1130 "locationInModule": {
1131 "filename": "lib/events.generated.ts",
1132 "line": 26
1133 },
1134 "name": "connectionArn",
1135 "type": {
1136 "primitive": "string"
1137 }
1138 },
1139 {
1140 "abstract": true,
1141 "docs": {
1142 "custom": {
1143 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-httpmethod"
1144 },
1145 "stability": "external",
1146 "summary": "The method to use for the request to the HTTP invocation endpoint."
1147 },
1148 "immutable": true,
1149 "locationInModule": {
1150 "filename": "lib/events.generated.ts",
1151 "line": 33
1152 },
1153 "name": "httpMethod",
1154 "type": {
1155 "primitive": "string"
1156 }
1157 },
1158 {
1159 "abstract": true,
1160 "docs": {
1161 "custom": {
1162 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationendpoint"
1163 },
1164 "stability": "external",
1165 "summary": "The URL to the HTTP invocation endpoint for the API destination."
1166 },
1167 "immutable": true,
1168 "locationInModule": {
1169 "filename": "lib/events.generated.ts",
1170 "line": 40
1171 },
1172 "name": "invocationEndpoint",
1173 "type": {
1174 "primitive": "string"
1175 }
1176 },
1177 {
1178 "abstract": true,
1179 "docs": {
1180 "custom": {
1181 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-description"
1182 },
1183 "stability": "external",
1184 "summary": "A description for the API destination to create."
1185 },
1186 "immutable": true,
1187 "locationInModule": {
1188 "filename": "lib/events.generated.ts",
1189 "line": 47
1190 },
1191 "name": "description",
1192 "optional": true,
1193 "type": {
1194 "primitive": "string"
1195 }
1196 },
1197 {
1198 "abstract": true,
1199 "docs": {
1200 "custom": {
1201 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-invocationratelimitpersecond"
1202 },
1203 "stability": "external",
1204 "summary": "The maximum number of requests per second to send to the HTTP invocation endpoint."
1205 },
1206 "immutable": true,
1207 "locationInModule": {
1208 "filename": "lib/events.generated.ts",
1209 "line": 54
1210 },
1211 "name": "invocationRateLimitPerSecond",
1212 "optional": true,
1213 "type": {
1214 "primitive": "number"
1215 }
1216 },
1217 {
1218 "abstract": true,
1219 "docs": {
1220 "custom": {
1221 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-apidestination.html#cfn-events-apidestination-name"
1222 },
1223 "stability": "external",
1224 "summary": "The name for the API destination to create."
1225 },
1226 "immutable": true,
1227 "locationInModule": {
1228 "filename": "lib/events.generated.ts",
1229 "line": 61
1230 },
1231 "name": "name",
1232 "optional": true,
1233 "type": {
1234 "primitive": "string"
1235 }
1236 }
1237 ],
1238 "symbolId": "lib/events.generated:CfnApiDestinationProps"
1239 },
1240 "@aws-cdk/aws-events.CfnArchive": {
1241 "assembly": "@aws-cdk/aws-events",
1242 "base": "@aws-cdk/core.CfnResource",
1243 "docs": {
1244 "custom": {
1245 "cloudformationResource": "AWS::Events::Archive",
1246 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html",
1247 "exampleMetadata": "fixture=_generated"
1248 },
1249 "remarks": "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.",
1250 "stability": "external",
1251 "summary": "A CloudFormation `AWS::Events::Archive`.",
1252 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnArchive = new events.CfnArchive(this, 'MyCfnArchive', {\n sourceArn: 'sourceArn',\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n eventPattern: eventPattern,\n retentionDays: 123,\n});"
1253 },
1254 "fqn": "@aws-cdk/aws-events.CfnArchive",
1255 "initializer": {
1256 "docs": {
1257 "stability": "external",
1258 "summary": "Create a new `AWS::Events::Archive`."
1259 },
1260 "locationInModule": {
1261 "filename": "lib/events.generated.ts",
1262 "line": 463
1263 },
1264 "parameters": [
1265 {
1266 "docs": {
1267 "summary": "- scope in which this resource is defined."
1268 },
1269 "name": "scope",
1270 "type": {
1271 "fqn": "@aws-cdk/core.Construct"
1272 }
1273 },
1274 {
1275 "docs": {
1276 "summary": "- scoped id of the resource."
1277 },
1278 "name": "id",
1279 "type": {
1280 "primitive": "string"
1281 }
1282 },
1283 {
1284 "docs": {
1285 "summary": "- resource properties."
1286 },
1287 "name": "props",
1288 "type": {
1289 "fqn": "@aws-cdk/aws-events.CfnArchiveProps"
1290 }
1291 }
1292 ]
1293 },
1294 "interfaces": [
1295 "@aws-cdk/core.IInspectable"
1296 ],
1297 "kind": "class",
1298 "locationInModule": {
1299 "filename": "lib/events.generated.ts",
1300 "line": 384
1301 },
1302 "methods": [
1303 {
1304 "docs": {
1305 "stability": "external",
1306 "summary": "Examines the CloudFormation resource and discloses attributes."
1307 },
1308 "locationInModule": {
1309 "filename": "lib/events.generated.ts",
1310 "line": 482
1311 },
1312 "name": "inspect",
1313 "overrides": "@aws-cdk/core.IInspectable",
1314 "parameters": [
1315 {
1316 "docs": {
1317 "summary": "- tree inspector to collect and process attributes."
1318 },
1319 "name": "inspector",
1320 "type": {
1321 "fqn": "@aws-cdk/core.TreeInspector"
1322 }
1323 }
1324 ]
1325 },
1326 {
1327 "docs": {
1328 "stability": "external"
1329 },
1330 "locationInModule": {
1331 "filename": "lib/events.generated.ts",
1332 "line": 497
1333 },
1334 "name": "renderProperties",
1335 "overrides": "@aws-cdk/core.CfnResource",
1336 "parameters": [
1337 {
1338 "name": "props",
1339 "type": {
1340 "collection": {
1341 "elementtype": {
1342 "primitive": "any"
1343 },
1344 "kind": "map"
1345 }
1346 }
1347 }
1348 ],
1349 "protected": true,
1350 "returns": {
1351 "type": {
1352 "collection": {
1353 "elementtype": {
1354 "primitive": "any"
1355 },
1356 "kind": "map"
1357 }
1358 }
1359 }
1360 }
1361 ],
1362 "name": "CfnArchive",
1363 "properties": [
1364 {
1365 "const": true,
1366 "docs": {
1367 "stability": "external",
1368 "summary": "The CloudFormation resource type name for this resource class."
1369 },
1370 "immutable": true,
1371 "locationInModule": {
1372 "filename": "lib/events.generated.ts",
1373 "line": 388
1374 },
1375 "name": "CFN_RESOURCE_TYPE_NAME",
1376 "static": true,
1377 "type": {
1378 "primitive": "string"
1379 }
1380 },
1381 {
1382 "docs": {
1383 "custom": {
1384 "cloudformationAttribute": "ArchiveName"
1385 },
1386 "stability": "external",
1387 "summary": "The archive name."
1388 },
1389 "immutable": true,
1390 "locationInModule": {
1391 "filename": "lib/events.generated.ts",
1392 "line": 413
1393 },
1394 "name": "attrArchiveName",
1395 "type": {
1396 "primitive": "string"
1397 }
1398 },
1399 {
1400 "docs": {
1401 "custom": {
1402 "cloudformationAttribute": "Arn"
1403 },
1404 "stability": "external",
1405 "summary": "The ARN of the archive created."
1406 },
1407 "immutable": true,
1408 "locationInModule": {
1409 "filename": "lib/events.generated.ts",
1410 "line": 419
1411 },
1412 "name": "attrArn",
1413 "type": {
1414 "primitive": "string"
1415 }
1416 },
1417 {
1418 "docs": {
1419 "stability": "external"
1420 },
1421 "immutable": true,
1422 "locationInModule": {
1423 "filename": "lib/events.generated.ts",
1424 "line": 487
1425 },
1426 "name": "cfnProperties",
1427 "overrides": "@aws-cdk/core.CfnResource",
1428 "protected": true,
1429 "type": {
1430 "collection": {
1431 "elementtype": {
1432 "primitive": "any"
1433 },
1434 "kind": "map"
1435 }
1436 }
1437 },
1438 {
1439 "docs": {
1440 "custom": {
1441 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern"
1442 },
1443 "stability": "external",
1444 "summary": "An event pattern to use to filter events sent to the archive."
1445 },
1446 "locationInModule": {
1447 "filename": "lib/events.generated.ts",
1448 "line": 447
1449 },
1450 "name": "eventPattern",
1451 "type": {
1452 "primitive": "any"
1453 }
1454 },
1455 {
1456 "docs": {
1457 "custom": {
1458 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn"
1459 },
1460 "stability": "external",
1461 "summary": "The ARN of the event bus that sends events to the archive."
1462 },
1463 "locationInModule": {
1464 "filename": "lib/events.generated.ts",
1465 "line": 426
1466 },
1467 "name": "sourceArn",
1468 "type": {
1469 "primitive": "string"
1470 }
1471 },
1472 {
1473 "docs": {
1474 "custom": {
1475 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename"
1476 },
1477 "stability": "external",
1478 "summary": "The name for the archive to create."
1479 },
1480 "locationInModule": {
1481 "filename": "lib/events.generated.ts",
1482 "line": 433
1483 },
1484 "name": "archiveName",
1485 "optional": true,
1486 "type": {
1487 "primitive": "string"
1488 }
1489 },
1490 {
1491 "docs": {
1492 "custom": {
1493 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description"
1494 },
1495 "stability": "external",
1496 "summary": "A description for the archive."
1497 },
1498 "locationInModule": {
1499 "filename": "lib/events.generated.ts",
1500 "line": 440
1501 },
1502 "name": "description",
1503 "optional": true,
1504 "type": {
1505 "primitive": "string"
1506 }
1507 },
1508 {
1509 "docs": {
1510 "custom": {
1511 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays"
1512 },
1513 "remarks": "Default value is 0. If set to 0, events are retained indefinitely",
1514 "stability": "external",
1515 "summary": "The number of days to retain events for."
1516 },
1517 "locationInModule": {
1518 "filename": "lib/events.generated.ts",
1519 "line": 454
1520 },
1521 "name": "retentionDays",
1522 "optional": true,
1523 "type": {
1524 "primitive": "number"
1525 }
1526 }
1527 ],
1528 "symbolId": "lib/events.generated:CfnArchive"
1529 },
1530 "@aws-cdk/aws-events.CfnArchiveProps": {
1531 "assembly": "@aws-cdk/aws-events",
1532 "datatype": true,
1533 "docs": {
1534 "custom": {
1535 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html",
1536 "exampleMetadata": "fixture=_generated"
1537 },
1538 "stability": "external",
1539 "summary": "Properties for defining a `CfnArchive`.",
1540 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnArchiveProps: events.CfnArchiveProps = {\n sourceArn: 'sourceArn',\n\n // the properties below are optional\n archiveName: 'archiveName',\n description: 'description',\n eventPattern: eventPattern,\n retentionDays: 123,\n};"
1541 },
1542 "fqn": "@aws-cdk/aws-events.CfnArchiveProps",
1543 "kind": "interface",
1544 "locationInModule": {
1545 "filename": "lib/events.generated.ts",
1546 "line": 278
1547 },
1548 "name": "CfnArchiveProps",
1549 "properties": [
1550 {
1551 "abstract": true,
1552 "docs": {
1553 "custom": {
1554 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-sourcearn"
1555 },
1556 "stability": "external",
1557 "summary": "The ARN of the event bus that sends events to the archive."
1558 },
1559 "immutable": true,
1560 "locationInModule": {
1561 "filename": "lib/events.generated.ts",
1562 "line": 285
1563 },
1564 "name": "sourceArn",
1565 "type": {
1566 "primitive": "string"
1567 }
1568 },
1569 {
1570 "abstract": true,
1571 "docs": {
1572 "custom": {
1573 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-archivename"
1574 },
1575 "stability": "external",
1576 "summary": "The name for the archive to create."
1577 },
1578 "immutable": true,
1579 "locationInModule": {
1580 "filename": "lib/events.generated.ts",
1581 "line": 292
1582 },
1583 "name": "archiveName",
1584 "optional": true,
1585 "type": {
1586 "primitive": "string"
1587 }
1588 },
1589 {
1590 "abstract": true,
1591 "docs": {
1592 "custom": {
1593 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-description"
1594 },
1595 "stability": "external",
1596 "summary": "A description for the archive."
1597 },
1598 "immutable": true,
1599 "locationInModule": {
1600 "filename": "lib/events.generated.ts",
1601 "line": 299
1602 },
1603 "name": "description",
1604 "optional": true,
1605 "type": {
1606 "primitive": "string"
1607 }
1608 },
1609 {
1610 "abstract": true,
1611 "docs": {
1612 "custom": {
1613 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-eventpattern"
1614 },
1615 "stability": "external",
1616 "summary": "An event pattern to use to filter events sent to the archive."
1617 },
1618 "immutable": true,
1619 "locationInModule": {
1620 "filename": "lib/events.generated.ts",
1621 "line": 306
1622 },
1623 "name": "eventPattern",
1624 "optional": true,
1625 "type": {
1626 "primitive": "any"
1627 }
1628 },
1629 {
1630 "abstract": true,
1631 "docs": {
1632 "custom": {
1633 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html#cfn-events-archive-retentiondays"
1634 },
1635 "remarks": "Default value is 0. If set to 0, events are retained indefinitely",
1636 "stability": "external",
1637 "summary": "The number of days to retain events for."
1638 },
1639 "immutable": true,
1640 "locationInModule": {
1641 "filename": "lib/events.generated.ts",
1642 "line": 313
1643 },
1644 "name": "retentionDays",
1645 "optional": true,
1646 "type": {
1647 "primitive": "number"
1648 }
1649 }
1650 ],
1651 "symbolId": "lib/events.generated:CfnArchiveProps"
1652 },
1653 "@aws-cdk/aws-events.CfnConnection": {
1654 "assembly": "@aws-cdk/aws-events",
1655 "base": "@aws-cdk/core.CfnResource",
1656 "docs": {
1657 "custom": {
1658 "cloudformationResource": "AWS::Events::Connection",
1659 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html",
1660 "exampleMetadata": "fixture=_generated"
1661 },
1662 "remarks": "Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.",
1663 "stability": "external",
1664 "summary": "A CloudFormation `AWS::Events::Connection`.",
1665 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnConnection = new events.CfnConnection(this, 'MyCfnConnection', {\n authorizationType: 'authorizationType',\n authParameters: {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n});"
1666 },
1667 "fqn": "@aws-cdk/aws-events.CfnConnection",
1668 "initializer": {
1669 "docs": {
1670 "stability": "external",
1671 "summary": "Create a new `AWS::Events::Connection`."
1672 },
1673 "locationInModule": {
1674 "filename": "lib/events.generated.ts",
1675 "line": 683
1676 },
1677 "parameters": [
1678 {
1679 "docs": {
1680 "summary": "- scope in which this resource is defined."
1681 },
1682 "name": "scope",
1683 "type": {
1684 "fqn": "@aws-cdk/core.Construct"
1685 }
1686 },
1687 {
1688 "docs": {
1689 "summary": "- scoped id of the resource."
1690 },
1691 "name": "id",
1692 "type": {
1693 "primitive": "string"
1694 }
1695 },
1696 {
1697 "docs": {
1698 "summary": "- resource properties."
1699 },
1700 "name": "props",
1701 "type": {
1702 "fqn": "@aws-cdk/aws-events.CfnConnectionProps"
1703 }
1704 }
1705 ]
1706 },
1707 "interfaces": [
1708 "@aws-cdk/core.IInspectable"
1709 ],
1710 "kind": "class",
1711 "locationInModule": {
1712 "filename": "lib/events.generated.ts",
1713 "line": 609
1714 },
1715 "methods": [
1716 {
1717 "docs": {
1718 "stability": "external",
1719 "summary": "Examines the CloudFormation resource and discloses attributes."
1720 },
1721 "locationInModule": {
1722 "filename": "lib/events.generated.ts",
1723 "line": 702
1724 },
1725 "name": "inspect",
1726 "overrides": "@aws-cdk/core.IInspectable",
1727 "parameters": [
1728 {
1729 "docs": {
1730 "summary": "- tree inspector to collect and process attributes."
1731 },
1732 "name": "inspector",
1733 "type": {
1734 "fqn": "@aws-cdk/core.TreeInspector"
1735 }
1736 }
1737 ]
1738 },
1739 {
1740 "docs": {
1741 "stability": "external"
1742 },
1743 "locationInModule": {
1744 "filename": "lib/events.generated.ts",
1745 "line": 716
1746 },
1747 "name": "renderProperties",
1748 "overrides": "@aws-cdk/core.CfnResource",
1749 "parameters": [
1750 {
1751 "name": "props",
1752 "type": {
1753 "collection": {
1754 "elementtype": {
1755 "primitive": "any"
1756 },
1757 "kind": "map"
1758 }
1759 }
1760 }
1761 ],
1762 "protected": true,
1763 "returns": {
1764 "type": {
1765 "collection": {
1766 "elementtype": {
1767 "primitive": "any"
1768 },
1769 "kind": "map"
1770 }
1771 }
1772 }
1773 }
1774 ],
1775 "name": "CfnConnection",
1776 "properties": [
1777 {
1778 "const": true,
1779 "docs": {
1780 "stability": "external",
1781 "summary": "The CloudFormation resource type name for this resource class."
1782 },
1783 "immutable": true,
1784 "locationInModule": {
1785 "filename": "lib/events.generated.ts",
1786 "line": 613
1787 },
1788 "name": "CFN_RESOURCE_TYPE_NAME",
1789 "static": true,
1790 "type": {
1791 "primitive": "string"
1792 }
1793 },
1794 {
1795 "docs": {
1796 "custom": {
1797 "cloudformationAttribute": "Arn"
1798 },
1799 "stability": "external",
1800 "summary": "The ARN of the connection that was created by the request."
1801 },
1802 "immutable": true,
1803 "locationInModule": {
1804 "filename": "lib/events.generated.ts",
1805 "line": 638
1806 },
1807 "name": "attrArn",
1808 "type": {
1809 "primitive": "string"
1810 }
1811 },
1812 {
1813 "docs": {
1814 "custom": {
1815 "cloudformationAttribute": "SecretArn"
1816 },
1817 "stability": "external",
1818 "summary": "The ARN for the secret created for the connection."
1819 },
1820 "immutable": true,
1821 "locationInModule": {
1822 "filename": "lib/events.generated.ts",
1823 "line": 644
1824 },
1825 "name": "attrSecretArn",
1826 "type": {
1827 "primitive": "string"
1828 }
1829 },
1830 {
1831 "docs": {
1832 "stability": "external"
1833 },
1834 "immutable": true,
1835 "locationInModule": {
1836 "filename": "lib/events.generated.ts",
1837 "line": 707
1838 },
1839 "name": "cfnProperties",
1840 "overrides": "@aws-cdk/core.CfnResource",
1841 "protected": true,
1842 "type": {
1843 "collection": {
1844 "elementtype": {
1845 "primitive": "any"
1846 },
1847 "kind": "map"
1848 }
1849 }
1850 },
1851 {
1852 "docs": {
1853 "custom": {
1854 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype"
1855 },
1856 "remarks": "> OAUTH tokens are refreshed when a 401 or 407 response is returned.",
1857 "stability": "external",
1858 "summary": "The type of authorization to use for the connection."
1859 },
1860 "locationInModule": {
1861 "filename": "lib/events.generated.ts",
1862 "line": 653
1863 },
1864 "name": "authorizationType",
1865 "type": {
1866 "primitive": "string"
1867 }
1868 },
1869 {
1870 "docs": {
1871 "custom": {
1872 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters"
1873 },
1874 "stability": "external",
1875 "summary": "A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint."
1876 },
1877 "locationInModule": {
1878 "filename": "lib/events.generated.ts",
1879 "line": 660
1880 },
1881 "name": "authParameters",
1882 "type": {
1883 "union": {
1884 "types": [
1885 {
1886 "fqn": "@aws-cdk/core.IResolvable"
1887 },
1888 {
1889 "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty"
1890 }
1891 ]
1892 }
1893 }
1894 },
1895 {
1896 "docs": {
1897 "custom": {
1898 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description"
1899 },
1900 "stability": "external",
1901 "summary": "A description for the connection to create."
1902 },
1903 "locationInModule": {
1904 "filename": "lib/events.generated.ts",
1905 "line": 667
1906 },
1907 "name": "description",
1908 "optional": true,
1909 "type": {
1910 "primitive": "string"
1911 }
1912 },
1913 {
1914 "docs": {
1915 "custom": {
1916 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name"
1917 },
1918 "stability": "external",
1919 "summary": "The name for the connection to create."
1920 },
1921 "locationInModule": {
1922 "filename": "lib/events.generated.ts",
1923 "line": 674
1924 },
1925 "name": "name",
1926 "optional": true,
1927 "type": {
1928 "primitive": "string"
1929 }
1930 }
1931 ],
1932 "symbolId": "lib/events.generated:CfnConnection"
1933 },
1934 "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty": {
1935 "assembly": "@aws-cdk/aws-events",
1936 "datatype": true,
1937 "docs": {
1938 "custom": {
1939 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html",
1940 "exampleMetadata": "fixture=_generated"
1941 },
1942 "stability": "external",
1943 "summary": "Contains the API key authorization parameters for the connection.",
1944 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst apiKeyAuthParametersProperty: events.CfnConnection.ApiKeyAuthParametersProperty = {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n};"
1945 },
1946 "fqn": "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty",
1947 "kind": "interface",
1948 "locationInModule": {
1949 "filename": "lib/events.generated.ts",
1950 "line": 730
1951 },
1952 "name": "ApiKeyAuthParametersProperty",
1953 "namespace": "CfnConnection",
1954 "properties": [
1955 {
1956 "abstract": true,
1957 "docs": {
1958 "custom": {
1959 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyname"
1960 },
1961 "stability": "external",
1962 "summary": "The name of the API key to use for authorization."
1963 },
1964 "immutable": true,
1965 "locationInModule": {
1966 "filename": "lib/events.generated.ts",
1967 "line": 736
1968 },
1969 "name": "apiKeyName",
1970 "type": {
1971 "primitive": "string"
1972 }
1973 },
1974 {
1975 "abstract": true,
1976 "docs": {
1977 "custom": {
1978 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-apikeyauthparameters.html#cfn-events-connection-apikeyauthparameters-apikeyvalue"
1979 },
1980 "stability": "external",
1981 "summary": "The value for the API key to use for authorization."
1982 },
1983 "immutable": true,
1984 "locationInModule": {
1985 "filename": "lib/events.generated.ts",
1986 "line": 742
1987 },
1988 "name": "apiKeyValue",
1989 "type": {
1990 "primitive": "string"
1991 }
1992 }
1993 ],
1994 "symbolId": "lib/events.generated:CfnConnection.ApiKeyAuthParametersProperty"
1995 },
1996 "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty": {
1997 "assembly": "@aws-cdk/aws-events",
1998 "datatype": true,
1999 "docs": {
2000 "custom": {
2001 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html",
2002 "exampleMetadata": "fixture=_generated"
2003 },
2004 "stability": "external",
2005 "summary": "Contains the authorization parameters to use for the connection.",
2006 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst authParametersProperty: events.CfnConnection.AuthParametersProperty = {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n};"
2007 },
2008 "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty",
2009 "kind": "interface",
2010 "locationInModule": {
2011 "filename": "lib/events.generated.ts",
2012 "line": 808
2013 },
2014 "name": "AuthParametersProperty",
2015 "namespace": "CfnConnection",
2016 "properties": [
2017 {
2018 "abstract": true,
2019 "docs": {
2020 "custom": {
2021 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters"
2022 },
2023 "stability": "external",
2024 "summary": "The API Key parameters to use for authorization."
2025 },
2026 "immutable": true,
2027 "locationInModule": {
2028 "filename": "lib/events.generated.ts",
2029 "line": 814
2030 },
2031 "name": "apiKeyAuthParameters",
2032 "optional": true,
2033 "type": {
2034 "union": {
2035 "types": [
2036 {
2037 "fqn": "@aws-cdk/core.IResolvable"
2038 },
2039 {
2040 "fqn": "@aws-cdk/aws-events.CfnConnection.ApiKeyAuthParametersProperty"
2041 }
2042 ]
2043 }
2044 }
2045 },
2046 {
2047 "abstract": true,
2048 "docs": {
2049 "custom": {
2050 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters"
2051 },
2052 "stability": "external",
2053 "summary": "The authorization parameters for Basic authorization."
2054 },
2055 "immutable": true,
2056 "locationInModule": {
2057 "filename": "lib/events.generated.ts",
2058 "line": 820
2059 },
2060 "name": "basicAuthParameters",
2061 "optional": true,
2062 "type": {
2063 "union": {
2064 "types": [
2065 {
2066 "fqn": "@aws-cdk/core.IResolvable"
2067 },
2068 {
2069 "fqn": "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty"
2070 }
2071 ]
2072 }
2073 }
2074 },
2075 {
2076 "abstract": true,
2077 "docs": {
2078 "custom": {
2079 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters"
2080 },
2081 "stability": "external",
2082 "summary": "Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint."
2083 },
2084 "immutable": true,
2085 "locationInModule": {
2086 "filename": "lib/events.generated.ts",
2087 "line": 826
2088 },
2089 "name": "invocationHttpParameters",
2090 "optional": true,
2091 "type": {
2092 "union": {
2093 "types": [
2094 {
2095 "fqn": "@aws-cdk/core.IResolvable"
2096 },
2097 {
2098 "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty"
2099 }
2100 ]
2101 }
2102 }
2103 },
2104 {
2105 "abstract": true,
2106 "docs": {
2107 "custom": {
2108 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters"
2109 },
2110 "stability": "external",
2111 "summary": "The OAuth parameters to use for authorization."
2112 },
2113 "immutable": true,
2114 "locationInModule": {
2115 "filename": "lib/events.generated.ts",
2116 "line": 832
2117 },
2118 "name": "oAuthParameters",
2119 "optional": true,
2120 "type": {
2121 "union": {
2122 "types": [
2123 {
2124 "fqn": "@aws-cdk/core.IResolvable"
2125 },
2126 {
2127 "fqn": "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty"
2128 }
2129 ]
2130 }
2131 }
2132 }
2133 ],
2134 "symbolId": "lib/events.generated:CfnConnection.AuthParametersProperty"
2135 },
2136 "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty": {
2137 "assembly": "@aws-cdk/aws-events",
2138 "datatype": true,
2139 "docs": {
2140 "custom": {
2141 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html",
2142 "exampleMetadata": "fixture=_generated"
2143 },
2144 "stability": "external",
2145 "summary": "Contains the Basic authorization parameters for the connection.",
2146 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst basicAuthParametersProperty: events.CfnConnection.BasicAuthParametersProperty = {\n password: 'password',\n username: 'username',\n};"
2147 },
2148 "fqn": "@aws-cdk/aws-events.CfnConnection.BasicAuthParametersProperty",
2149 "kind": "interface",
2150 "locationInModule": {
2151 "filename": "lib/events.generated.ts",
2152 "line": 902
2153 },
2154 "name": "BasicAuthParametersProperty",
2155 "namespace": "CfnConnection",
2156 "properties": [
2157 {
2158 "abstract": true,
2159 "docs": {
2160 "custom": {
2161 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-password"
2162 },
2163 "stability": "external",
2164 "summary": "The password associated with the user name to use for Basic authorization."
2165 },
2166 "immutable": true,
2167 "locationInModule": {
2168 "filename": "lib/events.generated.ts",
2169 "line": 908
2170 },
2171 "name": "password",
2172 "type": {
2173 "primitive": "string"
2174 }
2175 },
2176 {
2177 "abstract": true,
2178 "docs": {
2179 "custom": {
2180 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-basicauthparameters.html#cfn-events-connection-basicauthparameters-username"
2181 },
2182 "stability": "external",
2183 "summary": "The user name to use for Basic authorization."
2184 },
2185 "immutable": true,
2186 "locationInModule": {
2187 "filename": "lib/events.generated.ts",
2188 "line": 914
2189 },
2190 "name": "username",
2191 "type": {
2192 "primitive": "string"
2193 }
2194 }
2195 ],
2196 "symbolId": "lib/events.generated:CfnConnection.BasicAuthParametersProperty"
2197 },
2198 "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty": {
2199 "assembly": "@aws-cdk/aws-events",
2200 "datatype": true,
2201 "docs": {
2202 "custom": {
2203 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html",
2204 "exampleMetadata": "fixture=_generated"
2205 },
2206 "stability": "external",
2207 "summary": "Contains the OAuth authorization parameters to use for the connection.",
2208 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst clientParametersProperty: events.CfnConnection.ClientParametersProperty = {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n};"
2209 },
2210 "fqn": "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty",
2211 "kind": "interface",
2212 "locationInModule": {
2213 "filename": "lib/events.generated.ts",
2214 "line": 980
2215 },
2216 "name": "ClientParametersProperty",
2217 "namespace": "CfnConnection",
2218 "properties": [
2219 {
2220 "abstract": true,
2221 "docs": {
2222 "custom": {
2223 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientid"
2224 },
2225 "stability": "external",
2226 "summary": "The client ID to use for OAuth authorization."
2227 },
2228 "immutable": true,
2229 "locationInModule": {
2230 "filename": "lib/events.generated.ts",
2231 "line": 986
2232 },
2233 "name": "clientId",
2234 "type": {
2235 "primitive": "string"
2236 }
2237 },
2238 {
2239 "abstract": true,
2240 "docs": {
2241 "custom": {
2242 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-clientparameters.html#cfn-events-connection-clientparameters-clientsecret"
2243 },
2244 "stability": "external",
2245 "summary": "The client secret assciated with the client ID to use for OAuth authorization."
2246 },
2247 "immutable": true,
2248 "locationInModule": {
2249 "filename": "lib/events.generated.ts",
2250 "line": 992
2251 },
2252 "name": "clientSecret",
2253 "type": {
2254 "primitive": "string"
2255 }
2256 }
2257 ],
2258 "symbolId": "lib/events.generated:CfnConnection.ClientParametersProperty"
2259 },
2260 "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty": {
2261 "assembly": "@aws-cdk/aws-events",
2262 "datatype": true,
2263 "docs": {
2264 "custom": {
2265 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html",
2266 "exampleMetadata": "fixture=_generated"
2267 },
2268 "stability": "external",
2269 "summary": "Contains additional parameters for the connection.",
2270 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst connectionHttpParametersProperty: events.CfnConnection.ConnectionHttpParametersProperty = {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n};"
2271 },
2272 "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty",
2273 "kind": "interface",
2274 "locationInModule": {
2275 "filename": "lib/events.generated.ts",
2276 "line": 1058
2277 },
2278 "name": "ConnectionHttpParametersProperty",
2279 "namespace": "CfnConnection",
2280 "properties": [
2281 {
2282 "abstract": true,
2283 "docs": {
2284 "custom": {
2285 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-bodyparameters"
2286 },
2287 "stability": "external",
2288 "summary": "Contains additional body string parameters for the connection."
2289 },
2290 "immutable": true,
2291 "locationInModule": {
2292 "filename": "lib/events.generated.ts",
2293 "line": 1064
2294 },
2295 "name": "bodyParameters",
2296 "optional": true,
2297 "type": {
2298 "union": {
2299 "types": [
2300 {
2301 "fqn": "@aws-cdk/core.IResolvable"
2302 },
2303 {
2304 "collection": {
2305 "elementtype": {
2306 "union": {
2307 "types": [
2308 {
2309 "fqn": "@aws-cdk/core.IResolvable"
2310 },
2311 {
2312 "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty"
2313 }
2314 ]
2315 }
2316 },
2317 "kind": "array"
2318 }
2319 }
2320 ]
2321 }
2322 }
2323 },
2324 {
2325 "abstract": true,
2326 "docs": {
2327 "custom": {
2328 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-headerparameters"
2329 },
2330 "stability": "external",
2331 "summary": "Contains additional header parameters for the connection."
2332 },
2333 "immutable": true,
2334 "locationInModule": {
2335 "filename": "lib/events.generated.ts",
2336 "line": 1070
2337 },
2338 "name": "headerParameters",
2339 "optional": true,
2340 "type": {
2341 "union": {
2342 "types": [
2343 {
2344 "fqn": "@aws-cdk/core.IResolvable"
2345 },
2346 {
2347 "collection": {
2348 "elementtype": {
2349 "union": {
2350 "types": [
2351 {
2352 "fqn": "@aws-cdk/core.IResolvable"
2353 },
2354 {
2355 "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty"
2356 }
2357 ]
2358 }
2359 },
2360 "kind": "array"
2361 }
2362 }
2363 ]
2364 }
2365 }
2366 },
2367 {
2368 "abstract": true,
2369 "docs": {
2370 "custom": {
2371 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-connectionhttpparameters.html#cfn-events-connection-connectionhttpparameters-querystringparameters"
2372 },
2373 "stability": "external",
2374 "summary": "Contains additional query string parameters for the connection."
2375 },
2376 "immutable": true,
2377 "locationInModule": {
2378 "filename": "lib/events.generated.ts",
2379 "line": 1076
2380 },
2381 "name": "queryStringParameters",
2382 "optional": true,
2383 "type": {
2384 "union": {
2385 "types": [
2386 {
2387 "fqn": "@aws-cdk/core.IResolvable"
2388 },
2389 {
2390 "collection": {
2391 "elementtype": {
2392 "union": {
2393 "types": [
2394 {
2395 "fqn": "@aws-cdk/core.IResolvable"
2396 },
2397 {
2398 "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty"
2399 }
2400 ]
2401 }
2402 },
2403 "kind": "array"
2404 }
2405 }
2406 ]
2407 }
2408 }
2409 }
2410 ],
2411 "symbolId": "lib/events.generated:CfnConnection.ConnectionHttpParametersProperty"
2412 },
2413 "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty": {
2414 "assembly": "@aws-cdk/aws-events",
2415 "datatype": true,
2416 "docs": {
2417 "custom": {
2418 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html",
2419 "exampleMetadata": "fixture=_generated"
2420 },
2421 "stability": "external",
2422 "summary": "Contains the OAuth authorization parameters to use for the connection.",
2423 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst oAuthParametersProperty: events.CfnConnection.OAuthParametersProperty = {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n};"
2424 },
2425 "fqn": "@aws-cdk/aws-events.CfnConnection.OAuthParametersProperty",
2426 "kind": "interface",
2427 "locationInModule": {
2428 "filename": "lib/events.generated.ts",
2429 "line": 1143
2430 },
2431 "name": "OAuthParametersProperty",
2432 "namespace": "CfnConnection",
2433 "properties": [
2434 {
2435 "abstract": true,
2436 "docs": {
2437 "custom": {
2438 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-authorizationendpoint"
2439 },
2440 "stability": "external",
2441 "summary": "The URL to the authorization endpoint when OAuth is specified as the authorization type."
2442 },
2443 "immutable": true,
2444 "locationInModule": {
2445 "filename": "lib/events.generated.ts",
2446 "line": 1149
2447 },
2448 "name": "authorizationEndpoint",
2449 "type": {
2450 "primitive": "string"
2451 }
2452 },
2453 {
2454 "abstract": true,
2455 "docs": {
2456 "custom": {
2457 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-clientparameters"
2458 },
2459 "stability": "external",
2460 "summary": "A `CreateConnectionOAuthClientRequestParameters` object that contains the client parameters for OAuth authorization."
2461 },
2462 "immutable": true,
2463 "locationInModule": {
2464 "filename": "lib/events.generated.ts",
2465 "line": 1155
2466 },
2467 "name": "clientParameters",
2468 "type": {
2469 "union": {
2470 "types": [
2471 {
2472 "fqn": "@aws-cdk/core.IResolvable"
2473 },
2474 {
2475 "fqn": "@aws-cdk/aws-events.CfnConnection.ClientParametersProperty"
2476 }
2477 ]
2478 }
2479 }
2480 },
2481 {
2482 "abstract": true,
2483 "docs": {
2484 "custom": {
2485 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-httpmethod"
2486 },
2487 "stability": "external",
2488 "summary": "The method to use for the authorization request."
2489 },
2490 "immutable": true,
2491 "locationInModule": {
2492 "filename": "lib/events.generated.ts",
2493 "line": 1161
2494 },
2495 "name": "httpMethod",
2496 "type": {
2497 "primitive": "string"
2498 }
2499 },
2500 {
2501 "abstract": true,
2502 "docs": {
2503 "custom": {
2504 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-oauthparameters.html#cfn-events-connection-oauthparameters-oauthhttpparameters"
2505 },
2506 "stability": "external",
2507 "summary": "A `ConnectionHttpParameters` object that contains details about the additional parameters to use for the connection."
2508 },
2509 "immutable": true,
2510 "locationInModule": {
2511 "filename": "lib/events.generated.ts",
2512 "line": 1167
2513 },
2514 "name": "oAuthHttpParameters",
2515 "optional": true,
2516 "type": {
2517 "union": {
2518 "types": [
2519 {
2520 "fqn": "@aws-cdk/core.IResolvable"
2521 },
2522 {
2523 "fqn": "@aws-cdk/aws-events.CfnConnection.ConnectionHttpParametersProperty"
2524 }
2525 ]
2526 }
2527 }
2528 }
2529 ],
2530 "symbolId": "lib/events.generated:CfnConnection.OAuthParametersProperty"
2531 },
2532 "@aws-cdk/aws-events.CfnConnection.ParameterProperty": {
2533 "assembly": "@aws-cdk/aws-events",
2534 "datatype": true,
2535 "docs": {
2536 "custom": {
2537 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html",
2538 "exampleMetadata": "fixture=_generated"
2539 },
2540 "remarks": "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.",
2541 "stability": "external",
2542 "summary": "Additional query string parameter for the connection.",
2543 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst parameterProperty: events.CfnConnection.ParameterProperty = {\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n};"
2544 },
2545 "fqn": "@aws-cdk/aws-events.CfnConnection.ParameterProperty",
2546 "kind": "interface",
2547 "locationInModule": {
2548 "filename": "lib/events.generated.ts",
2549 "line": 1240
2550 },
2551 "name": "ParameterProperty",
2552 "namespace": "CfnConnection",
2553 "properties": [
2554 {
2555 "abstract": true,
2556 "docs": {
2557 "custom": {
2558 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-key"
2559 },
2560 "stability": "external",
2561 "summary": "The key for a query string parameter."
2562 },
2563 "immutable": true,
2564 "locationInModule": {
2565 "filename": "lib/events.generated.ts",
2566 "line": 1252
2567 },
2568 "name": "key",
2569 "type": {
2570 "primitive": "string"
2571 }
2572 },
2573 {
2574 "abstract": true,
2575 "docs": {
2576 "custom": {
2577 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-value"
2578 },
2579 "stability": "external",
2580 "summary": "The value associated with the key for the query string parameter."
2581 },
2582 "immutable": true,
2583 "locationInModule": {
2584 "filename": "lib/events.generated.ts",
2585 "line": 1258
2586 },
2587 "name": "value",
2588 "type": {
2589 "primitive": "string"
2590 }
2591 },
2592 {
2593 "abstract": true,
2594 "docs": {
2595 "custom": {
2596 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-parameter.html#cfn-events-connection-parameter-isvaluesecret"
2597 },
2598 "stability": "external",
2599 "summary": "Specifies whether the value is secret."
2600 },
2601 "immutable": true,
2602 "locationInModule": {
2603 "filename": "lib/events.generated.ts",
2604 "line": 1246
2605 },
2606 "name": "isValueSecret",
2607 "optional": true,
2608 "type": {
2609 "union": {
2610 "types": [
2611 {
2612 "primitive": "boolean"
2613 },
2614 {
2615 "fqn": "@aws-cdk/core.IResolvable"
2616 }
2617 ]
2618 }
2619 }
2620 }
2621 ],
2622 "symbolId": "lib/events.generated:CfnConnection.ParameterProperty"
2623 },
2624 "@aws-cdk/aws-events.CfnConnectionProps": {
2625 "assembly": "@aws-cdk/aws-events",
2626 "datatype": true,
2627 "docs": {
2628 "custom": {
2629 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html",
2630 "exampleMetadata": "fixture=_generated"
2631 },
2632 "stability": "external",
2633 "summary": "Properties for defining a `CfnConnection`.",
2634 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnConnectionProps: events.CfnConnectionProps = {\n authorizationType: 'authorizationType',\n authParameters: {\n apiKeyAuthParameters: {\n apiKeyName: 'apiKeyName',\n apiKeyValue: 'apiKeyValue',\n },\n basicAuthParameters: {\n password: 'password',\n username: 'username',\n },\n invocationHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n oAuthParameters: {\n authorizationEndpoint: 'authorizationEndpoint',\n clientParameters: {\n clientId: 'clientId',\n clientSecret: 'clientSecret',\n },\n httpMethod: 'httpMethod',\n\n // the properties below are optional\n oAuthHttpParameters: {\n bodyParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n headerParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n queryStringParameters: [{\n key: 'key',\n value: 'value',\n\n // the properties below are optional\n isValueSecret: false,\n }],\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n};"
2635 },
2636 "fqn": "@aws-cdk/aws-events.CfnConnectionProps",
2637 "kind": "interface",
2638 "locationInModule": {
2639 "filename": "lib/events.generated.ts",
2640 "line": 510
2641 },
2642 "name": "CfnConnectionProps",
2643 "properties": [
2644 {
2645 "abstract": true,
2646 "docs": {
2647 "custom": {
2648 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype"
2649 },
2650 "remarks": "> OAUTH tokens are refreshed when a 401 or 407 response is returned.",
2651 "stability": "external",
2652 "summary": "The type of authorization to use for the connection."
2653 },
2654 "immutable": true,
2655 "locationInModule": {
2656 "filename": "lib/events.generated.ts",
2657 "line": 519
2658 },
2659 "name": "authorizationType",
2660 "type": {
2661 "primitive": "string"
2662 }
2663 },
2664 {
2665 "abstract": true,
2666 "docs": {
2667 "custom": {
2668 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters"
2669 },
2670 "stability": "external",
2671 "summary": "A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint."
2672 },
2673 "immutable": true,
2674 "locationInModule": {
2675 "filename": "lib/events.generated.ts",
2676 "line": 526
2677 },
2678 "name": "authParameters",
2679 "type": {
2680 "union": {
2681 "types": [
2682 {
2683 "fqn": "@aws-cdk/core.IResolvable"
2684 },
2685 {
2686 "fqn": "@aws-cdk/aws-events.CfnConnection.AuthParametersProperty"
2687 }
2688 ]
2689 }
2690 }
2691 },
2692 {
2693 "abstract": true,
2694 "docs": {
2695 "custom": {
2696 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description"
2697 },
2698 "stability": "external",
2699 "summary": "A description for the connection to create."
2700 },
2701 "immutable": true,
2702 "locationInModule": {
2703 "filename": "lib/events.generated.ts",
2704 "line": 533
2705 },
2706 "name": "description",
2707 "optional": true,
2708 "type": {
2709 "primitive": "string"
2710 }
2711 },
2712 {
2713 "abstract": true,
2714 "docs": {
2715 "custom": {
2716 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name"
2717 },
2718 "stability": "external",
2719 "summary": "The name for the connection to create."
2720 },
2721 "immutable": true,
2722 "locationInModule": {
2723 "filename": "lib/events.generated.ts",
2724 "line": 540
2725 },
2726 "name": "name",
2727 "optional": true,
2728 "type": {
2729 "primitive": "string"
2730 }
2731 }
2732 ],
2733 "symbolId": "lib/events.generated:CfnConnectionProps"
2734 },
2735 "@aws-cdk/aws-events.CfnEndpoint": {
2736 "assembly": "@aws-cdk/aws-events",
2737 "base": "@aws-cdk/core.CfnResource",
2738 "docs": {
2739 "custom": {
2740 "cloudformationResource": "AWS::Events::Endpoint",
2741 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html",
2742 "exampleMetadata": "fixture=_generated"
2743 },
2744 "remarks": "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.",
2745 "stability": "external",
2746 "summary": "A CloudFormation `AWS::Events::Endpoint`.",
2747 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEndpoint = new events.CfnEndpoint(this, 'MyCfnEndpoint', {\n eventBuses: [{\n eventBusArn: 'eventBusArn',\n }],\n name: 'name',\n routingConfig: {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n replicationConfig: {\n state: 'state',\n },\n roleArn: 'roleArn',\n});"
2748 },
2749 "fqn": "@aws-cdk/aws-events.CfnEndpoint",
2750 "initializer": {
2751 "docs": {
2752 "stability": "external",
2753 "summary": "Create a new `AWS::Events::Endpoint`."
2754 },
2755 "locationInModule": {
2756 "filename": "lib/events.generated.ts",
2757 "line": 1552
2758 },
2759 "parameters": [
2760 {
2761 "docs": {
2762 "summary": "- scope in which this resource is defined."
2763 },
2764 "name": "scope",
2765 "type": {
2766 "fqn": "@aws-cdk/core.Construct"
2767 }
2768 },
2769 {
2770 "docs": {
2771 "summary": "- scoped id of the resource."
2772 },
2773 "name": "id",
2774 "type": {
2775 "primitive": "string"
2776 }
2777 },
2778 {
2779 "docs": {
2780 "summary": "- resource properties."
2781 },
2782 "name": "props",
2783 "type": {
2784 "fqn": "@aws-cdk/aws-events.CfnEndpointProps"
2785 }
2786 }
2787 ]
2788 },
2789 "interfaces": [
2790 "@aws-cdk/core.IInspectable"
2791 ],
2792 "kind": "class",
2793 "locationInModule": {
2794 "filename": "lib/events.generated.ts",
2795 "line": 1446
2796 },
2797 "methods": [
2798 {
2799 "docs": {
2800 "stability": "external",
2801 "summary": "Examines the CloudFormation resource and discloses attributes."
2802 },
2803 "locationInModule": {
2804 "filename": "lib/events.generated.ts",
2805 "line": 1577
2806 },
2807 "name": "inspect",
2808 "overrides": "@aws-cdk/core.IInspectable",
2809 "parameters": [
2810 {
2811 "docs": {
2812 "summary": "- tree inspector to collect and process attributes."
2813 },
2814 "name": "inspector",
2815 "type": {
2816 "fqn": "@aws-cdk/core.TreeInspector"
2817 }
2818 }
2819 ]
2820 },
2821 {
2822 "docs": {
2823 "stability": "external"
2824 },
2825 "locationInModule": {
2826 "filename": "lib/events.generated.ts",
2827 "line": 1593
2828 },
2829 "name": "renderProperties",
2830 "overrides": "@aws-cdk/core.CfnResource",
2831 "parameters": [
2832 {
2833 "name": "props",
2834 "type": {
2835 "collection": {
2836 "elementtype": {
2837 "primitive": "any"
2838 },
2839 "kind": "map"
2840 }
2841 }
2842 }
2843 ],
2844 "protected": true,
2845 "returns": {
2846 "type": {
2847 "collection": {
2848 "elementtype": {
2849 "primitive": "any"
2850 },
2851 "kind": "map"
2852 }
2853 }
2854 }
2855 }
2856 ],
2857 "name": "CfnEndpoint",
2858 "properties": [
2859 {
2860 "const": true,
2861 "docs": {
2862 "stability": "external",
2863 "summary": "The CloudFormation resource type name for this resource class."
2864 },
2865 "immutable": true,
2866 "locationInModule": {
2867 "filename": "lib/events.generated.ts",
2868 "line": 1450
2869 },
2870 "name": "CFN_RESOURCE_TYPE_NAME",
2871 "static": true,
2872 "type": {
2873 "primitive": "string"
2874 }
2875 },
2876 {
2877 "docs": {
2878 "custom": {
2879 "cloudformationAttribute": "Arn"
2880 },
2881 "stability": "external",
2882 "summary": "The ARN of the endpoint."
2883 },
2884 "immutable": true,
2885 "locationInModule": {
2886 "filename": "lib/events.generated.ts",
2887 "line": 1475
2888 },
2889 "name": "attrArn",
2890 "type": {
2891 "primitive": "string"
2892 }
2893 },
2894 {
2895 "docs": {
2896 "custom": {
2897 "cloudformationAttribute": "EndpointId"
2898 },
2899 "stability": "external",
2900 "summary": "The ID of the endpoint."
2901 },
2902 "immutable": true,
2903 "locationInModule": {
2904 "filename": "lib/events.generated.ts",
2905 "line": 1481
2906 },
2907 "name": "attrEndpointId",
2908 "type": {
2909 "primitive": "string"
2910 }
2911 },
2912 {
2913 "docs": {
2914 "custom": {
2915 "cloudformationAttribute": "EndpointUrl"
2916 },
2917 "stability": "external",
2918 "summary": "The URL of the endpoint."
2919 },
2920 "immutable": true,
2921 "locationInModule": {
2922 "filename": "lib/events.generated.ts",
2923 "line": 1487
2924 },
2925 "name": "attrEndpointUrl",
2926 "type": {
2927 "primitive": "string"
2928 }
2929 },
2930 {
2931 "docs": {
2932 "custom": {
2933 "cloudformationAttribute": "State"
2934 },
2935 "stability": "external",
2936 "summary": "The current state of the endpoint."
2937 },
2938 "immutable": true,
2939 "locationInModule": {
2940 "filename": "lib/events.generated.ts",
2941 "line": 1493
2942 },
2943 "name": "attrState",
2944 "type": {
2945 "primitive": "string"
2946 }
2947 },
2948 {
2949 "docs": {
2950 "custom": {
2951 "cloudformationAttribute": "StateReason"
2952 },
2953 "stability": "external",
2954 "summary": "The reason the endpoint is in its current state."
2955 },
2956 "immutable": true,
2957 "locationInModule": {
2958 "filename": "lib/events.generated.ts",
2959 "line": 1499
2960 },
2961 "name": "attrStateReason",
2962 "type": {
2963 "primitive": "string"
2964 }
2965 },
2966 {
2967 "docs": {
2968 "stability": "external"
2969 },
2970 "immutable": true,
2971 "locationInModule": {
2972 "filename": "lib/events.generated.ts",
2973 "line": 1582
2974 },
2975 "name": "cfnProperties",
2976 "overrides": "@aws-cdk/core.CfnResource",
2977 "protected": true,
2978 "type": {
2979 "collection": {
2980 "elementtype": {
2981 "primitive": "any"
2982 },
2983 "kind": "map"
2984 }
2985 }
2986 },
2987 {
2988 "docs": {
2989 "custom": {
2990 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses"
2991 },
2992 "remarks": "*Exactly* : `2`",
2993 "stability": "external",
2994 "summary": "The event buses being used by the endpoint."
2995 },
2996 "locationInModule": {
2997 "filename": "lib/events.generated.ts",
2998 "line": 1508
2999 },
3000 "name": "eventBuses",
3001 "type": {
3002 "union": {
3003 "types": [
3004 {
3005 "fqn": "@aws-cdk/core.IResolvable"
3006 },
3007 {
3008 "collection": {
3009 "elementtype": {
3010 "union": {
3011 "types": [
3012 {
3013 "fqn": "@aws-cdk/core.IResolvable"
3014 },
3015 {
3016 "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty"
3017 }
3018 ]
3019 }
3020 },
3021 "kind": "array"
3022 }
3023 }
3024 ]
3025 }
3026 }
3027 },
3028 {
3029 "docs": {
3030 "custom": {
3031 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name"
3032 },
3033 "stability": "external",
3034 "summary": "The name of the endpoint."
3035 },
3036 "locationInModule": {
3037 "filename": "lib/events.generated.ts",
3038 "line": 1515
3039 },
3040 "name": "name",
3041 "type": {
3042 "primitive": "string"
3043 }
3044 },
3045 {
3046 "docs": {
3047 "custom": {
3048 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig"
3049 },
3050 "stability": "external",
3051 "summary": "The routing configuration of the endpoint."
3052 },
3053 "locationInModule": {
3054 "filename": "lib/events.generated.ts",
3055 "line": 1522
3056 },
3057 "name": "routingConfig",
3058 "type": {
3059 "union": {
3060 "types": [
3061 {
3062 "fqn": "@aws-cdk/core.IResolvable"
3063 },
3064 {
3065 "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty"
3066 }
3067 ]
3068 }
3069 }
3070 },
3071 {
3072 "docs": {
3073 "custom": {
3074 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description"
3075 },
3076 "stability": "external",
3077 "summary": "A description for the endpoint."
3078 },
3079 "locationInModule": {
3080 "filename": "lib/events.generated.ts",
3081 "line": 1529
3082 },
3083 "name": "description",
3084 "optional": true,
3085 "type": {
3086 "primitive": "string"
3087 }
3088 },
3089 {
3090 "docs": {
3091 "custom": {
3092 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig"
3093 },
3094 "stability": "external",
3095 "summary": "Whether event replication was enabled or disabled for this endpoint."
3096 },
3097 "locationInModule": {
3098 "filename": "lib/events.generated.ts",
3099 "line": 1536
3100 },
3101 "name": "replicationConfig",
3102 "optional": true,
3103 "type": {
3104 "union": {
3105 "types": [
3106 {
3107 "fqn": "@aws-cdk/core.IResolvable"
3108 },
3109 {
3110 "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty"
3111 }
3112 ]
3113 }
3114 }
3115 },
3116 {
3117 "docs": {
3118 "custom": {
3119 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn"
3120 },
3121 "stability": "external",
3122 "summary": "The ARN of the role used by event replication for the endpoint."
3123 },
3124 "locationInModule": {
3125 "filename": "lib/events.generated.ts",
3126 "line": 1543
3127 },
3128 "name": "roleArn",
3129 "optional": true,
3130 "type": {
3131 "primitive": "string"
3132 }
3133 }
3134 ],
3135 "symbolId": "lib/events.generated:CfnEndpoint"
3136 },
3137 "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty": {
3138 "assembly": "@aws-cdk/aws-events",
3139 "datatype": true,
3140 "docs": {
3141 "custom": {
3142 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html",
3143 "exampleMetadata": "fixture=_generated"
3144 },
3145 "stability": "external",
3146 "summary": "The event buses the endpoint is associated with.",
3147 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst endpointEventBusProperty: events.CfnEndpoint.EndpointEventBusProperty = {\n eventBusArn: 'eventBusArn',\n};"
3148 },
3149 "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty",
3150 "kind": "interface",
3151 "locationInModule": {
3152 "filename": "lib/events.generated.ts",
3153 "line": 1607
3154 },
3155 "name": "EndpointEventBusProperty",
3156 "namespace": "CfnEndpoint",
3157 "properties": [
3158 {
3159 "abstract": true,
3160 "docs": {
3161 "custom": {
3162 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-endpointeventbus.html#cfn-events-endpoint-endpointeventbus-eventbusarn"
3163 },
3164 "stability": "external",
3165 "summary": "The ARN of the event bus the endpoint is associated with."
3166 },
3167 "immutable": true,
3168 "locationInModule": {
3169 "filename": "lib/events.generated.ts",
3170 "line": 1613
3171 },
3172 "name": "eventBusArn",
3173 "type": {
3174 "primitive": "string"
3175 }
3176 }
3177 ],
3178 "symbolId": "lib/events.generated:CfnEndpoint.EndpointEventBusProperty"
3179 },
3180 "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty": {
3181 "assembly": "@aws-cdk/aws-events",
3182 "datatype": true,
3183 "docs": {
3184 "custom": {
3185 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html",
3186 "exampleMetadata": "fixture=_generated"
3187 },
3188 "remarks": "This includes what triggers failover and what happens when it's triggered.",
3189 "stability": "external",
3190 "summary": "The failover configuration for an endpoint.",
3191 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst failoverConfigProperty: events.CfnEndpoint.FailoverConfigProperty = {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n};"
3192 },
3193 "fqn": "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty",
3194 "kind": "interface",
3195 "locationInModule": {
3196 "filename": "lib/events.generated.ts",
3197 "line": 1675
3198 },
3199 "name": "FailoverConfigProperty",
3200 "namespace": "CfnEndpoint",
3201 "properties": [
3202 {
3203 "abstract": true,
3204 "docs": {
3205 "custom": {
3206 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-primary"
3207 },
3208 "stability": "external",
3209 "summary": "The main Region of the endpoint."
3210 },
3211 "immutable": true,
3212 "locationInModule": {
3213 "filename": "lib/events.generated.ts",
3214 "line": 1681
3215 },
3216 "name": "primary",
3217 "type": {
3218 "union": {
3219 "types": [
3220 {
3221 "fqn": "@aws-cdk/core.IResolvable"
3222 },
3223 {
3224 "fqn": "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty"
3225 }
3226 ]
3227 }
3228 }
3229 },
3230 {
3231 "abstract": true,
3232 "docs": {
3233 "custom": {
3234 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-failoverconfig.html#cfn-events-endpoint-failoverconfig-secondary"
3235 },
3236 "stability": "external",
3237 "summary": "The Region that events are routed to when failover is triggered or event replication is enabled."
3238 },
3239 "immutable": true,
3240 "locationInModule": {
3241 "filename": "lib/events.generated.ts",
3242 "line": 1687
3243 },
3244 "name": "secondary",
3245 "type": {
3246 "union": {
3247 "types": [
3248 {
3249 "fqn": "@aws-cdk/core.IResolvable"
3250 },
3251 {
3252 "fqn": "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty"
3253 }
3254 ]
3255 }
3256 }
3257 }
3258 ],
3259 "symbolId": "lib/events.generated:CfnEndpoint.FailoverConfigProperty"
3260 },
3261 "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty": {
3262 "assembly": "@aws-cdk/aws-events",
3263 "datatype": true,
3264 "docs": {
3265 "custom": {
3266 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html",
3267 "exampleMetadata": "fixture=_generated"
3268 },
3269 "stability": "external",
3270 "summary": "The primary Region of the endpoint.",
3271 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst primaryProperty: events.CfnEndpoint.PrimaryProperty = {\n healthCheck: 'healthCheck',\n};"
3272 },
3273 "fqn": "@aws-cdk/aws-events.CfnEndpoint.PrimaryProperty",
3274 "kind": "interface",
3275 "locationInModule": {
3276 "filename": "lib/events.generated.ts",
3277 "line": 1753
3278 },
3279 "name": "PrimaryProperty",
3280 "namespace": "CfnEndpoint",
3281 "properties": [
3282 {
3283 "abstract": true,
3284 "docs": {
3285 "custom": {
3286 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-primary.html#cfn-events-endpoint-primary-healthcheck"
3287 },
3288 "stability": "external",
3289 "summary": "The ARN of the health check used by the endpoint to determine whether failover is triggered."
3290 },
3291 "immutable": true,
3292 "locationInModule": {
3293 "filename": "lib/events.generated.ts",
3294 "line": 1759
3295 },
3296 "name": "healthCheck",
3297 "type": {
3298 "primitive": "string"
3299 }
3300 }
3301 ],
3302 "symbolId": "lib/events.generated:CfnEndpoint.PrimaryProperty"
3303 },
3304 "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty": {
3305 "assembly": "@aws-cdk/aws-events",
3306 "datatype": true,
3307 "docs": {
3308 "custom": {
3309 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html",
3310 "exampleMetadata": "fixture=_generated"
3311 },
3312 "stability": "external",
3313 "summary": "Endpoints can replicate all events to the secondary Region.",
3314 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst replicationConfigProperty: events.CfnEndpoint.ReplicationConfigProperty = {\n state: 'state',\n};"
3315 },
3316 "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty",
3317 "kind": "interface",
3318 "locationInModule": {
3319 "filename": "lib/events.generated.ts",
3320 "line": 1821
3321 },
3322 "name": "ReplicationConfigProperty",
3323 "namespace": "CfnEndpoint",
3324 "properties": [
3325 {
3326 "abstract": true,
3327 "docs": {
3328 "custom": {
3329 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-replicationconfig.html#cfn-events-endpoint-replicationconfig-state"
3330 },
3331 "stability": "external",
3332 "summary": "The state of event replication."
3333 },
3334 "immutable": true,
3335 "locationInModule": {
3336 "filename": "lib/events.generated.ts",
3337 "line": 1827
3338 },
3339 "name": "state",
3340 "type": {
3341 "primitive": "string"
3342 }
3343 }
3344 ],
3345 "symbolId": "lib/events.generated:CfnEndpoint.ReplicationConfigProperty"
3346 },
3347 "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty": {
3348 "assembly": "@aws-cdk/aws-events",
3349 "datatype": true,
3350 "docs": {
3351 "custom": {
3352 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html",
3353 "exampleMetadata": "fixture=_generated"
3354 },
3355 "stability": "external",
3356 "summary": "The routing configuration of the endpoint.",
3357 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst routingConfigProperty: events.CfnEndpoint.RoutingConfigProperty = {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n};"
3358 },
3359 "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty",
3360 "kind": "interface",
3361 "locationInModule": {
3362 "filename": "lib/events.generated.ts",
3363 "line": 1889
3364 },
3365 "name": "RoutingConfigProperty",
3366 "namespace": "CfnEndpoint",
3367 "properties": [
3368 {
3369 "abstract": true,
3370 "docs": {
3371 "custom": {
3372 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-routingconfig.html#cfn-events-endpoint-routingconfig-failoverconfig"
3373 },
3374 "remarks": "This includes what triggers failover and what happens when it's triggered.",
3375 "stability": "external",
3376 "summary": "The failover configuration for an endpoint."
3377 },
3378 "immutable": true,
3379 "locationInModule": {
3380 "filename": "lib/events.generated.ts",
3381 "line": 1895
3382 },
3383 "name": "failoverConfig",
3384 "type": {
3385 "union": {
3386 "types": [
3387 {
3388 "fqn": "@aws-cdk/core.IResolvable"
3389 },
3390 {
3391 "fqn": "@aws-cdk/aws-events.CfnEndpoint.FailoverConfigProperty"
3392 }
3393 ]
3394 }
3395 }
3396 }
3397 ],
3398 "symbolId": "lib/events.generated:CfnEndpoint.RoutingConfigProperty"
3399 },
3400 "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty": {
3401 "assembly": "@aws-cdk/aws-events",
3402 "datatype": true,
3403 "docs": {
3404 "custom": {
3405 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html",
3406 "exampleMetadata": "fixture=_generated"
3407 },
3408 "stability": "external",
3409 "summary": "The secondary Region that processes events when failover is triggered or replication is enabled.",
3410 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst secondaryProperty: events.CfnEndpoint.SecondaryProperty = {\n route: 'route',\n};"
3411 },
3412 "fqn": "@aws-cdk/aws-events.CfnEndpoint.SecondaryProperty",
3413 "kind": "interface",
3414 "locationInModule": {
3415 "filename": "lib/events.generated.ts",
3416 "line": 1957
3417 },
3418 "name": "SecondaryProperty",
3419 "namespace": "CfnEndpoint",
3420 "properties": [
3421 {
3422 "abstract": true,
3423 "docs": {
3424 "custom": {
3425 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-endpoint-secondary.html#cfn-events-endpoint-secondary-route"
3426 },
3427 "stability": "external",
3428 "summary": "Defines the secondary Region."
3429 },
3430 "immutable": true,
3431 "locationInModule": {
3432 "filename": "lib/events.generated.ts",
3433 "line": 1963
3434 },
3435 "name": "route",
3436 "type": {
3437 "primitive": "string"
3438 }
3439 }
3440 ],
3441 "symbolId": "lib/events.generated:CfnEndpoint.SecondaryProperty"
3442 },
3443 "@aws-cdk/aws-events.CfnEndpointProps": {
3444 "assembly": "@aws-cdk/aws-events",
3445 "datatype": true,
3446 "docs": {
3447 "custom": {
3448 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html",
3449 "exampleMetadata": "fixture=_generated"
3450 },
3451 "stability": "external",
3452 "summary": "Properties for defining a `CfnEndpoint`.",
3453 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEndpointProps: events.CfnEndpointProps = {\n eventBuses: [{\n eventBusArn: 'eventBusArn',\n }],\n name: 'name',\n routingConfig: {\n failoverConfig: {\n primary: {\n healthCheck: 'healthCheck',\n },\n secondary: {\n route: 'route',\n },\n },\n },\n\n // the properties below are optional\n description: 'description',\n replicationConfig: {\n state: 'state',\n },\n roleArn: 'roleArn',\n};"
3454 },
3455 "fqn": "@aws-cdk/aws-events.CfnEndpointProps",
3456 "kind": "interface",
3457 "locationInModule": {
3458 "filename": "lib/events.generated.ts",
3459 "line": 1326
3460 },
3461 "name": "CfnEndpointProps",
3462 "properties": [
3463 {
3464 "abstract": true,
3465 "docs": {
3466 "custom": {
3467 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses"
3468 },
3469 "remarks": "*Exactly* : `2`",
3470 "stability": "external",
3471 "summary": "The event buses being used by the endpoint."
3472 },
3473 "immutable": true,
3474 "locationInModule": {
3475 "filename": "lib/events.generated.ts",
3476 "line": 1335
3477 },
3478 "name": "eventBuses",
3479 "type": {
3480 "union": {
3481 "types": [
3482 {
3483 "fqn": "@aws-cdk/core.IResolvable"
3484 },
3485 {
3486 "collection": {
3487 "elementtype": {
3488 "union": {
3489 "types": [
3490 {
3491 "fqn": "@aws-cdk/core.IResolvable"
3492 },
3493 {
3494 "fqn": "@aws-cdk/aws-events.CfnEndpoint.EndpointEventBusProperty"
3495 }
3496 ]
3497 }
3498 },
3499 "kind": "array"
3500 }
3501 }
3502 ]
3503 }
3504 }
3505 },
3506 {
3507 "abstract": true,
3508 "docs": {
3509 "custom": {
3510 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name"
3511 },
3512 "stability": "external",
3513 "summary": "The name of the endpoint."
3514 },
3515 "immutable": true,
3516 "locationInModule": {
3517 "filename": "lib/events.generated.ts",
3518 "line": 1342
3519 },
3520 "name": "name",
3521 "type": {
3522 "primitive": "string"
3523 }
3524 },
3525 {
3526 "abstract": true,
3527 "docs": {
3528 "custom": {
3529 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig"
3530 },
3531 "stability": "external",
3532 "summary": "The routing configuration of the endpoint."
3533 },
3534 "immutable": true,
3535 "locationInModule": {
3536 "filename": "lib/events.generated.ts",
3537 "line": 1349
3538 },
3539 "name": "routingConfig",
3540 "type": {
3541 "union": {
3542 "types": [
3543 {
3544 "fqn": "@aws-cdk/core.IResolvable"
3545 },
3546 {
3547 "fqn": "@aws-cdk/aws-events.CfnEndpoint.RoutingConfigProperty"
3548 }
3549 ]
3550 }
3551 }
3552 },
3553 {
3554 "abstract": true,
3555 "docs": {
3556 "custom": {
3557 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description"
3558 },
3559 "stability": "external",
3560 "summary": "A description for the endpoint."
3561 },
3562 "immutable": true,
3563 "locationInModule": {
3564 "filename": "lib/events.generated.ts",
3565 "line": 1356
3566 },
3567 "name": "description",
3568 "optional": true,
3569 "type": {
3570 "primitive": "string"
3571 }
3572 },
3573 {
3574 "abstract": true,
3575 "docs": {
3576 "custom": {
3577 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig"
3578 },
3579 "stability": "external",
3580 "summary": "Whether event replication was enabled or disabled for this endpoint."
3581 },
3582 "immutable": true,
3583 "locationInModule": {
3584 "filename": "lib/events.generated.ts",
3585 "line": 1363
3586 },
3587 "name": "replicationConfig",
3588 "optional": true,
3589 "type": {
3590 "union": {
3591 "types": [
3592 {
3593 "fqn": "@aws-cdk/core.IResolvable"
3594 },
3595 {
3596 "fqn": "@aws-cdk/aws-events.CfnEndpoint.ReplicationConfigProperty"
3597 }
3598 ]
3599 }
3600 }
3601 },
3602 {
3603 "abstract": true,
3604 "docs": {
3605 "custom": {
3606 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn"
3607 },
3608 "stability": "external",
3609 "summary": "The ARN of the role used by event replication for the endpoint."
3610 },
3611 "immutable": true,
3612 "locationInModule": {
3613 "filename": "lib/events.generated.ts",
3614 "line": 1370
3615 },
3616 "name": "roleArn",
3617 "optional": true,
3618 "type": {
3619 "primitive": "string"
3620 }
3621 }
3622 ],
3623 "symbolId": "lib/events.generated:CfnEndpointProps"
3624 },
3625 "@aws-cdk/aws-events.CfnEventBus": {
3626 "assembly": "@aws-cdk/aws-events",
3627 "base": "@aws-cdk/core.CfnResource",
3628 "docs": {
3629 "custom": {
3630 "cloudformationResource": "AWS::Events::EventBus",
3631 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html",
3632 "exampleMetadata": "fixture=_generated"
3633 },
3634 "remarks": "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.",
3635 "stability": "external",
3636 "summary": "A CloudFormation `AWS::Events::EventBus`.",
3637 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEventBus = new events.CfnEventBus(this, 'MyCfnEventBus', {\n name: 'name',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});"
3638 },
3639 "fqn": "@aws-cdk/aws-events.CfnEventBus",
3640 "initializer": {
3641 "docs": {
3642 "stability": "external",
3643 "summary": "Create a new `AWS::Events::EventBus`."
3644 },
3645 "locationInModule": {
3646 "filename": "lib/events.generated.ts",
3647 "line": 2189
3648 },
3649 "parameters": [
3650 {
3651 "docs": {
3652 "summary": "- scope in which this resource is defined."
3653 },
3654 "name": "scope",
3655 "type": {
3656 "fqn": "@aws-cdk/core.Construct"
3657 }
3658 },
3659 {
3660 "docs": {
3661 "summary": "- scoped id of the resource."
3662 },
3663 "name": "id",
3664 "type": {
3665 "primitive": "string"
3666 }
3667 },
3668 {
3669 "docs": {
3670 "summary": "- resource properties."
3671 },
3672 "name": "props",
3673 "type": {
3674 "fqn": "@aws-cdk/aws-events.CfnEventBusProps"
3675 }
3676 }
3677 ]
3678 },
3679 "interfaces": [
3680 "@aws-cdk/core.IInspectable"
3681 ],
3682 "kind": "class",
3683 "locationInModule": {
3684 "filename": "lib/events.generated.ts",
3685 "line": 2114
3686 },
3687 "methods": [
3688 {
3689 "docs": {
3690 "stability": "external",
3691 "summary": "Examines the CloudFormation resource and discloses attributes."
3692 },
3693 "locationInModule": {
3694 "filename": "lib/events.generated.ts",
3695 "line": 2207
3696 },
3697 "name": "inspect",
3698 "overrides": "@aws-cdk/core.IInspectable",
3699 "parameters": [
3700 {
3701 "docs": {
3702 "summary": "- tree inspector to collect and process attributes."
3703 },
3704 "name": "inspector",
3705 "type": {
3706 "fqn": "@aws-cdk/core.TreeInspector"
3707 }
3708 }
3709 ]
3710 },
3711 {
3712 "docs": {
3713 "stability": "external"
3714 },
3715 "locationInModule": {
3716 "filename": "lib/events.generated.ts",
3717 "line": 2220
3718 },
3719 "name": "renderProperties",
3720 "overrides": "@aws-cdk/core.CfnResource",
3721 "parameters": [
3722 {
3723 "name": "props",
3724 "type": {
3725 "collection": {
3726 "elementtype": {
3727 "primitive": "any"
3728 },
3729 "kind": "map"
3730 }
3731 }
3732 }
3733 ],
3734 "protected": true,
3735 "returns": {
3736 "type": {
3737 "collection": {
3738 "elementtype": {
3739 "primitive": "any"
3740 },
3741 "kind": "map"
3742 }
3743 }
3744 }
3745 }
3746 ],
3747 "name": "CfnEventBus",
3748 "properties": [
3749 {
3750 "const": true,
3751 "docs": {
3752 "stability": "external",
3753 "summary": "The CloudFormation resource type name for this resource class."
3754 },
3755 "immutable": true,
3756 "locationInModule": {
3757 "filename": "lib/events.generated.ts",
3758 "line": 2118
3759 },
3760 "name": "CFN_RESOURCE_TYPE_NAME",
3761 "static": true,
3762 "type": {
3763 "primitive": "string"
3764 }
3765 },
3766 {
3767 "docs": {
3768 "custom": {
3769 "cloudformationAttribute": "Arn"
3770 },
3771 "stability": "external",
3772 "summary": "The ARN of the event bus, such as `arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1` ."
3773 },
3774 "immutable": true,
3775 "locationInModule": {
3776 "filename": "lib/events.generated.ts",
3777 "line": 2143
3778 },
3779 "name": "attrArn",
3780 "type": {
3781 "primitive": "string"
3782 }
3783 },
3784 {
3785 "docs": {
3786 "custom": {
3787 "cloudformationAttribute": "Name"
3788 },
3789 "stability": "external",
3790 "summary": "The name of the event bus, such as `PartnerName/acct1/repo1` ."
3791 },
3792 "immutable": true,
3793 "locationInModule": {
3794 "filename": "lib/events.generated.ts",
3795 "line": 2149
3796 },
3797 "name": "attrName",
3798 "type": {
3799 "primitive": "string"
3800 }
3801 },
3802 {
3803 "docs": {
3804 "custom": {
3805 "cloudformationAttribute": "Policy"
3806 },
3807 "stability": "external",
3808 "summary": "The policy for the event bus in JSON form."
3809 },
3810 "immutable": true,
3811 "locationInModule": {
3812 "filename": "lib/events.generated.ts",
3813 "line": 2155
3814 },
3815 "name": "attrPolicy",
3816 "type": {
3817 "primitive": "string"
3818 }
3819 },
3820 {
3821 "docs": {
3822 "stability": "external"
3823 },
3824 "immutable": true,
3825 "locationInModule": {
3826 "filename": "lib/events.generated.ts",
3827 "line": 2212
3828 },
3829 "name": "cfnProperties",
3830 "overrides": "@aws-cdk/core.CfnResource",
3831 "protected": true,
3832 "type": {
3833 "collection": {
3834 "elementtype": {
3835 "primitive": "any"
3836 },
3837 "kind": "map"
3838 }
3839 }
3840 },
3841 {
3842 "docs": {
3843 "custom": {
3844 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name"
3845 },
3846 "remarks": "Event bus names cannot contain the / character. 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.\n\nIf this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.",
3847 "stability": "external",
3848 "summary": "The name of the new event bus."
3849 },
3850 "locationInModule": {
3851 "filename": "lib/events.generated.ts",
3852 "line": 2166
3853 },
3854 "name": "name",
3855 "type": {
3856 "primitive": "string"
3857 }
3858 },
3859 {
3860 "docs": {
3861 "custom": {
3862 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename"
3863 },
3864 "stability": "external",
3865 "summary": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with."
3866 },
3867 "locationInModule": {
3868 "filename": "lib/events.generated.ts",
3869 "line": 2173
3870 },
3871 "name": "eventSourceName",
3872 "optional": true,
3873 "type": {
3874 "primitive": "string"
3875 }
3876 },
3877 {
3878 "docs": {
3879 "custom": {
3880 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags"
3881 },
3882 "stability": "external",
3883 "summary": "Tags to associate with the event bus."
3884 },
3885 "locationInModule": {
3886 "filename": "lib/events.generated.ts",
3887 "line": 2180
3888 },
3889 "name": "tags",
3890 "optional": true,
3891 "type": {
3892 "collection": {
3893 "elementtype": {
3894 "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty"
3895 },
3896 "kind": "array"
3897 }
3898 }
3899 }
3900 ],
3901 "symbolId": "lib/events.generated:CfnEventBus"
3902 },
3903 "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty": {
3904 "assembly": "@aws-cdk/aws-events",
3905 "datatype": true,
3906 "docs": {
3907 "custom": {
3908 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html",
3909 "exampleMetadata": "fixture=_generated"
3910 },
3911 "remarks": "In EventBridge, rules and event buses support tagging.",
3912 "stability": "external",
3913 "summary": "A key-value pair associated with an AWS resource.",
3914 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst tagEntryProperty: events.CfnEventBus.TagEntryProperty = {\n key: 'key',\n value: 'value',\n};"
3915 },
3916 "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty",
3917 "kind": "interface",
3918 "locationInModule": {
3919 "filename": "lib/events.generated.ts",
3920 "line": 2234
3921 },
3922 "name": "TagEntryProperty",
3923 "namespace": "CfnEventBus",
3924 "properties": [
3925 {
3926 "abstract": true,
3927 "docs": {
3928 "custom": {
3929 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-key"
3930 },
3931 "remarks": "The combination of tag keys and values can help you organize and categorize your resources.",
3932 "stability": "external",
3933 "summary": "A string you can use to assign a value."
3934 },
3935 "immutable": true,
3936 "locationInModule": {
3937 "filename": "lib/events.generated.ts",
3938 "line": 2240
3939 },
3940 "name": "key",
3941 "type": {
3942 "primitive": "string"
3943 }
3944 },
3945 {
3946 "abstract": true,
3947 "docs": {
3948 "custom": {
3949 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbus-tagentry.html#cfn-events-eventbus-tagentry-value"
3950 },
3951 "stability": "external",
3952 "summary": "The value for the specified tag key."
3953 },
3954 "immutable": true,
3955 "locationInModule": {
3956 "filename": "lib/events.generated.ts",
3957 "line": 2246
3958 },
3959 "name": "value",
3960 "type": {
3961 "primitive": "string"
3962 }
3963 }
3964 ],
3965 "symbolId": "lib/events.generated:CfnEventBus.TagEntryProperty"
3966 },
3967 "@aws-cdk/aws-events.CfnEventBusPolicy": {
3968 "assembly": "@aws-cdk/aws-events",
3969 "base": "@aws-cdk/core.CfnResource",
3970 "docs": {
3971 "custom": {
3972 "cloudformationResource": "AWS::Events::EventBusPolicy",
3973 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html",
3974 "exampleMetadata": "fixture=_generated"
3975 },
3976 "remarks": "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.\n\nFor 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.\n\nTo 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.\n\nIf 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* .\n\nThe permission policy on the event bus cannot exceed 10 KB in size.",
3977 "stability": "external",
3978 "summary": "A CloudFormation `AWS::Events::EventBusPolicy`.",
3979 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const statement: any;\nconst cfnEventBusPolicy = new events.CfnEventBusPolicy(this, 'MyCfnEventBusPolicy', {\n statementId: 'statementId',\n\n // the properties below are optional\n action: 'action',\n condition: {\n key: 'key',\n type: 'type',\n value: 'value',\n },\n eventBusName: 'eventBusName',\n principal: 'principal',\n statement: statement,\n});"
3980 },
3981 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy",
3982 "initializer": {
3983 "docs": {
3984 "stability": "external",
3985 "summary": "Create a new `AWS::Events::EventBusPolicy`."
3986 },
3987 "locationInModule": {
3988 "filename": "lib/events.generated.ts",
3989 "line": 2525
3990 },
3991 "parameters": [
3992 {
3993 "docs": {
3994 "summary": "- scope in which this resource is defined."
3995 },
3996 "name": "scope",
3997 "type": {
3998 "fqn": "@aws-cdk/core.Construct"
3999 }
4000 },
4001 {
4002 "docs": {
4003 "summary": "- scoped id of the resource."
4004 },
4005 "name": "id",
4006 "type": {
4007 "primitive": "string"
4008 }
4009 },
4010 {
4011 "docs": {
4012 "summary": "- resource properties."
4013 },
4014 "name": "props",
4015 "type": {
4016 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicyProps"
4017 }
4018 }
4019 ]
4020 },
4021 "interfaces": [
4022 "@aws-cdk/core.IInspectable"
4023 ],
4024 "kind": "class",
4025 "locationInModule": {
4026 "filename": "lib/events.generated.ts",
4027 "line": 2443
4028 },
4029 "methods": [
4030 {
4031 "docs": {
4032 "stability": "external",
4033 "summary": "Examines the CloudFormation resource and discloses attributes."
4034 },
4035 "locationInModule": {
4036 "filename": "lib/events.generated.ts",
4037 "line": 2543
4038 },
4039 "name": "inspect",
4040 "overrides": "@aws-cdk/core.IInspectable",
4041 "parameters": [
4042 {
4043 "docs": {
4044 "summary": "- tree inspector to collect and process attributes."
4045 },
4046 "name": "inspector",
4047 "type": {
4048 "fqn": "@aws-cdk/core.TreeInspector"
4049 }
4050 }
4051 ]
4052 },
4053 {
4054 "docs": {
4055 "stability": "external"
4056 },
4057 "locationInModule": {
4058 "filename": "lib/events.generated.ts",
4059 "line": 2559
4060 },
4061 "name": "renderProperties",
4062 "overrides": "@aws-cdk/core.CfnResource",
4063 "parameters": [
4064 {
4065 "name": "props",
4066 "type": {
4067 "collection": {
4068 "elementtype": {
4069 "primitive": "any"
4070 },
4071 "kind": "map"
4072 }
4073 }
4074 }
4075 ],
4076 "protected": true,
4077 "returns": {
4078 "type": {
4079 "collection": {
4080 "elementtype": {
4081 "primitive": "any"
4082 },
4083 "kind": "map"
4084 }
4085 }
4086 }
4087 }
4088 ],
4089 "name": "CfnEventBusPolicy",
4090 "properties": [
4091 {
4092 "const": true,
4093 "docs": {
4094 "stability": "external",
4095 "summary": "The CloudFormation resource type name for this resource class."
4096 },
4097 "immutable": true,
4098 "locationInModule": {
4099 "filename": "lib/events.generated.ts",
4100 "line": 2447
4101 },
4102 "name": "CFN_RESOURCE_TYPE_NAME",
4103 "static": true,
4104 "type": {
4105 "primitive": "string"
4106 }
4107 },
4108 {
4109 "docs": {
4110 "stability": "external"
4111 },
4112 "immutable": true,
4113 "locationInModule": {
4114 "filename": "lib/events.generated.ts",
4115 "line": 2548
4116 },
4117 "name": "cfnProperties",
4118 "overrides": "@aws-cdk/core.CfnResource",
4119 "protected": true,
4120 "type": {
4121 "collection": {
4122 "elementtype": {
4123 "primitive": "any"
4124 },
4125 "kind": "map"
4126 }
4127 }
4128 },
4129 {
4130 "docs": {
4131 "custom": {
4132 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement"
4133 },
4134 "remarks": "You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.",
4135 "stability": "external",
4136 "summary": "A JSON string that describes the permission policy statement."
4137 },
4138 "locationInModule": {
4139 "filename": "lib/events.generated.ts",
4140 "line": 2516
4141 },
4142 "name": "statement",
4143 "type": {
4144 "primitive": "any"
4145 }
4146 },
4147 {
4148 "docs": {
4149 "custom": {
4150 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid"
4151 },
4152 "remarks": "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) .\n\n> Each `StatementId` must be unique.",
4153 "stability": "external",
4154 "summary": "An identifier string for the external account that you are granting permissions to."
4155 },
4156 "locationInModule": {
4157 "filename": "lib/events.generated.ts",
4158 "line": 2475
4159 },
4160 "name": "statementId",
4161 "type": {
4162 "primitive": "string"
4163 }
4164 },
4165 {
4166 "docs": {
4167 "custom": {
4168 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action"
4169 },
4170 "stability": "external",
4171 "summary": "The action that you are enabling the other account to perform."
4172 },
4173 "locationInModule": {
4174 "filename": "lib/events.generated.ts",
4175 "line": 2482
4176 },
4177 "name": "action",
4178 "optional": true,
4179 "type": {
4180 "primitive": "string"
4181 }
4182 },
4183 {
4184 "docs": {
4185 "custom": {
4186 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition"
4187 },
4188 "remarks": "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* .\n\nIf 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.\n\nThe `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.",
4189 "stability": "external",
4190 "summary": "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."
4191 },
4192 "locationInModule": {
4193 "filename": "lib/events.generated.ts",
4194 "line": 2493
4195 },
4196 "name": "condition",
4197 "optional": true,
4198 "type": {
4199 "union": {
4200 "types": [
4201 {
4202 "fqn": "@aws-cdk/core.IResolvable"
4203 },
4204 {
4205 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty"
4206 }
4207 ]
4208 }
4209 }
4210 },
4211 {
4212 "docs": {
4213 "custom": {
4214 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname"
4215 },
4216 "remarks": "If you omit this, the default event bus is used.",
4217 "stability": "external",
4218 "summary": "The name of the event bus associated with the rule."
4219 },
4220 "locationInModule": {
4221 "filename": "lib/events.generated.ts",
4222 "line": 2500
4223 },
4224 "name": "eventBusName",
4225 "optional": true,
4226 "type": {
4227 "primitive": "string"
4228 }
4229 },
4230 {
4231 "docs": {
4232 "custom": {
4233 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal"
4234 },
4235 "remarks": "Specify \"*\" to permit any account to put events to your default event bus.\n\nIf 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.",
4236 "stability": "external",
4237 "summary": "The 12-digit AWS account ID that you are permitting to put events to your default event bus."
4238 },
4239 "locationInModule": {
4240 "filename": "lib/events.generated.ts",
4241 "line": 2509
4242 },
4243 "name": "principal",
4244 "optional": true,
4245 "type": {
4246 "primitive": "string"
4247 }
4248 }
4249 ],
4250 "symbolId": "lib/events.generated:CfnEventBusPolicy"
4251 },
4252 "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty": {
4253 "assembly": "@aws-cdk/aws-events",
4254 "datatype": true,
4255 "docs": {
4256 "custom": {
4257 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html",
4258 "exampleMetadata": "fixture=_generated"
4259 },
4260 "remarks": "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` :\n\n`'{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\": \"o-1234567890\"}'`",
4261 "stability": "external",
4262 "summary": "A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition.",
4263 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst conditionProperty: events.CfnEventBusPolicy.ConditionProperty = {\n key: 'key',\n type: 'type',\n value: 'value',\n};"
4264 },
4265 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty",
4266 "kind": "interface",
4267 "locationInModule": {
4268 "filename": "lib/events.generated.ts",
4269 "line": 2575
4270 },
4271 "name": "ConditionProperty",
4272 "namespace": "CfnEventBusPolicy",
4273 "properties": [
4274 {
4275 "abstract": true,
4276 "docs": {
4277 "custom": {
4278 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-key"
4279 },
4280 "remarks": "Currently the only supported key is `aws:PrincipalOrgID` .",
4281 "stability": "external",
4282 "summary": "Specifies the key for the condition."
4283 },
4284 "immutable": true,
4285 "locationInModule": {
4286 "filename": "lib/events.generated.ts",
4287 "line": 2581
4288 },
4289 "name": "key",
4290 "optional": true,
4291 "type": {
4292 "primitive": "string"
4293 }
4294 },
4295 {
4296 "abstract": true,
4297 "docs": {
4298 "custom": {
4299 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-type"
4300 },
4301 "remarks": "Currently the only supported value is `StringEquals` .",
4302 "stability": "external",
4303 "summary": "Specifies the type of condition."
4304 },
4305 "immutable": true,
4306 "locationInModule": {
4307 "filename": "lib/events.generated.ts",
4308 "line": 2587
4309 },
4310 "name": "type",
4311 "optional": true,
4312 "type": {
4313 "primitive": "string"
4314 }
4315 },
4316 {
4317 "abstract": true,
4318 "docs": {
4319 "custom": {
4320 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-eventbuspolicy-condition.html#cfn-events-eventbuspolicy-condition-value"
4321 },
4322 "remarks": "Currently, this must be the ID of the organization.",
4323 "stability": "external",
4324 "summary": "Specifies the value for the key."
4325 },
4326 "immutable": true,
4327 "locationInModule": {
4328 "filename": "lib/events.generated.ts",
4329 "line": 2593
4330 },
4331 "name": "value",
4332 "optional": true,
4333 "type": {
4334 "primitive": "string"
4335 }
4336 }
4337 ],
4338 "symbolId": "lib/events.generated:CfnEventBusPolicy.ConditionProperty"
4339 },
4340 "@aws-cdk/aws-events.CfnEventBusPolicyProps": {
4341 "assembly": "@aws-cdk/aws-events",
4342 "datatype": true,
4343 "docs": {
4344 "custom": {
4345 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html",
4346 "exampleMetadata": "fixture=_generated"
4347 },
4348 "stability": "external",
4349 "summary": "Properties for defining a `CfnEventBusPolicy`.",
4350 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const statement: any;\nconst cfnEventBusPolicyProps: events.CfnEventBusPolicyProps = {\n statementId: 'statementId',\n\n // the properties below are optional\n action: 'action',\n condition: {\n key: 'key',\n type: 'type',\n value: 'value',\n },\n eventBusName: 'eventBusName',\n principal: 'principal',\n statement: statement,\n};"
4351 },
4352 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicyProps",
4353 "kind": "interface",
4354 "locationInModule": {
4355 "filename": "lib/events.generated.ts",
4356 "line": 2311
4357 },
4358 "name": "CfnEventBusPolicyProps",
4359 "properties": [
4360 {
4361 "abstract": true,
4362 "docs": {
4363 "custom": {
4364 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid"
4365 },
4366 "remarks": "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) .\n\n> Each `StatementId` must be unique.",
4367 "stability": "external",
4368 "summary": "An identifier string for the external account that you are granting permissions to."
4369 },
4370 "immutable": true,
4371 "locationInModule": {
4372 "filename": "lib/events.generated.ts",
4373 "line": 2320
4374 },
4375 "name": "statementId",
4376 "type": {
4377 "primitive": "string"
4378 }
4379 },
4380 {
4381 "abstract": true,
4382 "docs": {
4383 "custom": {
4384 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action"
4385 },
4386 "stability": "external",
4387 "summary": "The action that you are enabling the other account to perform."
4388 },
4389 "immutable": true,
4390 "locationInModule": {
4391 "filename": "lib/events.generated.ts",
4392 "line": 2327
4393 },
4394 "name": "action",
4395 "optional": true,
4396 "type": {
4397 "primitive": "string"
4398 }
4399 },
4400 {
4401 "abstract": true,
4402 "docs": {
4403 "custom": {
4404 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition"
4405 },
4406 "remarks": "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* .\n\nIf 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.\n\nThe `Condition` is a JSON string which must contain `Type` , `Key` , and `Value` fields.",
4407 "stability": "external",
4408 "summary": "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."
4409 },
4410 "immutable": true,
4411 "locationInModule": {
4412 "filename": "lib/events.generated.ts",
4413 "line": 2338
4414 },
4415 "name": "condition",
4416 "optional": true,
4417 "type": {
4418 "union": {
4419 "types": [
4420 {
4421 "fqn": "@aws-cdk/core.IResolvable"
4422 },
4423 {
4424 "fqn": "@aws-cdk/aws-events.CfnEventBusPolicy.ConditionProperty"
4425 }
4426 ]
4427 }
4428 }
4429 },
4430 {
4431 "abstract": true,
4432 "docs": {
4433 "custom": {
4434 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname"
4435 },
4436 "remarks": "If you omit this, the default event bus is used.",
4437 "stability": "external",
4438 "summary": "The name of the event bus associated with the rule."
4439 },
4440 "immutable": true,
4441 "locationInModule": {
4442 "filename": "lib/events.generated.ts",
4443 "line": 2345
4444 },
4445 "name": "eventBusName",
4446 "optional": true,
4447 "type": {
4448 "primitive": "string"
4449 }
4450 },
4451 {
4452 "abstract": true,
4453 "docs": {
4454 "custom": {
4455 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal"
4456 },
4457 "remarks": "Specify \"*\" to permit any account to put events to your default event bus.\n\nIf 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.",
4458 "stability": "external",
4459 "summary": "The 12-digit AWS account ID that you are permitting to put events to your default event bus."
4460 },
4461 "immutable": true,
4462 "locationInModule": {
4463 "filename": "lib/events.generated.ts",
4464 "line": 2354
4465 },
4466 "name": "principal",
4467 "optional": true,
4468 "type": {
4469 "primitive": "string"
4470 }
4471 },
4472 {
4473 "abstract": true,
4474 "docs": {
4475 "custom": {
4476 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement"
4477 },
4478 "remarks": "You can include a `Policy` parameter in the request instead of using the `StatementId` , `Action` , `Principal` , or `Condition` parameters.",
4479 "stability": "external",
4480 "summary": "A JSON string that describes the permission policy statement."
4481 },
4482 "immutable": true,
4483 "locationInModule": {
4484 "filename": "lib/events.generated.ts",
4485 "line": 2361
4486 },
4487 "name": "statement",
4488 "optional": true,
4489 "type": {
4490 "primitive": "any"
4491 }
4492 }
4493 ],
4494 "symbolId": "lib/events.generated:CfnEventBusPolicyProps"
4495 },
4496 "@aws-cdk/aws-events.CfnEventBusProps": {
4497 "assembly": "@aws-cdk/aws-events",
4498 "datatype": true,
4499 "docs": {
4500 "custom": {
4501 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html",
4502 "exampleMetadata": "fixture=_generated"
4503 },
4504 "stability": "external",
4505 "summary": "Properties for defining a `CfnEventBus`.",
4506 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst cfnEventBusProps: events.CfnEventBusProps = {\n name: 'name',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};"
4507 },
4508 "fqn": "@aws-cdk/aws-events.CfnEventBusProps",
4509 "kind": "interface",
4510 "locationInModule": {
4511 "filename": "lib/events.generated.ts",
4512 "line": 2024
4513 },
4514 "name": "CfnEventBusProps",
4515 "properties": [
4516 {
4517 "abstract": true,
4518 "docs": {
4519 "custom": {
4520 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name"
4521 },
4522 "remarks": "Event bus names cannot contain the / character. 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.\n\nIf this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.",
4523 "stability": "external",
4524 "summary": "The name of the new event bus."
4525 },
4526 "immutable": true,
4527 "locationInModule": {
4528 "filename": "lib/events.generated.ts",
4529 "line": 2035
4530 },
4531 "name": "name",
4532 "type": {
4533 "primitive": "string"
4534 }
4535 },
4536 {
4537 "abstract": true,
4538 "docs": {
4539 "custom": {
4540 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename"
4541 },
4542 "stability": "external",
4543 "summary": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with."
4544 },
4545 "immutable": true,
4546 "locationInModule": {
4547 "filename": "lib/events.generated.ts",
4548 "line": 2042
4549 },
4550 "name": "eventSourceName",
4551 "optional": true,
4552 "type": {
4553 "primitive": "string"
4554 }
4555 },
4556 {
4557 "abstract": true,
4558 "docs": {
4559 "custom": {
4560 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-tags"
4561 },
4562 "stability": "external",
4563 "summary": "Tags to associate with the event bus."
4564 },
4565 "immutable": true,
4566 "locationInModule": {
4567 "filename": "lib/events.generated.ts",
4568 "line": 2049
4569 },
4570 "name": "tags",
4571 "optional": true,
4572 "type": {
4573 "collection": {
4574 "elementtype": {
4575 "fqn": "@aws-cdk/aws-events.CfnEventBus.TagEntryProperty"
4576 },
4577 "kind": "array"
4578 }
4579 }
4580 }
4581 ],
4582 "symbolId": "lib/events.generated:CfnEventBusProps"
4583 },
4584 "@aws-cdk/aws-events.CfnRule": {
4585 "assembly": "@aws-cdk/aws-events",
4586 "base": "@aws-cdk/core.CfnResource",
4587 "docs": {
4588 "custom": {
4589 "cloudformationResource": "AWS::Events::Rule",
4590 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html",
4591 "exampleMetadata": "fixture=_generated"
4592 },
4593 "remarks": "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) .\n\nA 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) .\n\nIf 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.\n\nWhen 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.\n\nA 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.\n\nMost 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.\n\nIn 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.\n\nTo 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.\n\nAn 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) .",
4594 "stability": "external",
4595 "summary": "A CloudFormation `AWS::Events::Rule`.",
4596 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnRule = new events.CfnRule(this, 'MyCfnRule', /* all optional props */ {\n description: 'description',\n eventBusName: 'eventBusName',\n eventPattern: eventPattern,\n name: 'name',\n roleArn: 'roleArn',\n scheduleExpression: 'scheduleExpression',\n state: 'state',\n targets: [{\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n }],\n});"
4597 },
4598 "fqn": "@aws-cdk/aws-events.CfnRule",
4599 "initializer": {
4600 "docs": {
4601 "stability": "external",
4602 "summary": "Create a new `AWS::Events::Rule`."
4603 },
4604 "locationInModule": {
4605 "filename": "lib/events.generated.ts",
4606 "line": 3032
4607 },
4608 "parameters": [
4609 {
4610 "docs": {
4611 "summary": "- scope in which this resource is defined."
4612 },
4613 "name": "scope",
4614 "type": {
4615 "fqn": "@aws-cdk/core.Construct"
4616 }
4617 },
4618 {
4619 "docs": {
4620 "summary": "- scoped id of the resource."
4621 },
4622 "name": "id",
4623 "type": {
4624 "primitive": "string"
4625 }
4626 },
4627 {
4628 "docs": {
4629 "summary": "- resource properties."
4630 },
4631 "name": "props",
4632 "optional": true,
4633 "type": {
4634 "fqn": "@aws-cdk/aws-events.CfnRuleProps"
4635 }
4636 }
4637 ]
4638 },
4639 "interfaces": [
4640 "@aws-cdk/core.IInspectable"
4641 ],
4642 "kind": "class",
4643 "locationInModule": {
4644 "filename": "lib/events.generated.ts",
4645 "line": 2874
4646 },
4647 "methods": [
4648 {
4649 "docs": {
4650 "stability": "external",
4651 "summary": "Examines the CloudFormation resource and discloses attributes."
4652 },
4653 "locationInModule": {
4654 "filename": "lib/events.generated.ts",
4655 "line": 3052
4656 },
4657 "name": "inspect",
4658 "overrides": "@aws-cdk/core.IInspectable",
4659 "parameters": [
4660 {
4661 "docs": {
4662 "summary": "- tree inspector to collect and process attributes."
4663 },
4664 "name": "inspector",
4665 "type": {
4666 "fqn": "@aws-cdk/core.TreeInspector"
4667 }
4668 }
4669 ]
4670 },
4671 {
4672 "docs": {
4673 "stability": "external"
4674 },
4675 "locationInModule": {
4676 "filename": "lib/events.generated.ts",
4677 "line": 3070
4678 },
4679 "name": "renderProperties",
4680 "overrides": "@aws-cdk/core.CfnResource",
4681 "parameters": [
4682 {
4683 "name": "props",
4684 "type": {
4685 "collection": {
4686 "elementtype": {
4687 "primitive": "any"
4688 },
4689 "kind": "map"
4690 }
4691 }
4692 }
4693 ],
4694 "protected": true,
4695 "returns": {
4696 "type": {
4697 "collection": {
4698 "elementtype": {
4699 "primitive": "any"
4700 },
4701 "kind": "map"
4702 }
4703 }
4704 }
4705 }
4706 ],
4707 "name": "CfnRule",
4708 "properties": [
4709 {
4710 "const": true,
4711 "docs": {
4712 "stability": "external",
4713 "summary": "The CloudFormation resource type name for this resource class."
4714 },
4715 "immutable": true,
4716 "locationInModule": {
4717 "filename": "lib/events.generated.ts",
4718 "line": 2878
4719 },
4720 "name": "CFN_RESOURCE_TYPE_NAME",
4721 "static": true,
4722 "type": {
4723 "primitive": "string"
4724 }
4725 },
4726 {
4727 "docs": {
4728 "custom": {
4729 "cloudformationAttribute": "Arn"
4730 },
4731 "stability": "external",
4732 "summary": "The ARN of the rule, such as `arn:aws:events:us-east-2:123456789012:rule/example` ."
4733 },
4734 "immutable": true,
4735 "locationInModule": {
4736 "filename": "lib/events.generated.ts",
4737 "line": 2903
4738 },
4739 "name": "attrArn",
4740 "type": {
4741 "primitive": "string"
4742 }
4743 },
4744 {
4745 "docs": {
4746 "stability": "external"
4747 },
4748 "immutable": true,
4749 "locationInModule": {
4750 "filename": "lib/events.generated.ts",
4751 "line": 3057
4752 },
4753 "name": "cfnProperties",
4754 "overrides": "@aws-cdk/core.CfnResource",
4755 "protected": true,
4756 "type": {
4757 "collection": {
4758 "elementtype": {
4759 "primitive": "any"
4760 },
4761 "kind": "map"
4762 }
4763 }
4764 },
4765 {
4766 "docs": {
4767 "custom": {
4768 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern"
4769 },
4770 "remarks": "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* .",
4771 "stability": "external",
4772 "summary": "The event pattern of the rule."
4773 },
4774 "locationInModule": {
4775 "filename": "lib/events.generated.ts",
4776 "line": 2924
4777 },
4778 "name": "eventPattern",
4779 "type": {
4780 "primitive": "any"
4781 }
4782 },
4783 {
4784 "docs": {
4785 "custom": {
4786 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description"
4787 },
4788 "stability": "external",
4789 "summary": "The description of the rule."
4790 },
4791 "locationInModule": {
4792 "filename": "lib/events.generated.ts",
4793 "line": 2910
4794 },
4795 "name": "description",
4796 "optional": true,
4797 "type": {
4798 "primitive": "string"
4799 }
4800 },
4801 {
4802 "docs": {
4803 "custom": {
4804 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname"
4805 },
4806 "remarks": "If you omit this, the default event bus is used.",
4807 "stability": "external",
4808 "summary": "The name or ARN of the event bus associated with the rule."
4809 },
4810 "locationInModule": {
4811 "filename": "lib/events.generated.ts",
4812 "line": 2917
4813 },
4814 "name": "eventBusName",
4815 "optional": true,
4816 "type": {
4817 "primitive": "string"
4818 }
4819 },
4820 {
4821 "docs": {
4822 "custom": {
4823 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name"
4824 },
4825 "stability": "external",
4826 "summary": "The name of the rule."
4827 },
4828 "locationInModule": {
4829 "filename": "lib/events.generated.ts",
4830 "line": 2931
4831 },
4832 "name": "name",
4833 "optional": true,
4834 "type": {
4835 "primitive": "string"
4836 }
4837 },
4838 {
4839 "docs": {
4840 "custom": {
4841 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn"
4842 },
4843 "remarks": "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.",
4844 "stability": "external",
4845 "summary": "The Amazon Resource Name (ARN) of the role that is used for target invocation."
4846 },
4847 "locationInModule": {
4848 "filename": "lib/events.generated.ts",
4849 "line": 2940
4850 },
4851 "name": "roleArn",
4852 "optional": true,
4853 "type": {
4854 "primitive": "string"
4855 }
4856 },
4857 {
4858 "docs": {
4859 "custom": {
4860 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression"
4861 },
4862 "remarks": "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) .",
4863 "stability": "external",
4864 "summary": "The scheduling expression."
4865 },
4866 "locationInModule": {
4867 "filename": "lib/events.generated.ts",
4868 "line": 2947
4869 },
4870 "name": "scheduleExpression",
4871 "optional": true,
4872 "type": {
4873 "primitive": "string"
4874 }
4875 },
4876 {
4877 "docs": {
4878 "custom": {
4879 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state"
4880 },
4881 "stability": "external",
4882 "summary": "The state of the rule."
4883 },
4884 "locationInModule": {
4885 "filename": "lib/events.generated.ts",
4886 "line": 2954
4887 },
4888 "name": "state",
4889 "optional": true,
4890 "type": {
4891 "primitive": "string"
4892 }
4893 },
4894 {
4895 "docs": {
4896 "custom": {
4897 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets"
4898 },
4899 "remarks": "Targets are the resources that are invoked when a rule is triggered.\n\n> Each rule can have up to five (5) targets associated with it at one time.\n\nYou can configure the following as targets for Events:\n\n- [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html)\n- [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html)\n- Batch job queue\n- CloudWatch group\n- CodeBuild project\n- CodePipeline\n- EC2 `CreateSnapshot` API call\n- EC2 Image Builder\n- EC2 `RebootInstances` API call\n- EC2 `StopInstances` API call\n- EC2 `TerminateInstances` API call\n- ECS task\n- [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html)\n- [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html)\n- Firehose delivery stream\n- Glue workflow\n- [Incident Manager response plan](https://docs.aws.amazon.com//incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge)\n- Inspector assessment template\n- Kinesis stream\n- Lambda function\n- Redshift cluster\n- SageMaker Pipeline\n- SNS topic\n- SQS queue\n- Step Functions state machine\n- Systems Manager Automation\n- Systems Manager OpsItem\n- Systems Manager Run Command\n\nCreating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are `EC2 CreateSnapshot API call` , `EC2 RebootInstances API call` , `EC2 StopInstances API call` , and `EC2 TerminateInstances API call` .\n\nFor 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.\n\nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` . 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* .\n\nIf 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/) .\n\n> `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.\n\nIf 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* .\n\nFor more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .\n\n*Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:\n\n- 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).\n- If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.\n- 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).\n- 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.\n\nWhen you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.\n\nWhen 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.\n\nThis 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.",
4900 "stability": "external",
4901 "summary": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule."
4902 },
4903 "locationInModule": {
4904 "filename": "lib/events.generated.ts",
4905 "line": 3023
4906 },
4907 "name": "targets",
4908 "optional": true,
4909 "type": {
4910 "union": {
4911 "types": [
4912 {
4913 "fqn": "@aws-cdk/core.IResolvable"
4914 },
4915 {
4916 "collection": {
4917 "elementtype": {
4918 "union": {
4919 "types": [
4920 {
4921 "fqn": "@aws-cdk/core.IResolvable"
4922 },
4923 {
4924 "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty"
4925 }
4926 ]
4927 }
4928 },
4929 "kind": "array"
4930 }
4931 }
4932 ]
4933 }
4934 }
4935 }
4936 ],
4937 "symbolId": "lib/events.generated:CfnRule"
4938 },
4939 "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty": {
4940 "assembly": "@aws-cdk/aws-events",
4941 "datatype": true,
4942 "docs": {
4943 "custom": {
4944 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html",
4945 "exampleMetadata": "fixture=_generated"
4946 },
4947 "remarks": "This structure is relevant only for ECS tasks that use the `awsvpc` network mode.",
4948 "stability": "external",
4949 "summary": "This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.",
4950 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst awsVpcConfigurationProperty: events.CfnRule.AwsVpcConfigurationProperty = {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n};"
4951 },
4952 "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty",
4953 "kind": "interface",
4954 "locationInModule": {
4955 "filename": "lib/events.generated.ts",
4956 "line": 3084
4957 },
4958 "name": "AwsVpcConfigurationProperty",
4959 "namespace": "CfnRule",
4960 "properties": [
4961 {
4962 "abstract": true,
4963 "docs": {
4964 "custom": {
4965 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-subnets"
4966 },
4967 "remarks": "These subnets must all be in the same VPC. You can specify as many as 16 subnets.",
4968 "stability": "external",
4969 "summary": "Specifies the subnets associated with the task."
4970 },
4971 "immutable": true,
4972 "locationInModule": {
4973 "filename": "lib/events.generated.ts",
4974 "line": 3102
4975 },
4976 "name": "subnets",
4977 "type": {
4978 "collection": {
4979 "elementtype": {
4980 "primitive": "string"
4981 },
4982 "kind": "array"
4983 }
4984 }
4985 },
4986 {
4987 "abstract": true,
4988 "docs": {
4989 "custom": {
4990 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-assignpublicip"
4991 },
4992 "remarks": "You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` .",
4993 "stability": "external",
4994 "summary": "Specifies whether the task's elastic network interface receives a public IP address."
4995 },
4996 "immutable": true,
4997 "locationInModule": {
4998 "filename": "lib/events.generated.ts",
4999 "line": 3090
5000 },
5001 "name": "assignPublicIp",
5002 "optional": true,
5003 "type": {
5004 "primitive": "string"
5005 }
5006 },
5007 {
5008 "abstract": true,
5009 "docs": {
5010 "custom": {
5011 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-awsvpcconfiguration.html#cfn-events-rule-awsvpcconfiguration-securitygroups"
5012 },
5013 "remarks": "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.",
5014 "stability": "external",
5015 "summary": "Specifies the security groups associated with the task."
5016 },
5017 "immutable": true,
5018 "locationInModule": {
5019 "filename": "lib/events.generated.ts",
5020 "line": 3096
5021 },
5022 "name": "securityGroups",
5023 "optional": true,
5024 "type": {
5025 "collection": {
5026 "elementtype": {
5027 "primitive": "string"
5028 },
5029 "kind": "array"
5030 }
5031 }
5032 }
5033 ],
5034 "symbolId": "lib/events.generated:CfnRule.AwsVpcConfigurationProperty"
5035 },
5036 "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty": {
5037 "assembly": "@aws-cdk/aws-events",
5038 "datatype": true,
5039 "docs": {
5040 "custom": {
5041 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html",
5042 "exampleMetadata": "fixture=_generated"
5043 },
5044 "remarks": "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.",
5045 "stability": "external",
5046 "summary": "The array properties for the submitted job, such as the size of the array.",
5047 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchArrayPropertiesProperty: events.CfnRule.BatchArrayPropertiesProperty = {\n size: 123,\n};"
5048 },
5049 "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty",
5050 "kind": "interface",
5051 "locationInModule": {
5052 "filename": "lib/events.generated.ts",
5053 "line": 3170
5054 },
5055 "name": "BatchArrayPropertiesProperty",
5056 "namespace": "CfnRule",
5057 "properties": [
5058 {
5059 "abstract": true,
5060 "docs": {
5061 "custom": {
5062 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batcharrayproperties.html#cfn-events-rule-batcharrayproperties-size"
5063 },
5064 "remarks": "Valid values are integers between 2 and 10,000.",
5065 "stability": "external",
5066 "summary": "The size of the array, if this is an array batch job."
5067 },
5068 "immutable": true,
5069 "locationInModule": {
5070 "filename": "lib/events.generated.ts",
5071 "line": 3176
5072 },
5073 "name": "size",
5074 "optional": true,
5075 "type": {
5076 "primitive": "number"
5077 }
5078 }
5079 ],
5080 "symbolId": "lib/events.generated:CfnRule.BatchArrayPropertiesProperty"
5081 },
5082 "@aws-cdk/aws-events.CfnRule.BatchParametersProperty": {
5083 "assembly": "@aws-cdk/aws-events",
5084 "datatype": true,
5085 "docs": {
5086 "custom": {
5087 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html",
5088 "exampleMetadata": "fixture=_generated"
5089 },
5090 "stability": "external",
5091 "summary": "The custom parameters to be used when the target is an AWS Batch job.",
5092 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchParametersProperty: events.CfnRule.BatchParametersProperty = {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n};"
5093 },
5094 "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty",
5095 "kind": "interface",
5096 "locationInModule": {
5097 "filename": "lib/events.generated.ts",
5098 "line": 3237
5099 },
5100 "name": "BatchParametersProperty",
5101 "namespace": "CfnRule",
5102 "properties": [
5103 {
5104 "abstract": true,
5105 "docs": {
5106 "custom": {
5107 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition"
5108 },
5109 "remarks": "This job definition must already exist.",
5110 "stability": "external",
5111 "summary": "The ARN or name of the job definition to use if the event target is an AWS Batch job."
5112 },
5113 "immutable": true,
5114 "locationInModule": {
5115 "filename": "lib/events.generated.ts",
5116 "line": 3249
5117 },
5118 "name": "jobDefinition",
5119 "type": {
5120 "primitive": "string"
5121 }
5122 },
5123 {
5124 "abstract": true,
5125 "docs": {
5126 "custom": {
5127 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobname"
5128 },
5129 "stability": "external",
5130 "summary": "The name to use for this execution of the job, if the target is an AWS Batch job."
5131 },
5132 "immutable": true,
5133 "locationInModule": {
5134 "filename": "lib/events.generated.ts",
5135 "line": 3255
5136 },
5137 "name": "jobName",
5138 "type": {
5139 "primitive": "string"
5140 }
5141 },
5142 {
5143 "abstract": true,
5144 "docs": {
5145 "custom": {
5146 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties"
5147 },
5148 "remarks": "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.",
5149 "stability": "external",
5150 "summary": "The array properties for the submitted job, such as the size of the array."
5151 },
5152 "immutable": true,
5153 "locationInModule": {
5154 "filename": "lib/events.generated.ts",
5155 "line": 3243
5156 },
5157 "name": "arrayProperties",
5158 "optional": true,
5159 "type": {
5160 "union": {
5161 "types": [
5162 {
5163 "fqn": "@aws-cdk/core.IResolvable"
5164 },
5165 {
5166 "fqn": "@aws-cdk/aws-events.CfnRule.BatchArrayPropertiesProperty"
5167 }
5168 ]
5169 }
5170 }
5171 },
5172 {
5173 "abstract": true,
5174 "docs": {
5175 "custom": {
5176 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy"
5177 },
5178 "remarks": "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.",
5179 "stability": "external",
5180 "summary": "The retry strategy to use for failed jobs, if the target is an AWS Batch job."
5181 },
5182 "immutable": true,
5183 "locationInModule": {
5184 "filename": "lib/events.generated.ts",
5185 "line": 3261
5186 },
5187 "name": "retryStrategy",
5188 "optional": true,
5189 "type": {
5190 "union": {
5191 "types": [
5192 {
5193 "fqn": "@aws-cdk/core.IResolvable"
5194 },
5195 {
5196 "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty"
5197 }
5198 ]
5199 }
5200 }
5201 }
5202 ],
5203 "symbolId": "lib/events.generated:CfnRule.BatchParametersProperty"
5204 },
5205 "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty": {
5206 "assembly": "@aws-cdk/aws-events",
5207 "datatype": true,
5208 "docs": {
5209 "custom": {
5210 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html",
5211 "exampleMetadata": "fixture=_generated"
5212 },
5213 "remarks": "If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.",
5214 "stability": "external",
5215 "summary": "The retry strategy to use for failed jobs, if the target is an AWS Batch job.",
5216 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst batchRetryStrategyProperty: events.CfnRule.BatchRetryStrategyProperty = {\n attempts: 123,\n};"
5217 },
5218 "fqn": "@aws-cdk/aws-events.CfnRule.BatchRetryStrategyProperty",
5219 "kind": "interface",
5220 "locationInModule": {
5221 "filename": "lib/events.generated.ts",
5222 "line": 3333
5223 },
5224 "name": "BatchRetryStrategyProperty",
5225 "namespace": "CfnRule",
5226 "properties": [
5227 {
5228 "abstract": true,
5229 "docs": {
5230 "custom": {
5231 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchretrystrategy.html#cfn-events-rule-batchretrystrategy-attempts"
5232 },
5233 "remarks": "Valid values are 1–10.",
5234 "stability": "external",
5235 "summary": "The number of times to attempt to retry, if the job fails."
5236 },
5237 "immutable": true,
5238 "locationInModule": {
5239 "filename": "lib/events.generated.ts",
5240 "line": 3339
5241 },
5242 "name": "attempts",
5243 "optional": true,
5244 "type": {
5245 "primitive": "number"
5246 }
5247 }
5248 ],
5249 "symbolId": "lib/events.generated:CfnRule.BatchRetryStrategyProperty"
5250 },
5251 "@aws-cdk/aws-events.CfnRule.CapacityProviderStrategyItemProperty": {
5252 "assembly": "@aws-cdk/aws-events",
5253 "datatype": true,
5254 "docs": {
5255 "custom": {
5256 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html",
5257 "exampleMetadata": "fixture=_generated"
5258 },
5259 "remarks": "To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.",
5260 "stability": "external",
5261 "summary": "The details of a capacity provider strategy.",
5262 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst capacityProviderStrategyItemProperty: events.CfnRule.CapacityProviderStrategyItemProperty = {\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n};"
5263 },
5264 "fqn": "@aws-cdk/aws-events.CfnRule.CapacityProviderStrategyItemProperty",
5265 "kind": "interface",
5266 "locationInModule": {
5267 "filename": "lib/events.generated.ts",
5268 "line": 3400
5269 },
5270 "name": "CapacityProviderStrategyItemProperty",
5271 "namespace": "CfnRule",
5272 "properties": [
5273 {
5274 "abstract": true,
5275 "docs": {
5276 "custom": {
5277 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-capacityprovider"
5278 },
5279 "stability": "external",
5280 "summary": "The short name of the capacity provider."
5281 },
5282 "immutable": true,
5283 "locationInModule": {
5284 "filename": "lib/events.generated.ts",
5285 "line": 3412
5286 },
5287 "name": "capacityProvider",
5288 "type": {
5289 "primitive": "string"
5290 }
5291 },
5292 {
5293 "abstract": true,
5294 "docs": {
5295 "custom": {
5296 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-base"
5297 },
5298 "remarks": "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.",
5299 "stability": "external",
5300 "summary": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider."
5301 },
5302 "immutable": true,
5303 "locationInModule": {
5304 "filename": "lib/events.generated.ts",
5305 "line": 3406
5306 },
5307 "name": "base",
5308 "optional": true,
5309 "type": {
5310 "primitive": "number"
5311 }
5312 },
5313 {
5314 "abstract": true,
5315 "docs": {
5316 "custom": {
5317 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-capacityproviderstrategyitem.html#cfn-events-rule-capacityproviderstrategyitem-weight"
5318 },
5319 "remarks": "The weight value is taken into consideration after the base value, if defined, is satisfied.",
5320 "stability": "external",
5321 "summary": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider."
5322 },
5323 "immutable": true,
5324 "locationInModule": {
5325 "filename": "lib/events.generated.ts",
5326 "line": 3418
5327 },
5328 "name": "weight",
5329 "optional": true,
5330 "type": {
5331 "primitive": "number"
5332 }
5333 }
5334 ],
5335 "symbolId": "lib/events.generated:CfnRule.CapacityProviderStrategyItemProperty"
5336 },
5337 "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty": {
5338 "assembly": "@aws-cdk/aws-events",
5339 "datatype": true,
5340 "docs": {
5341 "custom": {
5342 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html",
5343 "exampleMetadata": "fixture=_generated"
5344 },
5345 "stability": "external",
5346 "summary": "A `DeadLetterConfig` object that contains information about a dead-letter queue configuration.",
5347 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst deadLetterConfigProperty: events.CfnRule.DeadLetterConfigProperty = {\n arn: 'arn',\n};"
5348 },
5349 "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty",
5350 "kind": "interface",
5351 "locationInModule": {
5352 "filename": "lib/events.generated.ts",
5353 "line": 3486
5354 },
5355 "name": "DeadLetterConfigProperty",
5356 "namespace": "CfnRule",
5357 "properties": [
5358 {
5359 "abstract": true,
5360 "docs": {
5361 "custom": {
5362 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn"
5363 },
5364 "stability": "external",
5365 "summary": "The ARN of the SQS queue specified as the target for the dead-letter queue."
5366 },
5367 "immutable": true,
5368 "locationInModule": {
5369 "filename": "lib/events.generated.ts",
5370 "line": 3492
5371 },
5372 "name": "arn",
5373 "optional": true,
5374 "type": {
5375 "primitive": "string"
5376 }
5377 }
5378 ],
5379 "symbolId": "lib/events.generated:CfnRule.DeadLetterConfigProperty"
5380 },
5381 "@aws-cdk/aws-events.CfnRule.EcsParametersProperty": {
5382 "assembly": "@aws-cdk/aws-events",
5383 "datatype": true,
5384 "docs": {
5385 "custom": {
5386 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html",
5387 "exampleMetadata": "fixture=_generated"
5388 },
5389 "stability": "external",
5390 "summary": "The custom parameters to be used when the target is an Amazon ECS task.",
5391 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst ecsParametersProperty: events.CfnRule.EcsParametersProperty = {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n};"
5392 },
5393 "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty",
5394 "kind": "interface",
5395 "locationInModule": {
5396 "filename": "lib/events.generated.ts",
5397 "line": 3553
5398 },
5399 "name": "EcsParametersProperty",
5400 "namespace": "CfnRule",
5401 "properties": [
5402 {
5403 "abstract": true,
5404 "docs": {
5405 "custom": {
5406 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskdefinitionarn"
5407 },
5408 "stability": "external",
5409 "summary": "The ARN of the task definition to use if the event target is an Amazon ECS task."
5410 },
5411 "immutable": true,
5412 "locationInModule": {
5413 "filename": "lib/events.generated.ts",
5414 "line": 3643
5415 },
5416 "name": "taskDefinitionArn",
5417 "type": {
5418 "primitive": "string"
5419 }
5420 },
5421 {
5422 "abstract": true,
5423 "docs": {
5424 "custom": {
5425 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-capacityproviderstrategy"
5426 },
5427 "remarks": "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.",
5428 "stability": "external",
5429 "summary": "The capacity provider strategy to use for the task."
5430 },
5431 "immutable": true,
5432 "locationInModule": {
5433 "filename": "lib/events.generated.ts",
5434 "line": 3561
5435 },
5436 "name": "capacityProviderStrategy",
5437 "optional": true,
5438 "type": {
5439 "union": {
5440 "types": [
5441 {
5442 "fqn": "@aws-cdk/core.IResolvable"
5443 },
5444 {
5445 "collection": {
5446 "elementtype": {
5447 "union": {
5448 "types": [
5449 {
5450 "fqn": "@aws-cdk/core.IResolvable"
5451 },
5452 {
5453 "fqn": "@aws-cdk/aws-events.CfnRule.CapacityProviderStrategyItemProperty"
5454 }
5455 ]
5456 }
5457 },
5458 "kind": "array"
5459 }
5460 }
5461 ]
5462 }
5463 }
5464 },
5465 {
5466 "abstract": true,
5467 "docs": {
5468 "custom": {
5469 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableecsmanagedtags"
5470 },
5471 "remarks": "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.",
5472 "stability": "external",
5473 "summary": "Specifies whether to enable Amazon ECS managed tags for the task."
5474 },
5475 "immutable": true,
5476 "locationInModule": {
5477 "filename": "lib/events.generated.ts",
5478 "line": 3567
5479 },
5480 "name": "enableEcsManagedTags",
5481 "optional": true,
5482 "type": {
5483 "union": {
5484 "types": [
5485 {
5486 "primitive": "boolean"
5487 },
5488 {
5489 "fqn": "@aws-cdk/core.IResolvable"
5490 }
5491 ]
5492 }
5493 }
5494 },
5495 {
5496 "abstract": true,
5497 "docs": {
5498 "custom": {
5499 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand"
5500 },
5501 "remarks": "If true, this enables execute command functionality on all containers in the task.",
5502 "stability": "external",
5503 "summary": "Whether or not to enable the execute command functionality for the containers in this task."
5504 },
5505 "immutable": true,
5506 "locationInModule": {
5507 "filename": "lib/events.generated.ts",
5508 "line": 3573
5509 },
5510 "name": "enableExecuteCommand",
5511 "optional": true,
5512 "type": {
5513 "union": {
5514 "types": [
5515 {
5516 "primitive": "boolean"
5517 },
5518 {
5519 "fqn": "@aws-cdk/core.IResolvable"
5520 }
5521 ]
5522 }
5523 }
5524 },
5525 {
5526 "abstract": true,
5527 "docs": {
5528 "custom": {
5529 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-group"
5530 },
5531 "remarks": "The maximum length is 255 characters.",
5532 "stability": "external",
5533 "summary": "Specifies an ECS task group for the task."
5534 },
5535 "immutable": true,
5536 "locationInModule": {
5537 "filename": "lib/events.generated.ts",
5538 "line": 3579
5539 },
5540 "name": "group",
5541 "optional": true,
5542 "type": {
5543 "primitive": "string"
5544 }
5545 },
5546 {
5547 "abstract": true,
5548 "docs": {
5549 "custom": {
5550 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-launchtype"
5551 },
5552 "remarks": "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* .",
5553 "stability": "external",
5554 "summary": "Specifies the launch type on which your task is running."
5555 },
5556 "immutable": true,
5557 "locationInModule": {
5558 "filename": "lib/events.generated.ts",
5559 "line": 3585
5560 },
5561 "name": "launchType",
5562 "optional": true,
5563 "type": {
5564 "primitive": "string"
5565 }
5566 },
5567 {
5568 "abstract": true,
5569 "docs": {
5570 "custom": {
5571 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-networkconfiguration"
5572 },
5573 "remarks": "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.\n\nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails.",
5574 "stability": "external",
5575 "summary": "Use this structure if the Amazon ECS task uses the `awsvpc` network mode."
5576 },
5577 "immutable": true,
5578 "locationInModule": {
5579 "filename": "lib/events.generated.ts",
5580 "line": 3593
5581 },
5582 "name": "networkConfiguration",
5583 "optional": true,
5584 "type": {
5585 "union": {
5586 "types": [
5587 {
5588 "fqn": "@aws-cdk/core.IResolvable"
5589 },
5590 {
5591 "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty"
5592 }
5593 ]
5594 }
5595 }
5596 },
5597 {
5598 "abstract": true,
5599 "docs": {
5600 "custom": {
5601 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints"
5602 },
5603 "remarks": "You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).",
5604 "stability": "external",
5605 "summary": "An array of placement constraint objects to use for the task."
5606 },
5607 "immutable": true,
5608 "locationInModule": {
5609 "filename": "lib/events.generated.ts",
5610 "line": 3599
5611 },
5612 "name": "placementConstraints",
5613 "optional": true,
5614 "type": {
5615 "union": {
5616 "types": [
5617 {
5618 "fqn": "@aws-cdk/core.IResolvable"
5619 },
5620 {
5621 "collection": {
5622 "elementtype": {
5623 "union": {
5624 "types": [
5625 {
5626 "fqn": "@aws-cdk/core.IResolvable"
5627 },
5628 {
5629 "fqn": "@aws-cdk/aws-events.CfnRule.PlacementConstraintProperty"
5630 }
5631 ]
5632 }
5633 },
5634 "kind": "array"
5635 }
5636 }
5637 ]
5638 }
5639 }
5640 },
5641 {
5642 "abstract": true,
5643 "docs": {
5644 "custom": {
5645 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies"
5646 },
5647 "remarks": "You can specify a maximum of five strategy rules per task.",
5648 "stability": "external",
5649 "summary": "The placement strategy objects to use for the task."
5650 },
5651 "immutable": true,
5652 "locationInModule": {
5653 "filename": "lib/events.generated.ts",
5654 "line": 3605
5655 },
5656 "name": "placementStrategies",
5657 "optional": true,
5658 "type": {
5659 "union": {
5660 "types": [
5661 {
5662 "fqn": "@aws-cdk/core.IResolvable"
5663 },
5664 {
5665 "collection": {
5666 "elementtype": {
5667 "union": {
5668 "types": [
5669 {
5670 "fqn": "@aws-cdk/core.IResolvable"
5671 },
5672 {
5673 "fqn": "@aws-cdk/aws-events.CfnRule.PlacementStrategyProperty"
5674 }
5675 ]
5676 }
5677 },
5678 "kind": "array"
5679 }
5680 }
5681 ]
5682 }
5683 }
5684 },
5685 {
5686 "abstract": true,
5687 "docs": {
5688 "custom": {
5689 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-platformversion"
5690 },
5691 "remarks": "Specify only the numeric portion of the platform version, such as `1.1.0` .\n\nThis 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* .",
5692 "stability": "external",
5693 "summary": "Specifies the platform version for the task."
5694 },
5695 "immutable": true,
5696 "locationInModule": {
5697 "filename": "lib/events.generated.ts",
5698 "line": 3613
5699 },
5700 "name": "platformVersion",
5701 "optional": true,
5702 "type": {
5703 "primitive": "string"
5704 }
5705 },
5706 {
5707 "abstract": true,
5708 "docs": {
5709 "custom": {
5710 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-propagatetags"
5711 },
5712 "remarks": "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.",
5713 "stability": "external",
5714 "summary": "Specifies whether to propagate the tags from the task definition to the task."
5715 },
5716 "immutable": true,
5717 "locationInModule": {
5718 "filename": "lib/events.generated.ts",
5719 "line": 3619
5720 },
5721 "name": "propagateTags",
5722 "optional": true,
5723 "type": {
5724 "primitive": "string"
5725 }
5726 },
5727 {
5728 "abstract": true,
5729 "docs": {
5730 "custom": {
5731 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-referenceid"
5732 },
5733 "stability": "external",
5734 "summary": "The reference ID to use for the task."
5735 },
5736 "immutable": true,
5737 "locationInModule": {
5738 "filename": "lib/events.generated.ts",
5739 "line": 3625
5740 },
5741 "name": "referenceId",
5742 "optional": true,
5743 "type": {
5744 "primitive": "string"
5745 }
5746 },
5747 {
5748 "abstract": true,
5749 "docs": {
5750 "custom": {
5751 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taglist"
5752 },
5753 "remarks": "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.",
5754 "stability": "external",
5755 "summary": "The metadata that you apply to the task to help you categorize and organize them."
5756 },
5757 "immutable": true,
5758 "locationInModule": {
5759 "filename": "lib/events.generated.ts",
5760 "line": 3631
5761 },
5762 "name": "tagList",
5763 "optional": true,
5764 "type": {
5765 "union": {
5766 "types": [
5767 {
5768 "fqn": "@aws-cdk/core.IResolvable"
5769 },
5770 {
5771 "collection": {
5772 "elementtype": {
5773 "union": {
5774 "types": [
5775 {
5776 "fqn": "@aws-cdk/core.IResolvable"
5777 },
5778 {
5779 "fqn": "@aws-cdk/core.CfnTag"
5780 }
5781 ]
5782 }
5783 },
5784 "kind": "array"
5785 }
5786 }
5787 ]
5788 }
5789 }
5790 },
5791 {
5792 "abstract": true,
5793 "docs": {
5794 "custom": {
5795 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-taskcount"
5796 },
5797 "remarks": "The default is 1.",
5798 "stability": "external",
5799 "summary": "The number of tasks to create based on `TaskDefinition` ."
5800 },
5801 "immutable": true,
5802 "locationInModule": {
5803 "filename": "lib/events.generated.ts",
5804 "line": 3637
5805 },
5806 "name": "taskCount",
5807 "optional": true,
5808 "type": {
5809 "primitive": "number"
5810 }
5811 }
5812 ],
5813 "symbolId": "lib/events.generated:CfnRule.EcsParametersProperty"
5814 },
5815 "@aws-cdk/aws-events.CfnRule.HttpParametersProperty": {
5816 "assembly": "@aws-cdk/aws-events",
5817 "datatype": true,
5818 "docs": {
5819 "custom": {
5820 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html",
5821 "exampleMetadata": "fixture=_generated"
5822 },
5823 "remarks": "In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.",
5824 "stability": "external",
5825 "summary": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.",
5826 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst httpParametersProperty: events.CfnRule.HttpParametersProperty = {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n};"
5827 },
5828 "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty",
5829 "kind": "interface",
5830 "locationInModule": {
5831 "filename": "lib/events.generated.ts",
5832 "line": 3744
5833 },
5834 "name": "HttpParametersProperty",
5835 "namespace": "CfnRule",
5836 "properties": [
5837 {
5838 "abstract": true,
5839 "docs": {
5840 "custom": {
5841 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters"
5842 },
5843 "stability": "external",
5844 "summary": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
5845 },
5846 "immutable": true,
5847 "locationInModule": {
5848 "filename": "lib/events.generated.ts",
5849 "line": 3750
5850 },
5851 "name": "headerParameters",
5852 "optional": true,
5853 "type": {
5854 "union": {
5855 "types": [
5856 {
5857 "fqn": "@aws-cdk/core.IResolvable"
5858 },
5859 {
5860 "collection": {
5861 "elementtype": {
5862 "primitive": "string"
5863 },
5864 "kind": "map"
5865 }
5866 }
5867 ]
5868 }
5869 }
5870 },
5871 {
5872 "abstract": true,
5873 "docs": {
5874 "custom": {
5875 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues"
5876 },
5877 "stability": "external",
5878 "summary": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."
5879 },
5880 "immutable": true,
5881 "locationInModule": {
5882 "filename": "lib/events.generated.ts",
5883 "line": 3756
5884 },
5885 "name": "pathParameterValues",
5886 "optional": true,
5887 "type": {
5888 "collection": {
5889 "elementtype": {
5890 "primitive": "string"
5891 },
5892 "kind": "array"
5893 }
5894 }
5895 },
5896 {
5897 "abstract": true,
5898 "docs": {
5899 "custom": {
5900 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters"
5901 },
5902 "stability": "external",
5903 "summary": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."
5904 },
5905 "immutable": true,
5906 "locationInModule": {
5907 "filename": "lib/events.generated.ts",
5908 "line": 3762
5909 },
5910 "name": "queryStringParameters",
5911 "optional": true,
5912 "type": {
5913 "union": {
5914 "types": [
5915 {
5916 "fqn": "@aws-cdk/core.IResolvable"
5917 },
5918 {
5919 "collection": {
5920 "elementtype": {
5921 "primitive": "string"
5922 },
5923 "kind": "map"
5924 }
5925 }
5926 ]
5927 }
5928 }
5929 }
5930 ],
5931 "symbolId": "lib/events.generated:CfnRule.HttpParametersProperty"
5932 },
5933 "@aws-cdk/aws-events.CfnRule.InputTransformerProperty": {
5934 "assembly": "@aws-cdk/aws-events",
5935 "datatype": true,
5936 "docs": {
5937 "custom": {
5938 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html",
5939 "exampleMetadata": "fixture=_generated"
5940 },
5941 "stability": "external",
5942 "summary": "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.",
5943 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst inputTransformerProperty: events.CfnRule.InputTransformerProperty = {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n};"
5944 },
5945 "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty",
5946 "kind": "interface",
5947 "locationInModule": {
5948 "filename": "lib/events.generated.ts",
5949 "line": 3829
5950 },
5951 "name": "InputTransformerProperty",
5952 "namespace": "CfnRule",
5953 "properties": [
5954 {
5955 "abstract": true,
5956 "docs": {
5957 "custom": {
5958 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputtemplate"
5959 },
5960 "remarks": "Enclose each `InputPathsMaps` value in brackets: < *value* > The InputTemplate must be valid JSON.\n\nIf `InputTemplate` is a JSON object (surrounded by curly braces), the following restrictions apply:\n\n- The placeholder cannot be used as an object key.\n\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate` .\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \"<instance> is in state <status>\"`\n\n`}`\n\nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \"<instance> is in state \\\"<status>\\\"\"`\n\n`}`\n\nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": '{\"myInstance\": <instance>,\"myStatus\": \"<instance> is in state \\\"<status>\\\"\"}'`\n\n`}`",
5961 "stability": "external",
5962 "summary": "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."
5963 },
5964 "immutable": true,
5965 "locationInModule": {
5966 "filename": "lib/events.generated.ts",
5967 "line": 3885
5968 },
5969 "name": "inputTemplate",
5970 "type": {
5971 "primitive": "string"
5972 }
5973 },
5974 {
5975 "abstract": true,
5976 "docs": {
5977 "custom": {
5978 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html#cfn-events-rule-inputtransformer-inputpathsmap"
5979 },
5980 "remarks": "You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target.\n\n`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.\n\nThe keys cannot start with \" AWS .\"",
5981 "stability": "external",
5982 "summary": "Map of JSON paths to be extracted from the event."
5983 },
5984 "immutable": true,
5985 "locationInModule": {
5986 "filename": "lib/events.generated.ts",
5987 "line": 3839
5988 },
5989 "name": "inputPathsMap",
5990 "optional": true,
5991 "type": {
5992 "union": {
5993 "types": [
5994 {
5995 "fqn": "@aws-cdk/core.IResolvable"
5996 },
5997 {
5998 "collection": {
5999 "elementtype": {
6000 "primitive": "string"
6001 },
6002 "kind": "map"
6003 }
6004 }
6005 ]
6006 }
6007 }
6008 }
6009 ],
6010 "symbolId": "lib/events.generated:CfnRule.InputTransformerProperty"
6011 },
6012 "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty": {
6013 "assembly": "@aws-cdk/aws-events",
6014 "datatype": true,
6015 "docs": {
6016 "custom": {
6017 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html",
6018 "exampleMetadata": "fixture=_generated"
6019 },
6020 "remarks": "If you do not include this parameter, the default is to use the `eventId` as the partition key.",
6021 "stability": "external",
6022 "summary": "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.",
6023 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst kinesisParametersProperty: events.CfnRule.KinesisParametersProperty = {\n partitionKeyPath: 'partitionKeyPath',\n};"
6024 },
6025 "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty",
6026 "kind": "interface",
6027 "locationInModule": {
6028 "filename": "lib/events.generated.ts",
6029 "line": 3950
6030 },
6031 "name": "KinesisParametersProperty",
6032 "namespace": "CfnRule",
6033 "properties": [
6034 {
6035 "abstract": true,
6036 "docs": {
6037 "custom": {
6038 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-kinesisparameters.html#cfn-events-rule-kinesisparameters-partitionkeypath"
6039 },
6040 "remarks": "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* .",
6041 "stability": "external",
6042 "summary": "The JSON path to be extracted from the event and used as the partition key."
6043 },
6044 "immutable": true,
6045 "locationInModule": {
6046 "filename": "lib/events.generated.ts",
6047 "line": 3956
6048 },
6049 "name": "partitionKeyPath",
6050 "type": {
6051 "primitive": "string"
6052 }
6053 }
6054 ],
6055 "symbolId": "lib/events.generated:CfnRule.KinesisParametersProperty"
6056 },
6057 "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty": {
6058 "assembly": "@aws-cdk/aws-events",
6059 "datatype": true,
6060 "docs": {
6061 "custom": {
6062 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html",
6063 "exampleMetadata": "fixture=_generated"
6064 },
6065 "stability": "external",
6066 "summary": "This structure specifies the network configuration for an ECS task.",
6067 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst networkConfigurationProperty: events.CfnRule.NetworkConfigurationProperty = {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n};"
6068 },
6069 "fqn": "@aws-cdk/aws-events.CfnRule.NetworkConfigurationProperty",
6070 "kind": "interface",
6071 "locationInModule": {
6072 "filename": "lib/events.generated.ts",
6073 "line": 4018
6074 },
6075 "name": "NetworkConfigurationProperty",
6076 "namespace": "CfnRule",
6077 "properties": [
6078 {
6079 "abstract": true,
6080 "docs": {
6081 "custom": {
6082 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-networkconfiguration.html#cfn-events-rule-networkconfiguration-awsvpcconfiguration"
6083 },
6084 "remarks": "This structure is relevant only for ECS tasks that use the `awsvpc` network mode.",
6085 "stability": "external",
6086 "summary": "Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used."
6087 },
6088 "immutable": true,
6089 "locationInModule": {
6090 "filename": "lib/events.generated.ts",
6091 "line": 4024
6092 },
6093 "name": "awsVpcConfiguration",
6094 "optional": true,
6095 "type": {
6096 "union": {
6097 "types": [
6098 {
6099 "fqn": "@aws-cdk/core.IResolvable"
6100 },
6101 {
6102 "fqn": "@aws-cdk/aws-events.CfnRule.AwsVpcConfigurationProperty"
6103 }
6104 ]
6105 }
6106 }
6107 }
6108 ],
6109 "symbolId": "lib/events.generated:CfnRule.NetworkConfigurationProperty"
6110 },
6111 "@aws-cdk/aws-events.CfnRule.PlacementConstraintProperty": {
6112 "assembly": "@aws-cdk/aws-events",
6113 "datatype": true,
6114 "docs": {
6115 "custom": {
6116 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html",
6117 "exampleMetadata": "fixture=_generated"
6118 },
6119 "remarks": "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.",
6120 "stability": "external",
6121 "summary": "An object representing a constraint on task placement.",
6122 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst placementConstraintProperty: events.CfnRule.PlacementConstraintProperty = {\n expression: 'expression',\n type: 'type',\n};"
6123 },
6124 "fqn": "@aws-cdk/aws-events.CfnRule.PlacementConstraintProperty",
6125 "kind": "interface",
6126 "locationInModule": {
6127 "filename": "lib/events.generated.ts",
6128 "line": 4085
6129 },
6130 "name": "PlacementConstraintProperty",
6131 "namespace": "CfnRule",
6132 "properties": [
6133 {
6134 "abstract": true,
6135 "docs": {
6136 "custom": {
6137 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-expression"
6138 },
6139 "remarks": "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.",
6140 "stability": "external",
6141 "summary": "A cluster query language expression to apply to the constraint."
6142 },
6143 "immutable": true,
6144 "locationInModule": {
6145 "filename": "lib/events.generated.ts",
6146 "line": 4091
6147 },
6148 "name": "expression",
6149 "optional": true,
6150 "type": {
6151 "primitive": "string"
6152 }
6153 },
6154 {
6155 "abstract": true,
6156 "docs": {
6157 "custom": {
6158 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementconstraint.html#cfn-events-rule-placementconstraint-type"
6159 },
6160 "remarks": "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.",
6161 "stability": "external",
6162 "summary": "The type of constraint."
6163 },
6164 "immutable": true,
6165 "locationInModule": {
6166 "filename": "lib/events.generated.ts",
6167 "line": 4097
6168 },
6169 "name": "type",
6170 "optional": true,
6171 "type": {
6172 "primitive": "string"
6173 }
6174 }
6175 ],
6176 "symbolId": "lib/events.generated:CfnRule.PlacementConstraintProperty"
6177 },
6178 "@aws-cdk/aws-events.CfnRule.PlacementStrategyProperty": {
6179 "assembly": "@aws-cdk/aws-events",
6180 "datatype": true,
6181 "docs": {
6182 "custom": {
6183 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html",
6184 "exampleMetadata": "fixture=_generated"
6185 },
6186 "remarks": "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.",
6187 "stability": "external",
6188 "summary": "The task placement strategy for a task or service.",
6189 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst placementStrategyProperty: events.CfnRule.PlacementStrategyProperty = {\n field: 'field',\n type: 'type',\n};"
6190 },
6191 "fqn": "@aws-cdk/aws-events.CfnRule.PlacementStrategyProperty",
6192 "kind": "interface",
6193 "locationInModule": {
6194 "filename": "lib/events.generated.ts",
6195 "line": 4161
6196 },
6197 "name": "PlacementStrategyProperty",
6198 "namespace": "CfnRule",
6199 "properties": [
6200 {
6201 "abstract": true,
6202 "docs": {
6203 "custom": {
6204 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-field"
6205 },
6206 "remarks": "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.",
6207 "stability": "external",
6208 "summary": "The field to apply the placement strategy against."
6209 },
6210 "immutable": true,
6211 "locationInModule": {
6212 "filename": "lib/events.generated.ts",
6213 "line": 4167
6214 },
6215 "name": "field",
6216 "optional": true,
6217 "type": {
6218 "primitive": "string"
6219 }
6220 },
6221 {
6222 "abstract": true,
6223 "docs": {
6224 "custom": {
6225 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-placementstrategy.html#cfn-events-rule-placementstrategy-type"
6226 },
6227 "remarks": "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).",
6228 "stability": "external",
6229 "summary": "The type of placement strategy."
6230 },
6231 "immutable": true,
6232 "locationInModule": {
6233 "filename": "lib/events.generated.ts",
6234 "line": 4173
6235 },
6236 "name": "type",
6237 "optional": true,
6238 "type": {
6239 "primitive": "string"
6240 }
6241 }
6242 ],
6243 "symbolId": "lib/events.generated:CfnRule.PlacementStrategyProperty"
6244 },
6245 "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty": {
6246 "assembly": "@aws-cdk/aws-events",
6247 "datatype": true,
6248 "docs": {
6249 "custom": {
6250 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html",
6251 "exampleMetadata": "fixture=_generated"
6252 },
6253 "stability": "external",
6254 "summary": "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.",
6255 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst redshiftDataParametersProperty: events.CfnRule.RedshiftDataParametersProperty = {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n};"
6256 },
6257 "fqn": "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty",
6258 "kind": "interface",
6259 "locationInModule": {
6260 "filename": "lib/events.generated.ts",
6261 "line": 4237
6262 },
6263 "name": "RedshiftDataParametersProperty",
6264 "namespace": "CfnRule",
6265 "properties": [
6266 {
6267 "abstract": true,
6268 "docs": {
6269 "custom": {
6270 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database"
6271 },
6272 "remarks": "Required when authenticating using temporary credentials.",
6273 "stability": "external",
6274 "summary": "The name of the database."
6275 },
6276 "immutable": true,
6277 "locationInModule": {
6278 "filename": "lib/events.generated.ts",
6279 "line": 4243
6280 },
6281 "name": "database",
6282 "type": {
6283 "primitive": "string"
6284 }
6285 },
6286 {
6287 "abstract": true,
6288 "docs": {
6289 "custom": {
6290 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql"
6291 },
6292 "stability": "external",
6293 "summary": "The SQL statement text to run."
6294 },
6295 "immutable": true,
6296 "locationInModule": {
6297 "filename": "lib/events.generated.ts",
6298 "line": 4261
6299 },
6300 "name": "sql",
6301 "type": {
6302 "primitive": "string"
6303 }
6304 },
6305 {
6306 "abstract": true,
6307 "docs": {
6308 "custom": {
6309 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser"
6310 },
6311 "remarks": "Required when authenticating using temporary credentials.",
6312 "stability": "external",
6313 "summary": "The database user name."
6314 },
6315 "immutable": true,
6316 "locationInModule": {
6317 "filename": "lib/events.generated.ts",
6318 "line": 4249
6319 },
6320 "name": "dbUser",
6321 "optional": true,
6322 "type": {
6323 "primitive": "string"
6324 }
6325 },
6326 {
6327 "abstract": true,
6328 "docs": {
6329 "custom": {
6330 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn"
6331 },
6332 "remarks": "Required when authenticating using AWS Secrets Manager.",
6333 "stability": "external",
6334 "summary": "The name or ARN of the secret that enables access to the database."
6335 },
6336 "immutable": true,
6337 "locationInModule": {
6338 "filename": "lib/events.generated.ts",
6339 "line": 4255
6340 },
6341 "name": "secretManagerArn",
6342 "optional": true,
6343 "type": {
6344 "primitive": "string"
6345 }
6346 },
6347 {
6348 "abstract": true,
6349 "docs": {
6350 "custom": {
6351 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname"
6352 },
6353 "remarks": "You can name the SQL statement when you create it to identify the query.",
6354 "stability": "external",
6355 "summary": "The name of the SQL statement."
6356 },
6357 "immutable": true,
6358 "locationInModule": {
6359 "filename": "lib/events.generated.ts",
6360 "line": 4267
6361 },
6362 "name": "statementName",
6363 "optional": true,
6364 "type": {
6365 "primitive": "string"
6366 }
6367 },
6368 {
6369 "abstract": true,
6370 "docs": {
6371 "custom": {
6372 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent"
6373 },
6374 "stability": "external",
6375 "summary": "Indicates whether to send an event back to EventBridge after the SQL statement runs."
6376 },
6377 "immutable": true,
6378 "locationInModule": {
6379 "filename": "lib/events.generated.ts",
6380 "line": 4273
6381 },
6382 "name": "withEvent",
6383 "optional": true,
6384 "type": {
6385 "union": {
6386 "types": [
6387 {
6388 "primitive": "boolean"
6389 },
6390 {
6391 "fqn": "@aws-cdk/core.IResolvable"
6392 }
6393 ]
6394 }
6395 }
6396 }
6397 ],
6398 "symbolId": "lib/events.generated:CfnRule.RedshiftDataParametersProperty"
6399 },
6400 "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty": {
6401 "assembly": "@aws-cdk/aws-events",
6402 "datatype": true,
6403 "docs": {
6404 "custom": {
6405 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html",
6406 "exampleMetadata": "fixture=_generated"
6407 },
6408 "stability": "external",
6409 "summary": "A `RetryPolicy` object that includes information about the retry policy settings.",
6410 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst retryPolicyProperty: events.CfnRule.RetryPolicyProperty = {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n};"
6411 },
6412 "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty",
6413 "kind": "interface",
6414 "locationInModule": {
6415 "filename": "lib/events.generated.ts",
6416 "line": 4351
6417 },
6418 "name": "RetryPolicyProperty",
6419 "namespace": "CfnRule",
6420 "properties": [
6421 {
6422 "abstract": true,
6423 "docs": {
6424 "custom": {
6425 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumeventageinseconds"
6426 },
6427 "stability": "external",
6428 "summary": "The maximum amount of time, in seconds, to continue to make retry attempts."
6429 },
6430 "immutable": true,
6431 "locationInModule": {
6432 "filename": "lib/events.generated.ts",
6433 "line": 4357
6434 },
6435 "name": "maximumEventAgeInSeconds",
6436 "optional": true,
6437 "type": {
6438 "primitive": "number"
6439 }
6440 },
6441 {
6442 "abstract": true,
6443 "docs": {
6444 "custom": {
6445 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-retrypolicy.html#cfn-events-rule-retrypolicy-maximumretryattempts"
6446 },
6447 "remarks": "Retry attempts continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is met.",
6448 "stability": "external",
6449 "summary": "The maximum number of retry attempts to make before the request fails."
6450 },
6451 "immutable": true,
6452 "locationInModule": {
6453 "filename": "lib/events.generated.ts",
6454 "line": 4363
6455 },
6456 "name": "maximumRetryAttempts",
6457 "optional": true,
6458 "type": {
6459 "primitive": "number"
6460 }
6461 }
6462 ],
6463 "symbolId": "lib/events.generated:CfnRule.RetryPolicyProperty"
6464 },
6465 "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty": {
6466 "assembly": "@aws-cdk/aws-events",
6467 "datatype": true,
6468 "docs": {
6469 "custom": {
6470 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html",
6471 "exampleMetadata": "fixture=_generated"
6472 },
6473 "stability": "external",
6474 "summary": "This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.",
6475 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst runCommandParametersProperty: events.CfnRule.RunCommandParametersProperty = {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n};"
6476 },
6477 "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty",
6478 "kind": "interface",
6479 "locationInModule": {
6480 "filename": "lib/events.generated.ts",
6481 "line": 4427
6482 },
6483 "name": "RunCommandParametersProperty",
6484 "namespace": "CfnRule",
6485 "properties": [
6486 {
6487 "abstract": true,
6488 "docs": {
6489 "custom": {
6490 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandparameters.html#cfn-events-rule-runcommandparameters-runcommandtargets"
6491 },
6492 "stability": "external",
6493 "summary": "Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag."
6494 },
6495 "immutable": true,
6496 "locationInModule": {
6497 "filename": "lib/events.generated.ts",
6498 "line": 4433
6499 },
6500 "name": "runCommandTargets",
6501 "type": {
6502 "union": {
6503 "types": [
6504 {
6505 "fqn": "@aws-cdk/core.IResolvable"
6506 },
6507 {
6508 "collection": {
6509 "elementtype": {
6510 "union": {
6511 "types": [
6512 {
6513 "fqn": "@aws-cdk/core.IResolvable"
6514 },
6515 {
6516 "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty"
6517 }
6518 ]
6519 }
6520 },
6521 "kind": "array"
6522 }
6523 }
6524 ]
6525 }
6526 }
6527 }
6528 ],
6529 "symbolId": "lib/events.generated:CfnRule.RunCommandParametersProperty"
6530 },
6531 "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty": {
6532 "assembly": "@aws-cdk/aws-events",
6533 "datatype": true,
6534 "docs": {
6535 "custom": {
6536 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html",
6537 "exampleMetadata": "fixture=_generated"
6538 },
6539 "remarks": "Each `RunCommandTarget` block can include only one key, but this key may specify multiple values.",
6540 "stability": "external",
6541 "summary": "Information about the EC2 instances that are to be sent the command, specified as key-value pairs.",
6542 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst runCommandTargetProperty: events.CfnRule.RunCommandTargetProperty = {\n key: 'key',\n values: ['values'],\n};"
6543 },
6544 "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandTargetProperty",
6545 "kind": "interface",
6546 "locationInModule": {
6547 "filename": "lib/events.generated.ts",
6548 "line": 4495
6549 },
6550 "name": "RunCommandTargetProperty",
6551 "namespace": "CfnRule",
6552 "properties": [
6553 {
6554 "abstract": true,
6555 "docs": {
6556 "custom": {
6557 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-key"
6558 },
6559 "stability": "external",
6560 "summary": "Can be either `tag:` *tag-key* or `InstanceIds` ."
6561 },
6562 "immutable": true,
6563 "locationInModule": {
6564 "filename": "lib/events.generated.ts",
6565 "line": 4501
6566 },
6567 "name": "key",
6568 "type": {
6569 "primitive": "string"
6570 }
6571 },
6572 {
6573 "abstract": true,
6574 "docs": {
6575 "custom": {
6576 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-runcommandtarget.html#cfn-events-rule-runcommandtarget-values"
6577 },
6578 "remarks": "If `Key` is `InstanceIds` , `Values` is a list of Amazon EC2 instance IDs.",
6579 "stability": "external",
6580 "summary": "If `Key` is `tag:` *tag-key* , `Values` is a list of tag values."
6581 },
6582 "immutable": true,
6583 "locationInModule": {
6584 "filename": "lib/events.generated.ts",
6585 "line": 4507
6586 },
6587 "name": "values",
6588 "type": {
6589 "collection": {
6590 "elementtype": {
6591 "primitive": "string"
6592 },
6593 "kind": "array"
6594 }
6595 }
6596 }
6597 ],
6598 "symbolId": "lib/events.generated:CfnRule.RunCommandTargetProperty"
6599 },
6600 "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParameterProperty": {
6601 "assembly": "@aws-cdk/aws-events",
6602 "datatype": true,
6603 "docs": {
6604 "custom": {
6605 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html",
6606 "exampleMetadata": "fixture=_generated"
6607 },
6608 "stability": "external",
6609 "summary": "Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.",
6610 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sageMakerPipelineParameterProperty: events.CfnRule.SageMakerPipelineParameterProperty = {\n name: 'name',\n value: 'value',\n};"
6611 },
6612 "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParameterProperty",
6613 "kind": "interface",
6614 "locationInModule": {
6615 "filename": "lib/events.generated.ts",
6616 "line": 4573
6617 },
6618 "name": "SageMakerPipelineParameterProperty",
6619 "namespace": "CfnRule",
6620 "properties": [
6621 {
6622 "abstract": true,
6623 "docs": {
6624 "custom": {
6625 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-name"
6626 },
6627 "stability": "external",
6628 "summary": "Name of parameter to start execution of a SageMaker Model Building Pipeline."
6629 },
6630 "immutable": true,
6631 "locationInModule": {
6632 "filename": "lib/events.generated.ts",
6633 "line": 4579
6634 },
6635 "name": "name",
6636 "type": {
6637 "primitive": "string"
6638 }
6639 },
6640 {
6641 "abstract": true,
6642 "docs": {
6643 "custom": {
6644 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameter.html#cfn-events-rule-sagemakerpipelineparameter-value"
6645 },
6646 "stability": "external",
6647 "summary": "Value of parameter to start execution of a SageMaker Model Building Pipeline."
6648 },
6649 "immutable": true,
6650 "locationInModule": {
6651 "filename": "lib/events.generated.ts",
6652 "line": 4585
6653 },
6654 "name": "value",
6655 "type": {
6656 "primitive": "string"
6657 }
6658 }
6659 ],
6660 "symbolId": "lib/events.generated:CfnRule.SageMakerPipelineParameterProperty"
6661 },
6662 "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty": {
6663 "assembly": "@aws-cdk/aws-events",
6664 "datatype": true,
6665 "docs": {
6666 "custom": {
6667 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html",
6668 "exampleMetadata": "fixture=_generated"
6669 },
6670 "stability": "external",
6671 "summary": "These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.",
6672 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sageMakerPipelineParametersProperty: events.CfnRule.SageMakerPipelineParametersProperty = {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n};"
6673 },
6674 "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty",
6675 "kind": "interface",
6676 "locationInModule": {
6677 "filename": "lib/events.generated.ts",
6678 "line": 4651
6679 },
6680 "name": "SageMakerPipelineParametersProperty",
6681 "namespace": "CfnRule",
6682 "properties": [
6683 {
6684 "abstract": true,
6685 "docs": {
6686 "custom": {
6687 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sagemakerpipelineparameters.html#cfn-events-rule-sagemakerpipelineparameters-pipelineparameterlist"
6688 },
6689 "stability": "external",
6690 "summary": "List of Parameter names and values for SageMaker Model Building Pipeline execution."
6691 },
6692 "immutable": true,
6693 "locationInModule": {
6694 "filename": "lib/events.generated.ts",
6695 "line": 4657
6696 },
6697 "name": "pipelineParameterList",
6698 "optional": true,
6699 "type": {
6700 "union": {
6701 "types": [
6702 {
6703 "fqn": "@aws-cdk/core.IResolvable"
6704 },
6705 {
6706 "collection": {
6707 "elementtype": {
6708 "union": {
6709 "types": [
6710 {
6711 "fqn": "@aws-cdk/core.IResolvable"
6712 },
6713 {
6714 "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParameterProperty"
6715 }
6716 ]
6717 }
6718 },
6719 "kind": "array"
6720 }
6721 }
6722 ]
6723 }
6724 }
6725 }
6726 ],
6727 "symbolId": "lib/events.generated:CfnRule.SageMakerPipelineParametersProperty"
6728 },
6729 "@aws-cdk/aws-events.CfnRule.SqsParametersProperty": {
6730 "assembly": "@aws-cdk/aws-events",
6731 "datatype": true,
6732 "docs": {
6733 "custom": {
6734 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html",
6735 "exampleMetadata": "fixture=_generated"
6736 },
6737 "stability": "external",
6738 "summary": "This structure includes the custom parameter to be used when the target is an SQS FIFO queue.",
6739 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst sqsParametersProperty: events.CfnRule.SqsParametersProperty = {\n messageGroupId: 'messageGroupId',\n};"
6740 },
6741 "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty",
6742 "kind": "interface",
6743 "locationInModule": {
6744 "filename": "lib/events.generated.ts",
6745 "line": 4718
6746 },
6747 "name": "SqsParametersProperty",
6748 "namespace": "CfnRule",
6749 "properties": [
6750 {
6751 "abstract": true,
6752 "docs": {
6753 "custom": {
6754 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-sqsparameters.html#cfn-events-rule-sqsparameters-messagegroupid"
6755 },
6756 "stability": "external",
6757 "summary": "The FIFO message group ID to use as the target."
6758 },
6759 "immutable": true,
6760 "locationInModule": {
6761 "filename": "lib/events.generated.ts",
6762 "line": 4724
6763 },
6764 "name": "messageGroupId",
6765 "type": {
6766 "primitive": "string"
6767 }
6768 }
6769 ],
6770 "symbolId": "lib/events.generated:CfnRule.SqsParametersProperty"
6771 },
6772 "@aws-cdk/aws-events.CfnRule.TagProperty": {
6773 "assembly": "@aws-cdk/aws-events",
6774 "datatype": true,
6775 "docs": {
6776 "custom": {
6777 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html",
6778 "exampleMetadata": "fixture=_generated"
6779 },
6780 "remarks": "The tag will be propagated to ECS by EventBridge when starting an ECS task based on a matched event.\n\n> Currently, tags are only available when using ECS with EventBridge .",
6781 "stability": "external",
6782 "summary": "A key-value pair associated with an ECS Target of an EventBridge rule.",
6783 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst tagProperty: events.CfnRule.TagProperty = {\n key: 'key',\n value: 'value',\n};"
6784 },
6785 "fqn": "@aws-cdk/aws-events.CfnRule.TagProperty",
6786 "kind": "interface",
6787 "locationInModule": {
6788 "filename": "lib/events.generated.ts",
6789 "line": 4788
6790 },
6791 "name": "TagProperty",
6792 "namespace": "CfnRule",
6793 "properties": [
6794 {
6795 "abstract": true,
6796 "docs": {
6797 "custom": {
6798 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-key"
6799 },
6800 "remarks": "The combination of tag keys and values can help you organize and categorize your resources.",
6801 "stability": "external",
6802 "summary": "A string you can use to assign a value."
6803 },
6804 "immutable": true,
6805 "locationInModule": {
6806 "filename": "lib/events.generated.ts",
6807 "line": 4794
6808 },
6809 "name": "key",
6810 "optional": true,
6811 "type": {
6812 "primitive": "string"
6813 }
6814 },
6815 {
6816 "abstract": true,
6817 "docs": {
6818 "custom": {
6819 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-tag.html#cfn-events-rule-tag-value"
6820 },
6821 "stability": "external",
6822 "summary": "The value for the specified tag key."
6823 },
6824 "immutable": true,
6825 "locationInModule": {
6826 "filename": "lib/events.generated.ts",
6827 "line": 4800
6828 },
6829 "name": "value",
6830 "optional": true,
6831 "type": {
6832 "primitive": "string"
6833 }
6834 }
6835 ],
6836 "symbolId": "lib/events.generated:CfnRule.TagProperty"
6837 },
6838 "@aws-cdk/aws-events.CfnRule.TargetProperty": {
6839 "assembly": "@aws-cdk/aws-events",
6840 "datatype": true,
6841 "docs": {
6842 "custom": {
6843 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html",
6844 "exampleMetadata": "fixture=_generated"
6845 },
6846 "remarks": "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) .\n\nIf 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* .",
6847 "stability": "external",
6848 "summary": "Targets are the resources to be invoked when a rule is triggered.",
6849 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst targetProperty: events.CfnRule.TargetProperty = {\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n};"
6850 },
6851 "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty",
6852 "kind": "interface",
6853 "locationInModule": {
6854 "filename": "lib/events.generated.ts",
6855 "line": 4866
6856 },
6857 "name": "TargetProperty",
6858 "namespace": "CfnRule",
6859 "properties": [
6860 {
6861 "abstract": true,
6862 "docs": {
6863 "custom": {
6864 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-arn"
6865 },
6866 "stability": "external",
6867 "summary": "The Amazon Resource Name (ARN) of the target."
6868 },
6869 "immutable": true,
6870 "locationInModule": {
6871 "filename": "lib/events.generated.ts",
6872 "line": 4872
6873 },
6874 "name": "arn",
6875 "type": {
6876 "primitive": "string"
6877 }
6878 },
6879 {
6880 "abstract": true,
6881 "docs": {
6882 "custom": {
6883 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id"
6884 },
6885 "remarks": "Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.",
6886 "stability": "external",
6887 "summary": "The ID of the target within the specified rule."
6888 },
6889 "immutable": true,
6890 "locationInModule": {
6891 "filename": "lib/events.generated.ts",
6892 "line": 4904
6893 },
6894 "name": "id",
6895 "type": {
6896 "primitive": "string"
6897 }
6898 },
6899 {
6900 "abstract": true,
6901 "docs": {
6902 "custom": {
6903 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-batchparameters"
6904 },
6905 "remarks": "For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* .",
6906 "stability": "external",
6907 "summary": "If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters."
6908 },
6909 "immutable": true,
6910 "locationInModule": {
6911 "filename": "lib/events.generated.ts",
6912 "line": 4878
6913 },
6914 "name": "batchParameters",
6915 "optional": true,
6916 "type": {
6917 "union": {
6918 "types": [
6919 {
6920 "fqn": "@aws-cdk/core.IResolvable"
6921 },
6922 {
6923 "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty"
6924 }
6925 ]
6926 }
6927 }
6928 },
6929 {
6930 "abstract": true,
6931 "docs": {
6932 "custom": {
6933 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig"
6934 },
6935 "stability": "external",
6936 "summary": "The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to."
6937 },
6938 "immutable": true,
6939 "locationInModule": {
6940 "filename": "lib/events.generated.ts",
6941 "line": 4884
6942 },
6943 "name": "deadLetterConfig",
6944 "optional": true,
6945 "type": {
6946 "union": {
6947 "types": [
6948 {
6949 "fqn": "@aws-cdk/core.IResolvable"
6950 },
6951 {
6952 "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty"
6953 }
6954 ]
6955 }
6956 }
6957 },
6958 {
6959 "abstract": true,
6960 "docs": {
6961 "custom": {
6962 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-ecsparameters"
6963 },
6964 "remarks": "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* .",
6965 "stability": "external",
6966 "summary": "Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task."
6967 },
6968 "immutable": true,
6969 "locationInModule": {
6970 "filename": "lib/events.generated.ts",
6971 "line": 4890
6972 },
6973 "name": "ecsParameters",
6974 "optional": true,
6975 "type": {
6976 "union": {
6977 "types": [
6978 {
6979 "fqn": "@aws-cdk/core.IResolvable"
6980 },
6981 {
6982 "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty"
6983 }
6984 ]
6985 }
6986 }
6987 },
6988 {
6989 "abstract": true,
6990 "docs": {
6991 "custom": {
6992 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-httpparameters"
6993 },
6994 "remarks": "If you specify an API Gateway REST 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.",
6995 "stability": "external",
6996 "summary": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination."
6997 },
6998 "immutable": true,
6999 "locationInModule": {
7000 "filename": "lib/events.generated.ts",
7001 "line": 4898
7002 },
7003 "name": "httpParameters",
7004 "optional": true,
7005 "type": {
7006 "union": {
7007 "types": [
7008 {
7009 "fqn": "@aws-cdk/core.IResolvable"
7010 },
7011 {
7012 "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty"
7013 }
7014 ]
7015 }
7016 }
7017 },
7018 {
7019 "abstract": true,
7020 "docs": {
7021 "custom": {
7022 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input"
7023 },
7024 "remarks": "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) .",
7025 "stability": "external",
7026 "summary": "Valid JSON text passed to the target."
7027 },
7028 "immutable": true,
7029 "locationInModule": {
7030 "filename": "lib/events.generated.ts",
7031 "line": 4910
7032 },
7033 "name": "input",
7034 "optional": true,
7035 "type": {
7036 "primitive": "string"
7037 }
7038 },
7039 {
7040 "abstract": true,
7041 "docs": {
7042 "custom": {
7043 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath"
7044 },
7045 "remarks": "You must use JSON dot notation, not bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) .",
7046 "stability": "external",
7047 "summary": "The value of the JSONPath that is used for extracting part of the matched event when passing it to the target."
7048 },
7049 "immutable": true,
7050 "locationInModule": {
7051 "filename": "lib/events.generated.ts",
7052 "line": 4916
7053 },
7054 "name": "inputPath",
7055 "optional": true,
7056 "type": {
7057 "primitive": "string"
7058 }
7059 },
7060 {
7061 "abstract": true,
7062 "docs": {
7063 "custom": {
7064 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer"
7065 },
7066 "remarks": "You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.",
7067 "stability": "external",
7068 "summary": "Settings to enable you to provide custom input to a target based on certain event data."
7069 },
7070 "immutable": true,
7071 "locationInModule": {
7072 "filename": "lib/events.generated.ts",
7073 "line": 4922
7074 },
7075 "name": "inputTransformer",
7076 "optional": true,
7077 "type": {
7078 "union": {
7079 "types": [
7080 {
7081 "fqn": "@aws-cdk/core.IResolvable"
7082 },
7083 {
7084 "fqn": "@aws-cdk/aws-events.CfnRule.InputTransformerProperty"
7085 }
7086 ]
7087 }
7088 }
7089 },
7090 {
7091 "abstract": true,
7092 "docs": {
7093 "custom": {
7094 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-kinesisparameters"
7095 },
7096 "remarks": "If you do not include this parameter, the default is to use the `eventId` as the partition key.",
7097 "stability": "external",
7098 "summary": "The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream."
7099 },
7100 "immutable": true,
7101 "locationInModule": {
7102 "filename": "lib/events.generated.ts",
7103 "line": 4928
7104 },
7105 "name": "kinesisParameters",
7106 "optional": true,
7107 "type": {
7108 "union": {
7109 "types": [
7110 {
7111 "fqn": "@aws-cdk/core.IResolvable"
7112 },
7113 {
7114 "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty"
7115 }
7116 ]
7117 }
7118 }
7119 },
7120 {
7121 "abstract": true,
7122 "docs": {
7123 "custom": {
7124 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-redshiftdataparameters"
7125 },
7126 "remarks": "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.",
7127 "stability": "external",
7128 "summary": "Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster."
7129 },
7130 "immutable": true,
7131 "locationInModule": {
7132 "filename": "lib/events.generated.ts",
7133 "line": 4936
7134 },
7135 "name": "redshiftDataParameters",
7136 "optional": true,
7137 "type": {
7138 "union": {
7139 "types": [
7140 {
7141 "fqn": "@aws-cdk/core.IResolvable"
7142 },
7143 {
7144 "fqn": "@aws-cdk/aws-events.CfnRule.RedshiftDataParametersProperty"
7145 }
7146 ]
7147 }
7148 }
7149 },
7150 {
7151 "abstract": true,
7152 "docs": {
7153 "custom": {
7154 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy"
7155 },
7156 "stability": "external",
7157 "summary": "The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue."
7158 },
7159 "immutable": true,
7160 "locationInModule": {
7161 "filename": "lib/events.generated.ts",
7162 "line": 4942
7163 },
7164 "name": "retryPolicy",
7165 "optional": true,
7166 "type": {
7167 "union": {
7168 "types": [
7169 {
7170 "fqn": "@aws-cdk/core.IResolvable"
7171 },
7172 {
7173 "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty"
7174 }
7175 ]
7176 }
7177 }
7178 },
7179 {
7180 "abstract": true,
7181 "docs": {
7182 "custom": {
7183 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn"
7184 },
7185 "remarks": "If one rule triggers multiple targets, you can use a different IAM role for each target.",
7186 "stability": "external",
7187 "summary": "The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered."
7188 },
7189 "immutable": true,
7190 "locationInModule": {
7191 "filename": "lib/events.generated.ts",
7192 "line": 4948
7193 },
7194 "name": "roleArn",
7195 "optional": true,
7196 "type": {
7197 "primitive": "string"
7198 }
7199 },
7200 {
7201 "abstract": true,
7202 "docs": {
7203 "custom": {
7204 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-runcommandparameters"
7205 },
7206 "stability": "external",
7207 "summary": "Parameters used when you are using the rule to invoke Amazon EC2 Run Command."
7208 },
7209 "immutable": true,
7210 "locationInModule": {
7211 "filename": "lib/events.generated.ts",
7212 "line": 4954
7213 },
7214 "name": "runCommandParameters",
7215 "optional": true,
7216 "type": {
7217 "union": {
7218 "types": [
7219 {
7220 "fqn": "@aws-cdk/core.IResolvable"
7221 },
7222 {
7223 "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty"
7224 }
7225 ]
7226 }
7227 }
7228 },
7229 {
7230 "abstract": true,
7231 "docs": {
7232 "custom": {
7233 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sagemakerpipelineparameters"
7234 },
7235 "remarks": "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.",
7236 "stability": "external",
7237 "summary": "Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline."
7238 },
7239 "immutable": true,
7240 "locationInModule": {
7241 "filename": "lib/events.generated.ts",
7242 "line": 4962
7243 },
7244 "name": "sageMakerPipelineParameters",
7245 "optional": true,
7246 "type": {
7247 "union": {
7248 "types": [
7249 {
7250 "fqn": "@aws-cdk/core.IResolvable"
7251 },
7252 {
7253 "fqn": "@aws-cdk/aws-events.CfnRule.SageMakerPipelineParametersProperty"
7254 }
7255 ]
7256 }
7257 }
7258 },
7259 {
7260 "abstract": true,
7261 "docs": {
7262 "custom": {
7263 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-sqsparameters"
7264 },
7265 "remarks": "If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.",
7266 "stability": "external",
7267 "summary": "Contains the message group ID to use when the target is a FIFO queue."
7268 },
7269 "immutable": true,
7270 "locationInModule": {
7271 "filename": "lib/events.generated.ts",
7272 "line": 4970
7273 },
7274 "name": "sqsParameters",
7275 "optional": true,
7276 "type": {
7277 "union": {
7278 "types": [
7279 {
7280 "fqn": "@aws-cdk/core.IResolvable"
7281 },
7282 {
7283 "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty"
7284 }
7285 ]
7286 }
7287 }
7288 }
7289 ],
7290 "symbolId": "lib/events.generated:CfnRule.TargetProperty"
7291 },
7292 "@aws-cdk/aws-events.CfnRuleProps": {
7293 "assembly": "@aws-cdk/aws-events",
7294 "datatype": true,
7295 "docs": {
7296 "custom": {
7297 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html",
7298 "exampleMetadata": "fixture=_generated"
7299 },
7300 "stability": "external",
7301 "summary": "Properties for defining a `CfnRule`.",
7302 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\n\ndeclare const eventPattern: any;\nconst cfnRuleProps: events.CfnRuleProps = {\n description: 'description',\n eventBusName: 'eventBusName',\n eventPattern: eventPattern,\n name: 'name',\n roleArn: 'roleArn',\n scheduleExpression: 'scheduleExpression',\n state: 'state',\n targets: [{\n arn: 'arn',\n id: 'id',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n input: 'input',\n inputPath: 'inputPath',\n inputTransformer: {\n inputTemplate: 'inputTemplate',\n\n // the properties below are optional\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n },\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n redshiftDataParameters: {\n database: 'database',\n sql: 'sql',\n\n // the properties below are optional\n dbUser: 'dbUser',\n secretManagerArn: 'secretManagerArn',\n statementName: 'statementName',\n withEvent: false,\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n roleArn: 'roleArn',\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sageMakerPipelineParameters: {\n pipelineParameterList: [{\n name: 'name',\n value: 'value',\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n }],\n};"
7303 },
7304 "fqn": "@aws-cdk/aws-events.CfnRuleProps",
7305 "kind": "interface",
7306 "locationInModule": {
7307 "filename": "lib/events.generated.ts",
7308 "line": 2659
7309 },
7310 "name": "CfnRuleProps",
7311 "properties": [
7312 {
7313 "abstract": true,
7314 "docs": {
7315 "custom": {
7316 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description"
7317 },
7318 "stability": "external",
7319 "summary": "The description of the rule."
7320 },
7321 "immutable": true,
7322 "locationInModule": {
7323 "filename": "lib/events.generated.ts",
7324 "line": 2666
7325 },
7326 "name": "description",
7327 "optional": true,
7328 "type": {
7329 "primitive": "string"
7330 }
7331 },
7332 {
7333 "abstract": true,
7334 "docs": {
7335 "custom": {
7336 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname"
7337 },
7338 "remarks": "If you omit this, the default event bus is used.",
7339 "stability": "external",
7340 "summary": "The name or ARN of the event bus associated with the rule."
7341 },
7342 "immutable": true,
7343 "locationInModule": {
7344 "filename": "lib/events.generated.ts",
7345 "line": 2673
7346 },
7347 "name": "eventBusName",
7348 "optional": true,
7349 "type": {
7350 "primitive": "string"
7351 }
7352 },
7353 {
7354 "abstract": true,
7355 "docs": {
7356 "custom": {
7357 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern"
7358 },
7359 "remarks": "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* .",
7360 "stability": "external",
7361 "summary": "The event pattern of the rule."
7362 },
7363 "immutable": true,
7364 "locationInModule": {
7365 "filename": "lib/events.generated.ts",
7366 "line": 2680
7367 },
7368 "name": "eventPattern",
7369 "optional": true,
7370 "type": {
7371 "primitive": "any"
7372 }
7373 },
7374 {
7375 "abstract": true,
7376 "docs": {
7377 "custom": {
7378 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name"
7379 },
7380 "stability": "external",
7381 "summary": "The name of the rule."
7382 },
7383 "immutable": true,
7384 "locationInModule": {
7385 "filename": "lib/events.generated.ts",
7386 "line": 2687
7387 },
7388 "name": "name",
7389 "optional": true,
7390 "type": {
7391 "primitive": "string"
7392 }
7393 },
7394 {
7395 "abstract": true,
7396 "docs": {
7397 "custom": {
7398 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-rolearn"
7399 },
7400 "remarks": "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.",
7401 "stability": "external",
7402 "summary": "The Amazon Resource Name (ARN) of the role that is used for target invocation."
7403 },
7404 "immutable": true,
7405 "locationInModule": {
7406 "filename": "lib/events.generated.ts",
7407 "line": 2696
7408 },
7409 "name": "roleArn",
7410 "optional": true,
7411 "type": {
7412 "primitive": "string"
7413 }
7414 },
7415 {
7416 "abstract": true,
7417 "docs": {
7418 "custom": {
7419 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression"
7420 },
7421 "remarks": "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) .",
7422 "stability": "external",
7423 "summary": "The scheduling expression."
7424 },
7425 "immutable": true,
7426 "locationInModule": {
7427 "filename": "lib/events.generated.ts",
7428 "line": 2703
7429 },
7430 "name": "scheduleExpression",
7431 "optional": true,
7432 "type": {
7433 "primitive": "string"
7434 }
7435 },
7436 {
7437 "abstract": true,
7438 "docs": {
7439 "custom": {
7440 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state"
7441 },
7442 "stability": "external",
7443 "summary": "The state of the rule."
7444 },
7445 "immutable": true,
7446 "locationInModule": {
7447 "filename": "lib/events.generated.ts",
7448 "line": 2710
7449 },
7450 "name": "state",
7451 "optional": true,
7452 "type": {
7453 "primitive": "string"
7454 }
7455 },
7456 {
7457 "abstract": true,
7458 "docs": {
7459 "custom": {
7460 "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets"
7461 },
7462 "remarks": "Targets are the resources that are invoked when a rule is triggered.\n\n> Each rule can have up to five (5) targets associated with it at one time.\n\nYou can configure the following as targets for Events:\n\n- [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html)\n- [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html)\n- Batch job queue\n- CloudWatch group\n- CodeBuild project\n- CodePipeline\n- EC2 `CreateSnapshot` API call\n- EC2 Image Builder\n- EC2 `RebootInstances` API call\n- EC2 `StopInstances` API call\n- EC2 `TerminateInstances` API call\n- ECS task\n- [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html)\n- [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html)\n- Firehose delivery stream\n- Glue workflow\n- [Incident Manager response plan](https://docs.aws.amazon.com//incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge)\n- Inspector assessment template\n- Kinesis stream\n- Lambda function\n- Redshift cluster\n- SageMaker Pipeline\n- SNS topic\n- SQS queue\n- Step Functions state machine\n- Systems Manager Automation\n- Systems Manager OpsItem\n- Systems Manager Run Command\n\nCreating rules with built-in targets is supported only in the AWS Management Console . The built-in targets are `EC2 CreateSnapshot API call` , `EC2 RebootInstances API call` , `EC2 StopInstances API call` , and `EC2 TerminateInstances API call` .\n\nFor 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.\n\nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets` . 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* .\n\nIf 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/) .\n\n> `Input` , `InputPath` , and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.\n\nIf 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* .\n\nFor more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html) .\n\n*Input* , *InputPath* , and *InputTransformer* are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:\n\n- 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).\n- If *Input* is specified in the form of valid JSON, then the matched event is overridden with this constant.\n- 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).\n- 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.\n\nWhen you specify `InputPath` or `InputTransformer` , you must use JSON dot notation, not bracket notation.\n\nWhen 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.\n\nThis 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.",
7463 "stability": "external",
7464 "summary": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule."
7465 },
7466 "immutable": true,
7467 "locationInModule": {
7468 "filename": "lib/events.generated.ts",
7469 "line": 2779
7470 },
7471 "name": "targets",
7472 "optional": true,
7473 "type": {
7474 "union": {
7475 "types": [
7476 {
7477 "fqn": "@aws-cdk/core.IResolvable"
7478 },
7479 {
7480 "collection": {
7481 "elementtype": {
7482 "union": {
7483 "types": [
7484 {
7485 "fqn": "@aws-cdk/core.IResolvable"
7486 },
7487 {
7488 "fqn": "@aws-cdk/aws-events.CfnRule.TargetProperty"
7489 }
7490 ]
7491 }
7492 },
7493 "kind": "array"
7494 }
7495 }
7496 ]
7497 }
7498 }
7499 }
7500 ],
7501 "symbolId": "lib/events.generated:CfnRuleProps"
7502 },
7503 "@aws-cdk/aws-events.Connection": {
7504 "assembly": "@aws-cdk/aws-events",
7505 "base": "@aws-cdk/core.Resource",
7506 "docs": {
7507 "custom": {
7508 "exampleMetadata": "infused",
7509 "resource": "AWS::Events::Connection"
7510 },
7511 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
7512 "stability": "stable",
7513 "summary": "Define an EventBridge Connection."
7514 },
7515 "fqn": "@aws-cdk/aws-events.Connection",
7516 "initializer": {
7517 "docs": {
7518 "stability": "stable"
7519 },
7520 "locationInModule": {
7521 "filename": "lib/connection.ts",
7522 "line": 340
7523 },
7524 "parameters": [
7525 {
7526 "name": "scope",
7527 "type": {
7528 "fqn": "constructs.Construct"
7529 }
7530 },
7531 {
7532 "name": "id",
7533 "type": {
7534 "primitive": "string"
7535 }
7536 },
7537 {
7538 "name": "props",
7539 "type": {
7540 "fqn": "@aws-cdk/aws-events.ConnectionProps"
7541 }
7542 }
7543 ]
7544 },
7545 "interfaces": [
7546 "@aws-cdk/aws-events.IConnection"
7547 ],
7548 "kind": "class",
7549 "locationInModule": {
7550 "filename": "lib/connection.ts",
7551 "line": 295
7552 },
7553 "methods": [
7554 {
7555 "docs": {
7556 "stability": "stable",
7557 "summary": "Import an existing connection resource."
7558 },
7559 "locationInModule": {
7560 "filename": "lib/connection.ts",
7561 "line": 318
7562 },
7563 "name": "fromConnectionAttributes",
7564 "parameters": [
7565 {
7566 "docs": {
7567 "summary": "Parent construct."
7568 },
7569 "name": "scope",
7570 "type": {
7571 "fqn": "constructs.Construct"
7572 }
7573 },
7574 {
7575 "docs": {
7576 "summary": "Construct ID."
7577 },
7578 "name": "id",
7579 "type": {
7580 "primitive": "string"
7581 }
7582 },
7583 {
7584 "docs": {
7585 "summary": "Imported connection properties."
7586 },
7587 "name": "attrs",
7588 "type": {
7589 "fqn": "@aws-cdk/aws-events.ConnectionAttributes"
7590 }
7591 }
7592 ],
7593 "returns": {
7594 "type": {
7595 "fqn": "@aws-cdk/aws-events.IConnection"
7596 }
7597 },
7598 "static": true
7599 },
7600 {
7601 "docs": {
7602 "stability": "stable",
7603 "summary": "Import an existing connection resource."
7604 },
7605 "locationInModule": {
7606 "filename": "lib/connection.ts",
7607 "line": 302
7608 },
7609 "name": "fromEventBusArn",
7610 "parameters": [
7611 {
7612 "docs": {
7613 "summary": "Parent construct."
7614 },
7615 "name": "scope",
7616 "type": {
7617 "fqn": "constructs.Construct"
7618 }
7619 },
7620 {
7621 "docs": {
7622 "summary": "Construct ID."
7623 },
7624 "name": "id",
7625 "type": {
7626 "primitive": "string"
7627 }
7628 },
7629 {
7630 "docs": {
7631 "summary": "ARN of imported connection."
7632 },
7633 "name": "connectionArn",
7634 "type": {
7635 "primitive": "string"
7636 }
7637 },
7638 {
7639 "name": "connectionSecretArn",
7640 "type": {
7641 "primitive": "string"
7642 }
7643 }
7644 ],
7645 "returns": {
7646 "type": {
7647 "fqn": "@aws-cdk/aws-events.IConnection"
7648 }
7649 },
7650 "static": true
7651 }
7652 ],
7653 "name": "Connection",
7654 "properties": [
7655 {
7656 "docs": {
7657 "custom": {
7658 "attribute": "true"
7659 },
7660 "stability": "stable",
7661 "summary": "The ARN of the connection created."
7662 },
7663 "immutable": true,
7664 "locationInModule": {
7665 "filename": "lib/connection.ts",
7666 "line": 332
7667 },
7668 "name": "connectionArn",
7669 "overrides": "@aws-cdk/aws-events.IConnection",
7670 "type": {
7671 "primitive": "string"
7672 }
7673 },
7674 {
7675 "docs": {
7676 "custom": {
7677 "attribute": "true"
7678 },
7679 "stability": "stable",
7680 "summary": "The Name for the connection."
7681 },
7682 "immutable": true,
7683 "locationInModule": {
7684 "filename": "lib/connection.ts",
7685 "line": 326
7686 },
7687 "name": "connectionName",
7688 "overrides": "@aws-cdk/aws-events.IConnection",
7689 "type": {
7690 "primitive": "string"
7691 }
7692 },
7693 {
7694 "docs": {
7695 "custom": {
7696 "attribute": "true"
7697 },
7698 "stability": "stable",
7699 "summary": "The ARN for the secret created for the connection."
7700 },
7701 "immutable": true,
7702 "locationInModule": {
7703 "filename": "lib/connection.ts",
7704 "line": 338
7705 },
7706 "name": "connectionSecretArn",
7707 "overrides": "@aws-cdk/aws-events.IConnection",
7708 "type": {
7709 "primitive": "string"
7710 }
7711 }
7712 ],
7713 "symbolId": "lib/connection:Connection"
7714 },
7715 "@aws-cdk/aws-events.ConnectionAttributes": {
7716 "assembly": "@aws-cdk/aws-events",
7717 "datatype": true,
7718 "docs": {
7719 "stability": "stable",
7720 "summary": "Interface with properties necessary to import a reusable Connection.",
7721 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst connectionAttributes: events.ConnectionAttributes = {\n connectionArn: 'connectionArn',\n connectionName: 'connectionName',\n connectionSecretArn: 'connectionSecretArn',\n};",
7722 "custom": {
7723 "exampleMetadata": "fixture=_generated"
7724 }
7725 },
7726 "fqn": "@aws-cdk/aws-events.ConnectionAttributes",
7727 "kind": "interface",
7728 "locationInModule": {
7729 "filename": "lib/connection.ts",
7730 "line": 273
7731 },
7732 "name": "ConnectionAttributes",
7733 "properties": [
7734 {
7735 "abstract": true,
7736 "docs": {
7737 "stability": "stable",
7738 "summary": "The ARN of the connection created."
7739 },
7740 "immutable": true,
7741 "locationInModule": {
7742 "filename": "lib/connection.ts",
7743 "line": 282
7744 },
7745 "name": "connectionArn",
7746 "type": {
7747 "primitive": "string"
7748 }
7749 },
7750 {
7751 "abstract": true,
7752 "docs": {
7753 "stability": "stable",
7754 "summary": "The Name for the connection."
7755 },
7756 "immutable": true,
7757 "locationInModule": {
7758 "filename": "lib/connection.ts",
7759 "line": 277
7760 },
7761 "name": "connectionName",
7762 "type": {
7763 "primitive": "string"
7764 }
7765 },
7766 {
7767 "abstract": true,
7768 "docs": {
7769 "stability": "stable",
7770 "summary": "The ARN for the secret created for the connection."
7771 },
7772 "immutable": true,
7773 "locationInModule": {
7774 "filename": "lib/connection.ts",
7775 "line": 287
7776 },
7777 "name": "connectionSecretArn",
7778 "type": {
7779 "primitive": "string"
7780 }
7781 }
7782 ],
7783 "symbolId": "lib/connection:ConnectionAttributes"
7784 },
7785 "@aws-cdk/aws-events.ConnectionProps": {
7786 "assembly": "@aws-cdk/aws-events",
7787 "datatype": true,
7788 "docs": {
7789 "custom": {
7790 "exampleMetadata": "infused"
7791 },
7792 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
7793 "remarks": "A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.",
7794 "stability": "stable",
7795 "summary": "An API Destination Connection."
7796 },
7797 "fqn": "@aws-cdk/aws-events.ConnectionProps",
7798 "kind": "interface",
7799 "locationInModule": {
7800 "filename": "lib/connection.ts",
7801 "line": 10
7802 },
7803 "name": "ConnectionProps",
7804 "properties": [
7805 {
7806 "abstract": true,
7807 "docs": {
7808 "stability": "stable",
7809 "summary": "The authorization type for the connection."
7810 },
7811 "immutable": true,
7812 "locationInModule": {
7813 "filename": "lib/connection.ts",
7814 "line": 28
7815 },
7816 "name": "authorization",
7817 "type": {
7818 "fqn": "@aws-cdk/aws-events.Authorization"
7819 }
7820 },
7821 {
7822 "abstract": true,
7823 "docs": {
7824 "default": "- No additional parameters",
7825 "stability": "stable",
7826 "summary": "Additional string parameters to add to the invocation bodies."
7827 },
7828 "immutable": true,
7829 "locationInModule": {
7830 "filename": "lib/connection.ts",
7831 "line": 35
7832 },
7833 "name": "bodyParameters",
7834 "optional": true,
7835 "type": {
7836 "collection": {
7837 "elementtype": {
7838 "fqn": "@aws-cdk/aws-events.HttpParameter"
7839 },
7840 "kind": "map"
7841 }
7842 }
7843 },
7844 {
7845 "abstract": true,
7846 "docs": {
7847 "default": "- A name is automatically generated",
7848 "stability": "stable",
7849 "summary": "The name of the connection."
7850 },
7851 "immutable": true,
7852 "locationInModule": {
7853 "filename": "lib/connection.ts",
7854 "line": 16
7855 },
7856 "name": "connectionName",
7857 "optional": true,
7858 "type": {
7859 "primitive": "string"
7860 }
7861 },
7862 {
7863 "abstract": true,
7864 "docs": {
7865 "default": "- none",
7866 "stability": "stable",
7867 "summary": "The name of the connection."
7868 },
7869 "immutable": true,
7870 "locationInModule": {
7871 "filename": "lib/connection.ts",
7872 "line": 23
7873 },
7874 "name": "description",
7875 "optional": true,
7876 "type": {
7877 "primitive": "string"
7878 }
7879 },
7880 {
7881 "abstract": true,
7882 "docs": {
7883 "default": "- No additional parameters",
7884 "stability": "stable",
7885 "summary": "Additional string parameters to add to the invocation headers."
7886 },
7887 "immutable": true,
7888 "locationInModule": {
7889 "filename": "lib/connection.ts",
7890 "line": 42
7891 },
7892 "name": "headerParameters",
7893 "optional": true,
7894 "type": {
7895 "collection": {
7896 "elementtype": {
7897 "fqn": "@aws-cdk/aws-events.HttpParameter"
7898 },
7899 "kind": "map"
7900 }
7901 }
7902 },
7903 {
7904 "abstract": true,
7905 "docs": {
7906 "default": "- No additional parameters",
7907 "stability": "stable",
7908 "summary": "Additional string parameters to add to the invocation query strings."
7909 },
7910 "immutable": true,
7911 "locationInModule": {
7912 "filename": "lib/connection.ts",
7913 "line": 49
7914 },
7915 "name": "queryStringParameters",
7916 "optional": true,
7917 "type": {
7918 "collection": {
7919 "elementtype": {
7920 "fqn": "@aws-cdk/aws-events.HttpParameter"
7921 },
7922 "kind": "map"
7923 }
7924 }
7925 }
7926 ],
7927 "symbolId": "lib/connection:ConnectionProps"
7928 },
7929 "@aws-cdk/aws-events.CronOptions": {
7930 "assembly": "@aws-cdk/aws-events",
7931 "datatype": true,
7932 "docs": {
7933 "custom": {
7934 "exampleMetadata": "infused"
7935 },
7936 "example": "import * as events from '@aws-cdk/aws-events';\nimport * as targets from '@aws-cdk/aws-events-targets';\n\ndeclare const fn: lambda.Function;\nconst rule = new events.Rule(this, 'Schedule Rule', {\n schedule: events.Schedule.cron({ minute: '0', hour: '4' }),\n});\nrule.addTarget(new targets.LambdaFunction(fn));",
7937 "remarks": "All fields are strings so you can use complex expressions. Absence of\na field implies '*' or '?', whichever one is appropriate.",
7938 "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions",
7939 "stability": "stable",
7940 "summary": "Options to configure a cron expression."
7941 },
7942 "fqn": "@aws-cdk/aws-events.CronOptions",
7943 "kind": "interface",
7944 "locationInModule": {
7945 "filename": "lib/schedule.ts",
7946 "line": 91
7947 },
7948 "name": "CronOptions",
7949 "properties": [
7950 {
7951 "abstract": true,
7952 "docs": {
7953 "default": "- Every day of the month",
7954 "stability": "stable",
7955 "summary": "The day of the month to run this rule at."
7956 },
7957 "immutable": true,
7958 "locationInModule": {
7959 "filename": "lib/schedule.ts",
7960 "line": 111
7961 },
7962 "name": "day",
7963 "optional": true,
7964 "type": {
7965 "primitive": "string"
7966 }
7967 },
7968 {
7969 "abstract": true,
7970 "docs": {
7971 "default": "- Every hour",
7972 "stability": "stable",
7973 "summary": "The hour to run this rule at."
7974 },
7975 "immutable": true,
7976 "locationInModule": {
7977 "filename": "lib/schedule.ts",
7978 "line": 104
7979 },
7980 "name": "hour",
7981 "optional": true,
7982 "type": {
7983 "primitive": "string"
7984 }
7985 },
7986 {
7987 "abstract": true,
7988 "docs": {
7989 "default": "- Every minute",
7990 "stability": "stable",
7991 "summary": "The minute to run this rule at."
7992 },
7993 "immutable": true,
7994 "locationInModule": {
7995 "filename": "lib/schedule.ts",
7996 "line": 97
7997 },
7998 "name": "minute",
7999 "optional": true,
8000 "type": {
8001 "primitive": "string"
8002 }
8003 },
8004 {
8005 "abstract": true,
8006 "docs": {
8007 "default": "- Every month",
8008 "stability": "stable",
8009 "summary": "The month to run this rule at."
8010 },
8011 "immutable": true,
8012 "locationInModule": {
8013 "filename": "lib/schedule.ts",
8014 "line": 118
8015 },
8016 "name": "month",
8017 "optional": true,
8018 "type": {
8019 "primitive": "string"
8020 }
8021 },
8022 {
8023 "abstract": true,
8024 "docs": {
8025 "default": "- Any day of the week",
8026 "stability": "stable",
8027 "summary": "The day of the week to run this rule at."
8028 },
8029 "immutable": true,
8030 "locationInModule": {
8031 "filename": "lib/schedule.ts",
8032 "line": 132
8033 },
8034 "name": "weekDay",
8035 "optional": true,
8036 "type": {
8037 "primitive": "string"
8038 }
8039 },
8040 {
8041 "abstract": true,
8042 "docs": {
8043 "default": "- Every year",
8044 "stability": "stable",
8045 "summary": "The year to run this rule at."
8046 },
8047 "immutable": true,
8048 "locationInModule": {
8049 "filename": "lib/schedule.ts",
8050 "line": 125
8051 },
8052 "name": "year",
8053 "optional": true,
8054 "type": {
8055 "primitive": "string"
8056 }
8057 }
8058 ],
8059 "symbolId": "lib/schedule:CronOptions"
8060 },
8061 "@aws-cdk/aws-events.EventBus": {
8062 "assembly": "@aws-cdk/aws-events",
8063 "base": "@aws-cdk/core.Resource",
8064 "docs": {
8065 "custom": {
8066 "exampleMetadata": "infused",
8067 "resource": "AWS::Events::EventBus"
8068 },
8069 "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});",
8070 "stability": "stable",
8071 "summary": "Define an EventBridge EventBus."
8072 },
8073 "fqn": "@aws-cdk/aws-events.EventBus",
8074 "initializer": {
8075 "docs": {
8076 "stability": "stable"
8077 },
8078 "locationInModule": {
8079 "filename": "lib/event-bus.ts",
8080 "line": 310
8081 },
8082 "parameters": [
8083 {
8084 "name": "scope",
8085 "type": {
8086 "fqn": "constructs.Construct"
8087 }
8088 },
8089 {
8090 "name": "id",
8091 "type": {
8092 "primitive": "string"
8093 }
8094 },
8095 {
8096 "name": "props",
8097 "optional": true,
8098 "type": {
8099 "fqn": "@aws-cdk/aws-events.EventBusProps"
8100 }
8101 }
8102 ]
8103 },
8104 "interfaces": [
8105 "@aws-cdk/aws-events.IEventBus"
8106 ],
8107 "kind": "class",
8108 "locationInModule": {
8109 "filename": "lib/event-bus.ts",
8110 "line": 163
8111 },
8112 "methods": [
8113 {
8114 "docs": {
8115 "stability": "stable",
8116 "summary": "Import an existing event bus resource."
8117 },
8118 "locationInModule": {
8119 "filename": "lib/event-bus.ts",
8120 "line": 171
8121 },
8122 "name": "fromEventBusArn",
8123 "parameters": [
8124 {
8125 "docs": {
8126 "summary": "Parent construct."
8127 },
8128 "name": "scope",
8129 "type": {
8130 "fqn": "constructs.Construct"
8131 }
8132 },
8133 {
8134 "docs": {
8135 "summary": "Construct ID."
8136 },
8137 "name": "id",
8138 "type": {
8139 "primitive": "string"
8140 }
8141 },
8142 {
8143 "docs": {
8144 "summary": "ARN of imported event bus."
8145 },
8146 "name": "eventBusArn",
8147 "type": {
8148 "primitive": "string"
8149 }
8150 }
8151 ],
8152 "returns": {
8153 "type": {
8154 "fqn": "@aws-cdk/aws-events.IEventBus"
8155 }
8156 },
8157 "static": true
8158 },
8159 {
8160 "docs": {
8161 "stability": "stable",
8162 "summary": "Import an existing event bus resource."
8163 },
8164 "locationInModule": {
8165 "filename": "lib/event-bus.ts",
8166 "line": 207
8167 },
8168 "name": "fromEventBusAttributes",
8169 "parameters": [
8170 {
8171 "docs": {
8172 "summary": "Parent construct."
8173 },
8174 "name": "scope",
8175 "type": {
8176 "fqn": "constructs.Construct"
8177 }
8178 },
8179 {
8180 "docs": {
8181 "summary": "Construct ID."
8182 },
8183 "name": "id",
8184 "type": {
8185 "primitive": "string"
8186 }
8187 },
8188 {
8189 "docs": {
8190 "summary": "Imported event bus properties."
8191 },
8192 "name": "attrs",
8193 "type": {
8194 "fqn": "@aws-cdk/aws-events.EventBusAttributes"
8195 }
8196 }
8197 ],
8198 "returns": {
8199 "type": {
8200 "fqn": "@aws-cdk/aws-events.IEventBus"
8201 }
8202 },
8203 "static": true
8204 },
8205 {
8206 "docs": {
8207 "stability": "stable",
8208 "summary": "Import an existing event bus resource."
8209 },
8210 "locationInModule": {
8211 "filename": "lib/event-bus.ts",
8212 "line": 187
8213 },
8214 "name": "fromEventBusName",
8215 "parameters": [
8216 {
8217 "docs": {
8218 "summary": "Parent construct."
8219 },
8220 "name": "scope",
8221 "type": {
8222 "fqn": "constructs.Construct"
8223 }
8224 },
8225 {
8226 "docs": {
8227 "summary": "Construct ID."
8228 },
8229 "name": "id",
8230 "type": {
8231 "primitive": "string"
8232 }
8233 },
8234 {
8235 "docs": {
8236 "summary": "Name of imported event bus."
8237 },
8238 "name": "eventBusName",
8239 "type": {
8240 "primitive": "string"
8241 }
8242 }
8243 ],
8244 "returns": {
8245 "type": {
8246 "fqn": "@aws-cdk/aws-events.IEventBus"
8247 }
8248 },
8249 "static": true
8250 },
8251 {
8252 "docs": {
8253 "stability": "stable",
8254 "summary": "Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules."
8255 },
8256 "locationInModule": {
8257 "filename": "lib/event-bus.ts",
8258 "line": 234
8259 },
8260 "name": "grantAllPutEvents",
8261 "parameters": [
8262 {
8263 "docs": {
8264 "summary": "The principal (no-op if undefined)."
8265 },
8266 "name": "grantee",
8267 "type": {
8268 "fqn": "@aws-cdk/aws-iam.IGrantable"
8269 }
8270 }
8271 ],
8272 "returns": {
8273 "type": {
8274 "fqn": "@aws-cdk/aws-iam.Grant"
8275 }
8276 },
8277 "static": true
8278 },
8279 {
8280 "docs": {
8281 "deprecated": "use grantAllPutEvents instead",
8282 "stability": "deprecated",
8283 "summary": "Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules."
8284 },
8285 "locationInModule": {
8286 "filename": "lib/event-bus.ts",
8287 "line": 218
8288 },
8289 "name": "grantPutEvents",
8290 "parameters": [
8291 {
8292 "docs": {
8293 "summary": "The principal (no-op if undefined)."
8294 },
8295 "name": "grantee",
8296 "type": {
8297 "fqn": "@aws-cdk/aws-iam.IGrantable"
8298 }
8299 }
8300 ],
8301 "returns": {
8302 "type": {
8303 "fqn": "@aws-cdk/aws-iam.Grant"
8304 }
8305 },
8306 "static": true
8307 },
8308 {
8309 "docs": {
8310 "remarks": "When you create an archive, incoming events might not immediately start being sent to the archive.\nAllow a short period of time for changes to take effect.",
8311 "stability": "stable",
8312 "summary": "Create an EventBridge archive to send events to."
8313 },
8314 "locationInModule": {
8315 "filename": "lib/event-bus.ts",
8316 "line": 139
8317 },
8318 "name": "archive",
8319 "overrides": "@aws-cdk/aws-events.IEventBus",
8320 "parameters": [
8321 {
8322 "name": "id",
8323 "type": {
8324 "primitive": "string"
8325 }
8326 },
8327 {
8328 "name": "props",
8329 "type": {
8330 "fqn": "@aws-cdk/aws-events.BaseArchiveProps"
8331 }
8332 }
8333 ],
8334 "returns": {
8335 "type": {
8336 "fqn": "@aws-cdk/aws-events.Archive"
8337 }
8338 }
8339 },
8340 {
8341 "docs": {
8342 "stability": "stable",
8343 "summary": "Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules."
8344 },
8345 "locationInModule": {
8346 "filename": "lib/event-bus.ts",
8347 "line": 149
8348 },
8349 "name": "grantPutEventsTo",
8350 "overrides": "@aws-cdk/aws-events.IEventBus",
8351 "parameters": [
8352 {
8353 "name": "grantee",
8354 "type": {
8355 "fqn": "@aws-cdk/aws-iam.IGrantable"
8356 }
8357 }
8358 ],
8359 "returns": {
8360 "type": {
8361 "fqn": "@aws-cdk/aws-iam.Grant"
8362 }
8363 }
8364 }
8365 ],
8366 "name": "EventBus",
8367 "properties": [
8368 {
8369 "docs": {
8370 "stability": "stable",
8371 "summary": "The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1."
8372 },
8373 "immutable": true,
8374 "locationInModule": {
8375 "filename": "lib/event-bus.ts",
8376 "line": 298
8377 },
8378 "name": "eventBusArn",
8379 "overrides": "@aws-cdk/aws-events.IEventBus",
8380 "type": {
8381 "primitive": "string"
8382 }
8383 },
8384 {
8385 "docs": {
8386 "stability": "stable",
8387 "summary": "The physical ID of this event bus resource."
8388 },
8389 "immutable": true,
8390 "locationInModule": {
8391 "filename": "lib/event-bus.ts",
8392 "line": 292
8393 },
8394 "name": "eventBusName",
8395 "overrides": "@aws-cdk/aws-events.IEventBus",
8396 "type": {
8397 "primitive": "string"
8398 }
8399 },
8400 {
8401 "docs": {
8402 "stability": "stable",
8403 "summary": "The policy for the event bus in JSON form."
8404 },
8405 "immutable": true,
8406 "locationInModule": {
8407 "filename": "lib/event-bus.ts",
8408 "line": 303
8409 },
8410 "name": "eventBusPolicy",
8411 "overrides": "@aws-cdk/aws-events.IEventBus",
8412 "type": {
8413 "primitive": "string"
8414 }
8415 },
8416 {
8417 "docs": {
8418 "stability": "stable",
8419 "summary": "The name of the partner event source."
8420 },
8421 "immutable": true,
8422 "locationInModule": {
8423 "filename": "lib/event-bus.ts",
8424 "line": 308
8425 },
8426 "name": "eventSourceName",
8427 "optional": true,
8428 "overrides": "@aws-cdk/aws-events.IEventBus",
8429 "type": {
8430 "primitive": "string"
8431 }
8432 }
8433 ],
8434 "symbolId": "lib/event-bus:EventBus"
8435 },
8436 "@aws-cdk/aws-events.EventBusAttributes": {
8437 "assembly": "@aws-cdk/aws-events",
8438 "datatype": true,
8439 "docs": {
8440 "stability": "stable",
8441 "summary": "Interface with properties necessary to import a reusable EventBus.",
8442 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst eventBusAttributes: events.EventBusAttributes = {\n eventBusArn: 'eventBusArn',\n eventBusName: 'eventBusName',\n eventBusPolicy: 'eventBusPolicy',\n\n // the properties below are optional\n eventSourceName: 'eventSourceName',\n};",
8443 "custom": {
8444 "exampleMetadata": "fixture=_generated"
8445 }
8446 },
8447 "fqn": "@aws-cdk/aws-events.EventBusAttributes",
8448 "kind": "interface",
8449 "locationInModule": {
8450 "filename": "lib/event-bus.ts",
8451 "line": 86
8452 },
8453 "name": "EventBusAttributes",
8454 "properties": [
8455 {
8456 "abstract": true,
8457 "docs": {
8458 "custom": {
8459 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt"
8460 },
8461 "stability": "stable",
8462 "summary": "The ARN of this event bus resource."
8463 },
8464 "immutable": true,
8465 "locationInModule": {
8466 "filename": "lib/event-bus.ts",
8467 "line": 99
8468 },
8469 "name": "eventBusArn",
8470 "type": {
8471 "primitive": "string"
8472 }
8473 },
8474 {
8475 "abstract": true,
8476 "docs": {
8477 "custom": {
8478 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name"
8479 },
8480 "stability": "stable",
8481 "summary": "The physical ID of this event bus resource."
8482 },
8483 "immutable": true,
8484 "locationInModule": {
8485 "filename": "lib/event-bus.ts",
8486 "line": 92
8487 },
8488 "name": "eventBusName",
8489 "type": {
8490 "primitive": "string"
8491 }
8492 },
8493 {
8494 "abstract": true,
8495 "docs": {
8496 "custom": {
8497 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt"
8498 },
8499 "stability": "stable",
8500 "summary": "The JSON policy of this event bus resource."
8501 },
8502 "immutable": true,
8503 "locationInModule": {
8504 "filename": "lib/event-bus.ts",
8505 "line": 106
8506 },
8507 "name": "eventBusPolicy",
8508 "type": {
8509 "primitive": "string"
8510 }
8511 },
8512 {
8513 "abstract": true,
8514 "docs": {
8515 "custom": {
8516 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename"
8517 },
8518 "default": "- no partner event source",
8519 "stability": "stable",
8520 "summary": "The partner event source to associate with this event bus resource."
8521 },
8522 "immutable": true,
8523 "locationInModule": {
8524 "filename": "lib/event-bus.ts",
8525 "line": 114
8526 },
8527 "name": "eventSourceName",
8528 "optional": true,
8529 "type": {
8530 "primitive": "string"
8531 }
8532 }
8533 ],
8534 "symbolId": "lib/event-bus:EventBusAttributes"
8535 },
8536 "@aws-cdk/aws-events.EventBusProps": {
8537 "assembly": "@aws-cdk/aws-events",
8538 "datatype": true,
8539 "docs": {
8540 "custom": {
8541 "exampleMetadata": "infused"
8542 },
8543 "example": "const bus = new events.EventBus(this, 'bus', {\n eventBusName: 'MyCustomEventBus'\n});\n\nbus.archive('MyArchive', {\n archiveName: 'MyCustomEventBusArchive',\n description: 'MyCustomerEventBus Archive',\n eventPattern: {\n account: [Stack.of(this).account],\n },\n retention: Duration.days(365),\n});",
8544 "stability": "stable",
8545 "summary": "Properties to define an event bus."
8546 },
8547 "fqn": "@aws-cdk/aws-events.EventBusProps",
8548 "kind": "interface",
8549 "locationInModule": {
8550 "filename": "lib/event-bus.ts",
8551 "line": 63
8552 },
8553 "name": "EventBusProps",
8554 "properties": [
8555 {
8556 "abstract": true,
8557 "docs": {
8558 "custom": {
8559 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name"
8560 },
8561 "default": "- automatically generated name",
8562 "stability": "stable",
8563 "summary": "The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this."
8564 },
8565 "immutable": true,
8566 "locationInModule": {
8567 "filename": "lib/event-bus.ts",
8568 "line": 71
8569 },
8570 "name": "eventBusName",
8571 "optional": true,
8572 "type": {
8573 "primitive": "string"
8574 }
8575 },
8576 {
8577 "abstract": true,
8578 "docs": {
8579 "custom": {
8580 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename"
8581 },
8582 "default": "- no partner event source",
8583 "stability": "stable",
8584 "summary": "The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this."
8585 },
8586 "immutable": true,
8587 "locationInModule": {
8588 "filename": "lib/event-bus.ts",
8589 "line": 80
8590 },
8591 "name": "eventSourceName",
8592 "optional": true,
8593 "type": {
8594 "primitive": "string"
8595 }
8596 }
8597 ],
8598 "symbolId": "lib/event-bus:EventBusProps"
8599 },
8600 "@aws-cdk/aws-events.EventField": {
8601 "assembly": "@aws-cdk/aws-events",
8602 "docs": {
8603 "stability": "stable",
8604 "summary": "Represents a field in the event pattern."
8605 },
8606 "fqn": "@aws-cdk/aws-events.EventField",
8607 "interfaces": [
8608 "@aws-cdk/core.IResolvable"
8609 ],
8610 "kind": "class",
8611 "locationInModule": {
8612 "filename": "lib/input.ts",
8613 "line": 242
8614 },
8615 "methods": [
8616 {
8617 "docs": {
8618 "stability": "stable",
8619 "summary": "Extract a custom JSON path from the event."
8620 },
8621 "locationInModule": {
8622 "filename": "lib/input.ts",
8623 "line": 288
8624 },
8625 "name": "fromPath",
8626 "parameters": [
8627 {
8628 "name": "path",
8629 "type": {
8630 "primitive": "string"
8631 }
8632 }
8633 ],
8634 "returns": {
8635 "type": {
8636 "primitive": "string"
8637 }
8638 },
8639 "static": true
8640 },
8641 {
8642 "docs": {
8643 "stability": "stable",
8644 "summary": "Produce the Token's value at resolution time."
8645 },
8646 "locationInModule": {
8647 "filename": "lib/input.ts",
8648 "line": 308
8649 },
8650 "name": "resolve",
8651 "overrides": "@aws-cdk/core.IResolvable",
8652 "parameters": [
8653 {
8654 "name": "_ctx",
8655 "type": {
8656 "fqn": "@aws-cdk/core.IResolveContext"
8657 }
8658 }
8659 ],
8660 "returns": {
8661 "type": {
8662 "primitive": "any"
8663 }
8664 }
8665 },
8666 {
8667 "docs": {
8668 "stability": "stable",
8669 "summary": "Convert the path to the field in the event pattern to JSON."
8670 },
8671 "locationInModule": {
8672 "filename": "lib/input.ts",
8673 "line": 319
8674 },
8675 "name": "toJSON",
8676 "returns": {
8677 "type": {
8678 "primitive": "string"
8679 }
8680 }
8681 },
8682 {
8683 "docs": {
8684 "remarks": "Returns a reversible string representation.",
8685 "stability": "stable",
8686 "summary": "Return a string representation of this resolvable object."
8687 },
8688 "locationInModule": {
8689 "filename": "lib/input.ts",
8690 "line": 312
8691 },
8692 "name": "toString",
8693 "overrides": "@aws-cdk/core.IResolvable",
8694 "returns": {
8695 "type": {
8696 "primitive": "string"
8697 }
8698 }
8699 }
8700 ],
8701 "name": "EventField",
8702 "properties": [
8703 {
8704 "docs": {
8705 "stability": "stable",
8706 "summary": "Extract the account from the event."
8707 },
8708 "immutable": true,
8709 "locationInModule": {
8710 "filename": "lib/input.ts",
8711 "line": 267
8712 },
8713 "name": "account",
8714 "static": true,
8715 "type": {
8716 "primitive": "string"
8717 }
8718 },
8719 {
8720 "docs": {
8721 "stability": "stable",
8722 "summary": "Extract the detail type from the event."
8723 },
8724 "immutable": true,
8725 "locationInModule": {
8726 "filename": "lib/input.ts",
8727 "line": 253
8728 },
8729 "name": "detailType",
8730 "static": true,
8731 "type": {
8732 "primitive": "string"
8733 }
8734 },
8735 {
8736 "docs": {
8737 "stability": "stable",
8738 "summary": "Extract the event ID from the event."
8739 },
8740 "immutable": true,
8741 "locationInModule": {
8742 "filename": "lib/input.ts",
8743 "line": 246
8744 },
8745 "name": "eventId",
8746 "static": true,
8747 "type": {
8748 "primitive": "string"
8749 }
8750 },
8751 {
8752 "docs": {
8753 "stability": "stable",
8754 "summary": "Extract the region from the event."
8755 },
8756 "immutable": true,
8757 "locationInModule": {
8758 "filename": "lib/input.ts",
8759 "line": 281
8760 },
8761 "name": "region",
8762 "static": true,
8763 "type": {
8764 "primitive": "string"
8765 }
8766 },
8767 {
8768 "docs": {
8769 "stability": "stable",
8770 "summary": "Extract the source from the event."
8771 },
8772 "immutable": true,
8773 "locationInModule": {
8774 "filename": "lib/input.ts",
8775 "line": 260
8776 },
8777 "name": "source",
8778 "static": true,
8779 "type": {
8780 "primitive": "string"
8781 }
8782 },
8783 {
8784 "docs": {
8785 "stability": "stable",
8786 "summary": "Extract the time from the event."
8787 },
8788 "immutable": true,
8789 "locationInModule": {
8790 "filename": "lib/input.ts",
8791 "line": 274
8792 },
8793 "name": "time",
8794 "static": true,
8795 "type": {
8796 "primitive": "string"
8797 }
8798 },
8799 {
8800 "docs": {
8801 "remarks": "This may return an array with a single informational element indicating how\nto get this property populated, if it was skipped for performance reasons.",
8802 "stability": "stable",
8803 "summary": "The creation stack of this resolvable which will be appended to errors thrown during resolution."
8804 },
8805 "immutable": true,
8806 "locationInModule": {
8807 "filename": "lib/input.ts",
8808 "line": 296
8809 },
8810 "name": "creationStack",
8811 "overrides": "@aws-cdk/core.IResolvable",
8812 "type": {
8813 "collection": {
8814 "elementtype": {
8815 "primitive": "string"
8816 },
8817 "kind": "array"
8818 }
8819 }
8820 },
8821 {
8822 "docs": {
8823 "stability": "stable",
8824 "summary": "Human readable display hint about the event pattern."
8825 },
8826 "immutable": true,
8827 "locationInModule": {
8828 "filename": "lib/input.ts",
8829 "line": 295
8830 },
8831 "name": "displayHint",
8832 "type": {
8833 "primitive": "string"
8834 }
8835 },
8836 {
8837 "docs": {
8838 "stability": "stable",
8839 "summary": "the path to a field in the event pattern."
8840 },
8841 "immutable": true,
8842 "locationInModule": {
8843 "filename": "lib/input.ts",
8844 "line": 302
8845 },
8846 "name": "path",
8847 "type": {
8848 "primitive": "string"
8849 }
8850 }
8851 ],
8852 "symbolId": "lib/input:EventField"
8853 },
8854 "@aws-cdk/aws-events.EventPattern": {
8855 "assembly": "@aws-cdk/aws-events",
8856 "datatype": true,
8857 "docs": {
8858 "custom": {
8859 "exampleMetadata": "infused"
8860 },
8861 "example": "import * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunc', {\n runtime: lambda.Runtime.NODEJS_12_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`exports.handler = handler.toString()`),\n});\n\nconst rule = new events.Rule(this, 'rule', {\n eventPattern: {\n source: [\"aws.ec2\"],\n },\n});\n\nconst queue = new sqs.Queue(this, 'Queue');\n\nrule.addTarget(new targets.LambdaFunction(fn, {\n deadLetterQueue: queue, // Optional: add a dead letter queue\n maxEventAge: cdk.Duration.hours(2), // Optional: set the maxEventAge retry policy\n retryAttempts: 2, // Optional: set the max number of retry attempts\n}));",
8862 "remarks": "**Important**: this class can only be used with a `Rule` class. In particular,\ndo not use it with `CfnRule` class: your pattern will not be rendered\ncorrectly. In a `CfnRule` class, write the pattern as you normally would when\ndirectly writing CloudFormation.\n\nRules use event patterns to select events and route them to targets. A\npattern either matches an event or it doesn't. Event patterns are represented\nas JSON objects with a structure that is similar to that of events.\n\nIt is important to remember the following about event pattern matching:\n\n- For a pattern to match an event, the event must contain all the field names\n listed in the pattern. The field names must appear in the event with the\n same nesting structure.\n\n- Other fields of the event not mentioned in the pattern are ignored;\n effectively, there is a ``\"*\": \"*\"`` wildcard for fields not mentioned.\n\n- The matching is exact (character-by-character), without case-folding or any\n other string normalization.\n\n- The values being matched follow JSON rules: Strings enclosed in quotes,\n numbers, and the unquoted keywords true, false, and null.\n\n- Number matching is at the string representation level. For example, 300,\n 300.0, and 3.0e2 are not considered equal.",
8863 "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html",
8864 "stability": "stable",
8865 "summary": "Events in Amazon CloudWatch Events are represented as JSON objects. For more information about JSON objects, see RFC 7159."
8866 },
8867 "fqn": "@aws-cdk/aws-events.EventPattern",
8868 "kind": "interface",
8869 "locationInModule": {
8870 "filename": "lib/event-pattern.ts",
8871 "line": 34
8872 },
8873 "name": "EventPattern",
8874 "properties": [
8875 {
8876 "abstract": true,
8877 "docs": {
8878 "default": "- No filtering on account",
8879 "stability": "stable",
8880 "summary": "The 12-digit number identifying an AWS account."
8881 },
8882 "immutable": true,
8883 "locationInModule": {
8884 "filename": "lib/event-pattern.ts",
8885 "line": 80
8886 },
8887 "name": "account",
8888 "optional": true,
8889 "type": {
8890 "collection": {
8891 "elementtype": {
8892 "primitive": "string"
8893 },
8894 "kind": "array"
8895 }
8896 }
8897 },
8898 {
8899 "abstract": true,
8900 "docs": {
8901 "default": "- No filtering on detail",
8902 "stability": "stable",
8903 "summary": "A JSON object, whose content is at the discretion of the service originating the event."
8904 },
8905 "immutable": true,
8906 "locationInModule": {
8907 "filename": "lib/event-pattern.ts",
8908 "line": 119
8909 },
8910 "name": "detail",
8911 "optional": true,
8912 "type": {
8913 "collection": {
8914 "elementtype": {
8915 "primitive": "any"
8916 },
8917 "kind": "map"
8918 }
8919 }
8920 },
8921 {
8922 "abstract": true,
8923 "docs": {
8924 "default": "- No filtering on detail type",
8925 "remarks": "Represents the \"detail-type\" event field.",
8926 "stability": "stable",
8927 "summary": "Identifies, in combination with the source field, the fields and values that appear in the detail field."
8928 },
8929 "immutable": true,
8930 "locationInModule": {
8931 "filename": "lib/event-pattern.ts",
8932 "line": 58
8933 },
8934 "name": "detailType",
8935 "optional": true,
8936 "type": {
8937 "collection": {
8938 "elementtype": {
8939 "primitive": "string"
8940 },
8941 "kind": "array"
8942 }
8943 }
8944 },
8945 {
8946 "abstract": true,
8947 "docs": {
8948 "default": "- No filtering on id",
8949 "remarks": "This can be helpful in\ntracing events as they move through rules to targets, and are processed.",
8950 "stability": "stable",
8951 "summary": "A unique value is generated for every event."
8952 },
8953 "immutable": true,
8954 "locationInModule": {
8955 "filename": "lib/event-pattern.ts",
8956 "line": 48
8957 },
8958 "name": "id",
8959 "optional": true,
8960 "type": {
8961 "collection": {
8962 "elementtype": {
8963 "primitive": "string"
8964 },
8965 "kind": "array"
8966 }
8967 }
8968 },
8969 {
8970 "abstract": true,
8971 "docs": {
8972 "default": "- No filtering on region",
8973 "stability": "stable",
8974 "summary": "Identifies the AWS region where the event originated."
8975 },
8976 "immutable": true,
8977 "locationInModule": {
8978 "filename": "lib/event-pattern.ts",
8979 "line": 97
8980 },
8981 "name": "region",
8982 "optional": true,
8983 "type": {
8984 "collection": {
8985 "elementtype": {
8986 "primitive": "string"
8987 },
8988 "kind": "array"
8989 }
8990 }
8991 },
8992 {
8993 "abstract": true,
8994 "docs": {
8995 "default": "- No filtering on resource",
8996 "remarks": "Inclusion of these ARNs is at the discretion of the\nservice.\n\nFor example, Amazon EC2 instance state-changes include Amazon EC2\ninstance ARNs, Auto Scaling events include ARNs for both instances and\nAuto Scaling groups, but API calls with AWS CloudTrail do not include\nresource ARNs.",
8997 "stability": "stable",
8998 "summary": "This JSON array contains ARNs that identify resources that are involved in the event."
8999 },
9000 "immutable": true,
9001 "locationInModule": {
9002 "filename": "lib/event-pattern.ts",
9003 "line": 111
9004 },
9005 "name": "resources",
9006 "optional": true,
9007 "type": {
9008 "collection": {
9009 "elementtype": {
9010 "primitive": "string"
9011 },
9012 "kind": "array"
9013 }
9014 }
9015 },
9016 {
9017 "abstract": true,
9018 "docs": {
9019 "default": "- No filtering on source",
9020 "remarks": "All events sourced from\nwithin AWS begin with \"aws.\" Customer-generated events can have any value\nhere, as long as it doesn't begin with \"aws.\" We recommend the use of\nJava package-name style reverse domain-name strings.\n\nTo find the correct value for source for an AWS service, see the table in\nAWS Service Namespaces. For example, the source value for Amazon\nCloudFront is aws.cloudfront.",
9021 "see": "http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces",
9022 "stability": "stable",
9023 "summary": "Identifies the service that sourced the event."
9024 },
9025 "immutable": true,
9026 "locationInModule": {
9027 "filename": "lib/event-pattern.ts",
9028 "line": 73
9029 },
9030 "name": "source",
9031 "optional": true,
9032 "type": {
9033 "collection": {
9034 "elementtype": {
9035 "primitive": "string"
9036 },
9037 "kind": "array"
9038 }
9039 }
9040 },
9041 {
9042 "abstract": true,
9043 "docs": {
9044 "default": "- No filtering on time",
9045 "remarks": "If the event spans a time interval, the service might choose\nto report the start time, so this value can be noticeably before the time\nthe event is actually received.",
9046 "stability": "stable",
9047 "summary": "The event timestamp, which can be specified by the service originating the event."
9048 },
9049 "immutable": true,
9050 "locationInModule": {
9051 "filename": "lib/event-pattern.ts",
9052 "line": 90
9053 },
9054 "name": "time",
9055 "optional": true,
9056 "type": {
9057 "collection": {
9058 "elementtype": {
9059 "primitive": "string"
9060 },
9061 "kind": "array"
9062 }
9063 }
9064 },
9065 {
9066 "abstract": true,
9067 "docs": {
9068 "default": "- No filtering on version",
9069 "stability": "stable",
9070 "summary": "By default, this is set to 0 (zero) in all events."
9071 },
9072 "immutable": true,
9073 "locationInModule": {
9074 "filename": "lib/event-pattern.ts",
9075 "line": 40
9076 },
9077 "name": "version",
9078 "optional": true,
9079 "type": {
9080 "collection": {
9081 "elementtype": {
9082 "primitive": "string"
9083 },
9084 "kind": "array"
9085 }
9086 }
9087 }
9088 ],
9089 "symbolId": "lib/event-pattern:EventPattern"
9090 },
9091 "@aws-cdk/aws-events.HttpMethod": {
9092 "assembly": "@aws-cdk/aws-events",
9093 "docs": {
9094 "stability": "stable",
9095 "summary": "Supported HTTP operations."
9096 },
9097 "fqn": "@aws-cdk/aws-events.HttpMethod",
9098 "kind": "enum",
9099 "locationInModule": {
9100 "filename": "lib/connection.ts",
9101 "line": 389
9102 },
9103 "members": [
9104 {
9105 "docs": {
9106 "stability": "stable",
9107 "summary": "POST."
9108 },
9109 "name": "POST"
9110 },
9111 {
9112 "docs": {
9113 "stability": "stable",
9114 "summary": "GET."
9115 },
9116 "name": "GET"
9117 },
9118 {
9119 "docs": {
9120 "stability": "stable",
9121 "summary": "HEAD."
9122 },
9123 "name": "HEAD"
9124 },
9125 {
9126 "docs": {
9127 "stability": "stable",
9128 "summary": "OPTIONS."
9129 },
9130 "name": "OPTIONS"
9131 },
9132 {
9133 "docs": {
9134 "stability": "stable",
9135 "summary": "PUT."
9136 },
9137 "name": "PUT"
9138 },
9139 {
9140 "docs": {
9141 "stability": "stable",
9142 "summary": "PATCH."
9143 },
9144 "name": "PATCH"
9145 },
9146 {
9147 "docs": {
9148 "stability": "stable",
9149 "summary": "DELETE."
9150 },
9151 "name": "DELETE"
9152 }
9153 ],
9154 "name": "HttpMethod",
9155 "symbolId": "lib/connection:HttpMethod"
9156 },
9157 "@aws-cdk/aws-events.HttpParameter": {
9158 "abstract": true,
9159 "assembly": "@aws-cdk/aws-events",
9160 "docs": {
9161 "stability": "stable",
9162 "summary": "An additional HTTP parameter to send along with the OAuth request.",
9163 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const secretValue: cdk.SecretValue;\nconst httpParameter = events.HttpParameter.fromSecret(secretValue);",
9164 "custom": {
9165 "exampleMetadata": "fixture=_generated"
9166 }
9167 },
9168 "fqn": "@aws-cdk/aws-events.HttpParameter",
9169 "initializer": {
9170 "docs": {
9171 "stability": "stable"
9172 }
9173 },
9174 "kind": "class",
9175 "locationInModule": {
9176 "filename": "lib/connection.ts",
9177 "line": 190
9178 },
9179 "methods": [
9180 {
9181 "docs": {
9182 "stability": "stable",
9183 "summary": "Make an OAuthParameter from a secret."
9184 },
9185 "locationInModule": {
9186 "filename": "lib/connection.ts",
9187 "line": 210
9188 },
9189 "name": "fromSecret",
9190 "parameters": [
9191 {
9192 "name": "value",
9193 "type": {
9194 "fqn": "@aws-cdk/core.SecretValue"
9195 }
9196 }
9197 ],
9198 "returns": {
9199 "type": {
9200 "fqn": "@aws-cdk/aws-events.HttpParameter"
9201 }
9202 },
9203 "static": true
9204 },
9205 {
9206 "docs": {
9207 "remarks": "The value is not treated as a secret.",
9208 "stability": "stable",
9209 "summary": "Make an OAuthParameter from a string value."
9210 },
9211 "locationInModule": {
9212 "filename": "lib/connection.ts",
9213 "line": 196
9214 },
9215 "name": "fromString",
9216 "parameters": [
9217 {
9218 "name": "value",
9219 "type": {
9220 "primitive": "string"
9221 }
9222 }
9223 ],
9224 "returns": {
9225 "type": {
9226 "fqn": "@aws-cdk/aws-events.HttpParameter"
9227 }
9228 },
9229 "static": true
9230 }
9231 ],
9232 "name": "HttpParameter",
9233 "symbolId": "lib/connection:HttpParameter"
9234 },
9235 "@aws-cdk/aws-events.IApiDestination": {
9236 "assembly": "@aws-cdk/aws-events",
9237 "docs": {
9238 "stability": "stable",
9239 "summary": "Interface for API Destinations."
9240 },
9241 "fqn": "@aws-cdk/aws-events.IApiDestination",
9242 "interfaces": [
9243 "@aws-cdk/core.IResource"
9244 ],
9245 "kind": "interface",
9246 "locationInModule": {
9247 "filename": "lib/api-destination.ts",
9248 "line": 51
9249 },
9250 "name": "IApiDestination",
9251 "properties": [
9252 {
9253 "abstract": true,
9254 "docs": {
9255 "custom": {
9256 "attribute": "true"
9257 },
9258 "stability": "stable",
9259 "summary": "The ARN of the Api Destination created."
9260 },
9261 "immutable": true,
9262 "locationInModule": {
9263 "filename": "lib/api-destination.ts",
9264 "line": 62
9265 },
9266 "name": "apiDestinationArn",
9267 "type": {
9268 "primitive": "string"
9269 }
9270 },
9271 {
9272 "abstract": true,
9273 "docs": {
9274 "custom": {
9275 "attribute": "true"
9276 },
9277 "stability": "stable",
9278 "summary": "The Name of the Api Destination created."
9279 },
9280 "immutable": true,
9281 "locationInModule": {
9282 "filename": "lib/api-destination.ts",
9283 "line": 56
9284 },
9285 "name": "apiDestinationName",
9286 "type": {
9287 "primitive": "string"
9288 }
9289 }
9290 ],
9291 "symbolId": "lib/api-destination:IApiDestination"
9292 },
9293 "@aws-cdk/aws-events.IConnection": {
9294 "assembly": "@aws-cdk/aws-events",
9295 "docs": {
9296 "stability": "stable",
9297 "summary": "Interface for EventBus Connections."
9298 },
9299 "fqn": "@aws-cdk/aws-events.IConnection",
9300 "interfaces": [
9301 "@aws-cdk/core.IResource"
9302 ],
9303 "kind": "interface",
9304 "locationInModule": {
9305 "filename": "lib/connection.ts",
9306 "line": 250
9307 },
9308 "name": "IConnection",
9309 "properties": [
9310 {
9311 "abstract": true,
9312 "docs": {
9313 "custom": {
9314 "attribute": "true"
9315 },
9316 "stability": "stable",
9317 "summary": "The ARN of the connection created."
9318 },
9319 "immutable": true,
9320 "locationInModule": {
9321 "filename": "lib/connection.ts",
9322 "line": 261
9323 },
9324 "name": "connectionArn",
9325 "type": {
9326 "primitive": "string"
9327 }
9328 },
9329 {
9330 "abstract": true,
9331 "docs": {
9332 "custom": {
9333 "attribute": "true"
9334 },
9335 "stability": "stable",
9336 "summary": "The Name for the connection."
9337 },
9338 "immutable": true,
9339 "locationInModule": {
9340 "filename": "lib/connection.ts",
9341 "line": 255
9342 },
9343 "name": "connectionName",
9344 "type": {
9345 "primitive": "string"
9346 }
9347 },
9348 {
9349 "abstract": true,
9350 "docs": {
9351 "custom": {
9352 "attribute": "true"
9353 },
9354 "stability": "stable",
9355 "summary": "The ARN for the secret created for the connection."
9356 },
9357 "immutable": true,
9358 "locationInModule": {
9359 "filename": "lib/connection.ts",
9360 "line": 267
9361 },
9362 "name": "connectionSecretArn",
9363 "type": {
9364 "primitive": "string"
9365 }
9366 }
9367 ],
9368 "symbolId": "lib/connection:IConnection"
9369 },
9370 "@aws-cdk/aws-events.IEventBus": {
9371 "assembly": "@aws-cdk/aws-events",
9372 "docs": {
9373 "stability": "stable",
9374 "summary": "Interface which all EventBus based classes MUST implement."
9375 },
9376 "fqn": "@aws-cdk/aws-events.IEventBus",
9377 "interfaces": [
9378 "@aws-cdk/core.IResource"
9379 ],
9380 "kind": "interface",
9381 "locationInModule": {
9382 "filename": "lib/event-bus.ts",
9383 "line": 10
9384 },
9385 "methods": [
9386 {
9387 "abstract": true,
9388 "docs": {
9389 "remarks": "When you create an archive, incoming events might not immediately start being sent to the archive.\nAllow a short period of time for changes to take effect.",
9390 "stability": "stable",
9391 "summary": "Create an EventBridge archive to send events to."
9392 },
9393 "locationInModule": {
9394 "filename": "lib/event-bus.ts",
9395 "line": 49
9396 },
9397 "name": "archive",
9398 "parameters": [
9399 {
9400 "name": "id",
9401 "type": {
9402 "primitive": "string"
9403 }
9404 },
9405 {
9406 "docs": {
9407 "summary": "Properties of the archive."
9408 },
9409 "name": "props",
9410 "type": {
9411 "fqn": "@aws-cdk/aws-events.BaseArchiveProps"
9412 }
9413 }
9414 ],
9415 "returns": {
9416 "type": {
9417 "fqn": "@aws-cdk/aws-events.Archive"
9418 }
9419 }
9420 },
9421 {
9422 "abstract": true,
9423 "docs": {
9424 "stability": "stable",
9425 "summary": "Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules."
9426 },
9427 "locationInModule": {
9428 "filename": "lib/event-bus.ts",
9429 "line": 57
9430 },
9431 "name": "grantPutEventsTo",
9432 "parameters": [
9433 {
9434 "docs": {
9435 "summary": "The principal (no-op if undefined)."
9436 },
9437 "name": "grantee",
9438 "type": {
9439 "fqn": "@aws-cdk/aws-iam.IGrantable"
9440 }
9441 }
9442 ],
9443 "returns": {
9444 "type": {
9445 "fqn": "@aws-cdk/aws-iam.Grant"
9446 }
9447 }
9448 }
9449 ],
9450 "name": "IEventBus",
9451 "properties": [
9452 {
9453 "abstract": true,
9454 "docs": {
9455 "custom": {
9456 "attribute": "true",
9457 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt"
9458 },
9459 "stability": "stable",
9460 "summary": "The ARN of this event bus resource."
9461 },
9462 "immutable": true,
9463 "locationInModule": {
9464 "filename": "lib/event-bus.ts",
9465 "line": 25
9466 },
9467 "name": "eventBusArn",
9468 "type": {
9469 "primitive": "string"
9470 }
9471 },
9472 {
9473 "abstract": true,
9474 "docs": {
9475 "custom": {
9476 "attribute": "true",
9477 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name"
9478 },
9479 "stability": "stable",
9480 "summary": "The physical ID of this event bus resource."
9481 },
9482 "immutable": true,
9483 "locationInModule": {
9484 "filename": "lib/event-bus.ts",
9485 "line": 17
9486 },
9487 "name": "eventBusName",
9488 "type": {
9489 "primitive": "string"
9490 }
9491 },
9492 {
9493 "abstract": true,
9494 "docs": {
9495 "custom": {
9496 "attribute": "true",
9497 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt"
9498 },
9499 "stability": "stable",
9500 "summary": "The JSON policy of this event bus resource."
9501 },
9502 "immutable": true,
9503 "locationInModule": {
9504 "filename": "lib/event-bus.ts",
9505 "line": 33
9506 },
9507 "name": "eventBusPolicy",
9508 "type": {
9509 "primitive": "string"
9510 }
9511 },
9512 {
9513 "abstract": true,
9514 "docs": {
9515 "custom": {
9516 "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename"
9517 },
9518 "stability": "stable",
9519 "summary": "The partner event source to associate with this event bus resource."
9520 },
9521 "immutable": true,
9522 "locationInModule": {
9523 "filename": "lib/event-bus.ts",
9524 "line": 40
9525 },
9526 "name": "eventSourceName",
9527 "optional": true,
9528 "type": {
9529 "primitive": "string"
9530 }
9531 }
9532 ],
9533 "symbolId": "lib/event-bus:IEventBus"
9534 },
9535 "@aws-cdk/aws-events.IRule": {
9536 "assembly": "@aws-cdk/aws-events",
9537 "docs": {
9538 "stability": "stable",
9539 "summary": "Represents an EventBridge Rule."
9540 },
9541 "fqn": "@aws-cdk/aws-events.IRule",
9542 "interfaces": [
9543 "@aws-cdk/core.IResource"
9544 ],
9545 "kind": "interface",
9546 "locationInModule": {
9547 "filename": "lib/rule-ref.ts",
9548 "line": 6
9549 },
9550 "name": "IRule",
9551 "properties": [
9552 {
9553 "abstract": true,
9554 "docs": {
9555 "custom": {
9556 "attribute": "true"
9557 },
9558 "stability": "stable",
9559 "summary": "The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example."
9560 },
9561 "immutable": true,
9562 "locationInModule": {
9563 "filename": "lib/rule-ref.ts",
9564 "line": 13
9565 },
9566 "name": "ruleArn",
9567 "type": {
9568 "primitive": "string"
9569 }
9570 },
9571 {
9572 "abstract": true,
9573 "docs": {
9574 "custom": {
9575 "attribute": "true"
9576 },
9577 "stability": "stable",
9578 "summary": "The name event rule."
9579 },
9580 "immutable": true,
9581 "locationInModule": {
9582 "filename": "lib/rule-ref.ts",
9583 "line": 20
9584 },
9585 "name": "ruleName",
9586 "type": {
9587 "primitive": "string"
9588 }
9589 }
9590 ],
9591 "symbolId": "lib/rule-ref:IRule"
9592 },
9593 "@aws-cdk/aws-events.IRuleTarget": {
9594 "assembly": "@aws-cdk/aws-events",
9595 "docs": {
9596 "stability": "stable",
9597 "summary": "An abstract target for EventRules."
9598 },
9599 "fqn": "@aws-cdk/aws-events.IRuleTarget",
9600 "kind": "interface",
9601 "locationInModule": {
9602 "filename": "lib/target.ts",
9603 "line": 10
9604 },
9605 "methods": [
9606 {
9607 "abstract": true,
9608 "docs": {
9609 "remarks": "NOTE: Do not use the various `inputXxx` options. They can be set in a call to `addTarget`.",
9610 "stability": "stable",
9611 "summary": "Returns the rule target specification."
9612 },
9613 "locationInModule": {
9614 "filename": "lib/target.ts",
9615 "line": 18
9616 },
9617 "name": "bind",
9618 "parameters": [
9619 {
9620 "docs": {
9621 "summary": "The EventBridge Rule that would trigger this target."
9622 },
9623 "name": "rule",
9624 "type": {
9625 "fqn": "@aws-cdk/aws-events.IRule"
9626 }
9627 },
9628 {
9629 "docs": {
9630 "summary": "The id of the target that will be attached to the rule."
9631 },
9632 "name": "id",
9633 "optional": true,
9634 "type": {
9635 "primitive": "string"
9636 }
9637 }
9638 ],
9639 "returns": {
9640 "type": {
9641 "fqn": "@aws-cdk/aws-events.RuleTargetConfig"
9642 }
9643 }
9644 }
9645 ],
9646 "name": "IRuleTarget",
9647 "symbolId": "lib/target:IRuleTarget"
9648 },
9649 "@aws-cdk/aws-events.OAuthAuthorizationProps": {
9650 "assembly": "@aws-cdk/aws-events",
9651 "datatype": true,
9652 "docs": {
9653 "stability": "stable",
9654 "summary": "Properties for `Authorization.oauth()`.",
9655 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const httpParameter: events.HttpParameter;\ndeclare const secretValue: cdk.SecretValue;\nconst oAuthAuthorizationProps: events.OAuthAuthorizationProps = {\n authorizationEndpoint: 'authorizationEndpoint',\n clientId: 'clientId',\n clientSecret: secretValue,\n httpMethod: events.HttpMethod.POST,\n\n // the properties below are optional\n bodyParameters: {\n bodyParametersKey: httpParameter,\n },\n headerParameters: {\n headerParametersKey: httpParameter,\n },\n queryStringParameters: {\n queryStringParametersKey: httpParameter,\n },\n};",
9656 "custom": {
9657 "exampleMetadata": "fixture=_generated"
9658 }
9659 },
9660 "fqn": "@aws-cdk/aws-events.OAuthAuthorizationProps",
9661 "kind": "interface",
9662 "locationInModule": {
9663 "filename": "lib/connection.ts",
9664 "line": 141
9665 },
9666 "name": "OAuthAuthorizationProps",
9667 "properties": [
9668 {
9669 "abstract": true,
9670 "docs": {
9671 "stability": "stable",
9672 "summary": "The URL to the authorization endpoint."
9673 },
9674 "immutable": true,
9675 "locationInModule": {
9676 "filename": "lib/connection.ts",
9677 "line": 146
9678 },
9679 "name": "authorizationEndpoint",
9680 "type": {
9681 "primitive": "string"
9682 }
9683 },
9684 {
9685 "abstract": true,
9686 "docs": {
9687 "stability": "stable",
9688 "summary": "The client ID to use for OAuth authorization for the connection."
9689 },
9690 "immutable": true,
9691 "locationInModule": {
9692 "filename": "lib/connection.ts",
9693 "line": 158
9694 },
9695 "name": "clientId",
9696 "type": {
9697 "primitive": "string"
9698 }
9699 },
9700 {
9701 "abstract": true,
9702 "docs": {
9703 "stability": "stable",
9704 "summary": "The client secret associated with the client ID to use for OAuth authorization for the connection."
9705 },
9706 "immutable": true,
9707 "locationInModule": {
9708 "filename": "lib/connection.ts",
9709 "line": 163
9710 },
9711 "name": "clientSecret",
9712 "type": {
9713 "fqn": "@aws-cdk/core.SecretValue"
9714 }
9715 },
9716 {
9717 "abstract": true,
9718 "docs": {
9719 "remarks": "(Can only choose POST, GET or PUT).",
9720 "stability": "stable",
9721 "summary": "The method to use for the authorization request."
9722 },
9723 "immutable": true,
9724 "locationInModule": {
9725 "filename": "lib/connection.ts",
9726 "line": 153
9727 },
9728 "name": "httpMethod",
9729 "type": {
9730 "fqn": "@aws-cdk/aws-events.HttpMethod"
9731 }
9732 },
9733 {
9734 "abstract": true,
9735 "docs": {
9736 "default": "- No additional parameters",
9737 "stability": "stable",
9738 "summary": "Additional string parameters to add to the OAuth request body."
9739 },
9740 "immutable": true,
9741 "locationInModule": {
9742 "filename": "lib/connection.ts",
9743 "line": 170
9744 },
9745 "name": "bodyParameters",
9746 "optional": true,
9747 "type": {
9748 "collection": {
9749 "elementtype": {
9750 "fqn": "@aws-cdk/aws-events.HttpParameter"
9751 },
9752 "kind": "map"
9753 }
9754 }
9755 },
9756 {
9757 "abstract": true,
9758 "docs": {
9759 "default": "- No additional parameters",
9760 "stability": "stable",
9761 "summary": "Additional string parameters to add to the OAuth request header."
9762 },
9763 "immutable": true,
9764 "locationInModule": {
9765 "filename": "lib/connection.ts",
9766 "line": 177
9767 },
9768 "name": "headerParameters",
9769 "optional": true,
9770 "type": {
9771 "collection": {
9772 "elementtype": {
9773 "fqn": "@aws-cdk/aws-events.HttpParameter"
9774 },
9775 "kind": "map"
9776 }
9777 }
9778 },
9779 {
9780 "abstract": true,
9781 "docs": {
9782 "default": "- No additional parameters",
9783 "stability": "stable",
9784 "summary": "Additional string parameters to add to the OAuth request query string."
9785 },
9786 "immutable": true,
9787 "locationInModule": {
9788 "filename": "lib/connection.ts",
9789 "line": 184
9790 },
9791 "name": "queryStringParameters",
9792 "optional": true,
9793 "type": {
9794 "collection": {
9795 "elementtype": {
9796 "fqn": "@aws-cdk/aws-events.HttpParameter"
9797 },
9798 "kind": "map"
9799 }
9800 }
9801 }
9802 ],
9803 "symbolId": "lib/connection:OAuthAuthorizationProps"
9804 },
9805 "@aws-cdk/aws-events.OnEventOptions": {
9806 "assembly": "@aws-cdk/aws-events",
9807 "datatype": true,
9808 "docs": {
9809 "custom": {
9810 "exampleMetadata": "infused"
9811 },
9812 "example": "// Lambda function containing logic that evaluates compliance with the rule.\nconst evalComplianceFn = new lambda.Function(this, 'CustomFunction', {\n code: lambda.AssetCode.fromInline('exports.handler = (event) => console.log(event);'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_12_X,\n});\n\n// A custom rule that runs on configuration changes of EC2 instances\nconst customRule = new config.CustomRule(this, 'Custom', {\n configurationChanges: true,\n lambdaFunction: evalComplianceFn,\n ruleScope: config.RuleScope.fromResource(config.ResourceType.EC2_INSTANCE),\n});\n\n// A rule to detect stack drifts\nconst driftRule = new config.CloudFormationStackDriftDetectionCheck(this, 'Drift');\n\n// Topic to which compliance notification events will be published\nconst complianceTopic = new sns.Topic(this, 'ComplianceTopic');\n\n// Send notification on compliance change events\ndriftRule.onComplianceChange('ComplianceChange', {\n target: new targets.SnsTopic(complianceTopic),\n});",
9813 "stability": "stable",
9814 "summary": "Standard set of options for `onXxx` event handlers on construct."
9815 },
9816 "fqn": "@aws-cdk/aws-events.OnEventOptions",
9817 "kind": "interface",
9818 "locationInModule": {
9819 "filename": "lib/on-event-options.ts",
9820 "line": 7
9821 },
9822 "name": "OnEventOptions",
9823 "properties": [
9824 {
9825 "abstract": true,
9826 "docs": {
9827 "default": "- No description",
9828 "stability": "stable",
9829 "summary": "A description of the rule's purpose."
9830 },
9831 "immutable": true,
9832 "locationInModule": {
9833 "filename": "lib/on-event-options.ts",
9834 "line": 20
9835 },
9836 "name": "description",
9837 "optional": true,
9838 "type": {
9839 "primitive": "string"
9840 }
9841 },
9842 {
9843 "abstract": true,
9844 "docs": {
9845 "default": "- No additional filtering based on an event pattern.",
9846 "remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
9847 "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html",
9848 "stability": "stable",
9849 "summary": "Additional restrictions for the event to route to the specified target."
9850 },
9851 "immutable": true,
9852 "locationInModule": {
9853 "filename": "lib/on-event-options.ts",
9854 "line": 41
9855 },
9856 "name": "eventPattern",
9857 "optional": true,
9858 "type": {
9859 "fqn": "@aws-cdk/aws-events.EventPattern"
9860 }
9861 },
9862 {
9863 "abstract": true,
9864 "docs": {
9865 "default": "AWS CloudFormation generates a unique physical ID.",
9866 "stability": "stable",
9867 "summary": "A name for the rule."
9868 },
9869 "immutable": true,
9870 "locationInModule": {
9871 "filename": "lib/on-event-options.ts",
9872 "line": 27
9873 },
9874 "name": "ruleName",
9875 "optional": true,
9876 "type": {
9877 "primitive": "string"
9878 }
9879 },
9880 {
9881 "abstract": true,
9882 "docs": {
9883 "default": "- No target is added to the rule. Use `addTarget()` to add a target.",
9884 "stability": "stable",
9885 "summary": "The target to register for the event."
9886 },
9887 "immutable": true,
9888 "locationInModule": {
9889 "filename": "lib/on-event-options.ts",
9890 "line": 13
9891 },
9892 "name": "target",
9893 "optional": true,
9894 "type": {
9895 "fqn": "@aws-cdk/aws-events.IRuleTarget"
9896 }
9897 }
9898 ],
9899 "symbolId": "lib/on-event-options:OnEventOptions"
9900 },
9901 "@aws-cdk/aws-events.Rule": {
9902 "assembly": "@aws-cdk/aws-events",
9903 "base": "@aws-cdk/core.Resource",
9904 "docs": {
9905 "custom": {
9906 "exampleMetadata": "infused",
9907 "resource": "AWS::Events::Rule"
9908 },
9909 "example": "import * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunc', {\n runtime: lambda.Runtime.NODEJS_12_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`exports.handler = handler.toString()`),\n});\n\nconst rule = new events.Rule(this, 'rule', {\n eventPattern: {\n source: [\"aws.ec2\"],\n },\n});\n\nconst queue = new sqs.Queue(this, 'Queue');\n\nrule.addTarget(new targets.LambdaFunction(fn, {\n deadLetterQueue: queue, // Optional: add a dead letter queue\n maxEventAge: cdk.Duration.hours(2), // Optional: set the maxEventAge retry policy\n retryAttempts: 2, // Optional: set the max number of retry attempts\n}));",
9910 "stability": "stable",
9911 "summary": "Defines an EventBridge Rule in this stack."
9912 },
9913 "fqn": "@aws-cdk/aws-events.Rule",
9914 "initializer": {
9915 "docs": {
9916 "stability": "stable"
9917 },
9918 "locationInModule": {
9919 "filename": "lib/rule.ts",
9920 "line": 121
9921 },
9922 "parameters": [
9923 {
9924 "name": "scope",
9925 "type": {
9926 "fqn": "constructs.Construct"
9927 }
9928 },
9929 {
9930 "name": "id",
9931 "type": {
9932 "primitive": "string"
9933 }
9934 },
9935 {
9936 "name": "props",
9937 "optional": true,
9938 "type": {
9939 "fqn": "@aws-cdk/aws-events.RuleProps"
9940 }
9941 }
9942 ]
9943 },
9944 "interfaces": [
9945 "@aws-cdk/aws-events.IRule"
9946 ],
9947 "kind": "class",
9948 "locationInModule": {
9949 "filename": "lib/rule.ts",
9950 "line": 91
9951 },
9952 "methods": [
9953 {
9954 "docs": {
9955 "stability": "stable",
9956 "summary": "Import an existing EventBridge Rule provided an ARN."
9957 },
9958 "locationInModule": {
9959 "filename": "lib/rule.ts",
9960 "line": 100
9961 },
9962 "name": "fromEventRuleArn",
9963 "parameters": [
9964 {
9965 "docs": {
9966 "summary": "The parent creating construct (usually `this`)."
9967 },
9968 "name": "scope",
9969 "type": {
9970 "fqn": "constructs.Construct"
9971 }
9972 },
9973 {
9974 "docs": {
9975 "summary": "The construct's name."
9976 },
9977 "name": "id",
9978 "type": {
9979 "primitive": "string"
9980 }
9981 },
9982 {
9983 "docs": {
9984 "summary": "Event Rule ARN (i.e. arn:aws:events:<region>:<account-id>:rule/MyScheduledRule)."
9985 },
9986 "name": "eventRuleArn",
9987 "type": {
9988 "primitive": "string"
9989 }
9990 }
9991 ],
9992 "returns": {
9993 "type": {
9994 "fqn": "@aws-cdk/aws-events.IRule"
9995 }
9996 },
9997 "static": true
9998 },
9999 {
10000 "docs": {
10001 "remarks": "If a pattern was already specified,\nthese values are merged into the existing pattern.\n\nFor example, if the rule already contains the pattern:\n\n {\n \"resources\": [ \"r1\" ],\n \"detail\": {\n \"hello\": [ 1 ]\n }\n }\n\nAnd `addEventPattern` is called with the pattern:\n\n {\n \"resources\": [ \"r2\" ],\n \"detail\": {\n \"foo\": [ \"bar\" ]\n }\n }\n\nThe resulting event pattern will be:\n\n {\n \"resources\": [ \"r1\", \"r2\" ],\n \"detail\": {\n \"hello\": [ 1 ],\n \"foo\": [ \"bar\" ]\n }\n }",
10002 "stability": "stable",
10003 "summary": "Adds an event pattern filter to this rule."
10004 },
10005 "locationInModule": {
10006 "filename": "lib/rule.ts",
10007 "line": 308
10008 },
10009 "name": "addEventPattern",
10010 "parameters": [
10011 {
10012 "name": "eventPattern",
10013 "optional": true,
10014 "type": {
10015 "fqn": "@aws-cdk/aws-events.EventPattern"
10016 }
10017 }
10018 ]
10019 },
10020 {
10021 "docs": {
10022 "remarks": "No-op if target is undefined.",
10023 "stability": "stable",
10024 "summary": "Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets."
10025 },
10026 "locationInModule": {
10027 "filename": "lib/rule.ts",
10028 "line": 166
10029 },
10030 "name": "addTarget",
10031 "parameters": [
10032 {
10033 "name": "target",
10034 "optional": true,
10035 "type": {
10036 "fqn": "@aws-cdk/aws-events.IRuleTarget"
10037 }
10038 }
10039 ]
10040 },
10041 {
10042 "docs": {
10043 "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.",
10044 "stability": "stable",
10045 "summary": "Validate the current construct."
10046 },
10047 "locationInModule": {
10048 "filename": "lib/rule.ts",
10049 "line": 324
10050 },
10051 "name": "validate",
10052 "overrides": "@aws-cdk/core.Construct",
10053 "protected": true,
10054 "returns": {
10055 "type": {
10056 "collection": {
10057 "elementtype": {
10058 "primitive": "string"
10059 },
10060 "kind": "array"
10061 }
10062 }
10063 }
10064 }
10065 ],
10066 "name": "Rule",
10067 "properties": [
10068 {
10069 "docs": {
10070 "stability": "stable",
10071 "summary": "The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example."
10072 },
10073 "immutable": true,
10074 "locationInModule": {
10075 "filename": "lib/rule.ts",
10076 "line": 110
10077 },
10078 "name": "ruleArn",
10079 "overrides": "@aws-cdk/aws-events.IRule",
10080 "type": {
10081 "primitive": "string"
10082 }
10083 },
10084 {
10085 "docs": {
10086 "stability": "stable",
10087 "summary": "The name event rule."
10088 },
10089 "immutable": true,
10090 "locationInModule": {
10091 "filename": "lib/rule.ts",
10092 "line": 111
10093 },
10094 "name": "ruleName",
10095 "overrides": "@aws-cdk/aws-events.IRule",
10096 "type": {
10097 "primitive": "string"
10098 }
10099 }
10100 ],
10101 "symbolId": "lib/rule:Rule"
10102 },
10103 "@aws-cdk/aws-events.RuleProps": {
10104 "assembly": "@aws-cdk/aws-events",
10105 "datatype": true,
10106 "docs": {
10107 "custom": {
10108 "exampleMetadata": "infused"
10109 },
10110 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
10111 "stability": "stable",
10112 "summary": "Properties for defining an EventBridge Rule."
10113 },
10114 "fqn": "@aws-cdk/aws-events.RuleProps",
10115 "kind": "interface",
10116 "locationInModule": {
10117 "filename": "lib/rule.ts",
10118 "line": 15
10119 },
10120 "name": "RuleProps",
10121 "properties": [
10122 {
10123 "abstract": true,
10124 "docs": {
10125 "default": "- No description.",
10126 "stability": "stable",
10127 "summary": "A description of the rule's purpose."
10128 },
10129 "immutable": true,
10130 "locationInModule": {
10131 "filename": "lib/rule.ts",
10132 "line": 21
10133 },
10134 "name": "description",
10135 "optional": true,
10136 "type": {
10137 "primitive": "string"
10138 }
10139 },
10140 {
10141 "abstract": true,
10142 "docs": {
10143 "default": "true",
10144 "stability": "stable",
10145 "summary": "Indicates whether the rule is enabled."
10146 },
10147 "immutable": true,
10148 "locationInModule": {
10149 "filename": "lib/rule.ts",
10150 "line": 36
10151 },
10152 "name": "enabled",
10153 "optional": true,
10154 "type": {
10155 "primitive": "boolean"
10156 }
10157 },
10158 {
10159 "abstract": true,
10160 "docs": {
10161 "default": "- The default event bus.",
10162 "stability": "stable",
10163 "summary": "The event bus to associate with this rule."
10164 },
10165 "immutable": true,
10166 "locationInModule": {
10167 "filename": "lib/rule.ts",
10168 "line": 83
10169 },
10170 "name": "eventBus",
10171 "optional": true,
10172 "type": {
10173 "fqn": "@aws-cdk/aws-events.IEventBus"
10174 }
10175 },
10176 {
10177 "abstract": true,
10178 "docs": {
10179 "default": "- None.",
10180 "remarks": "These routed events are matched events. For more information, see Events\nand Event Patterns in the Amazon EventBridge User Guide.",
10181 "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html\n\nYou must specify this property (either via props or via\n`addEventPattern`), the `scheduleExpression` property, or both. The\nmethod `addEventPattern` can be used to add filter values to the event\npattern.",
10182 "stability": "stable",
10183 "summary": "Describes which events EventBridge routes to the specified target."
10184 },
10185 "immutable": true,
10186 "locationInModule": {
10187 "filename": "lib/rule.ts",
10188 "line": 66
10189 },
10190 "name": "eventPattern",
10191 "optional": true,
10192 "type": {
10193 "fqn": "@aws-cdk/aws-events.EventPattern"
10194 }
10195 },
10196 {
10197 "abstract": true,
10198 "docs": {
10199 "default": "- AWS CloudFormation generates a unique physical ID and uses that ID\nfor the rule name. For more information, see Name Type.",
10200 "stability": "stable",
10201 "summary": "A name for the rule."
10202 },
10203 "immutable": true,
10204 "locationInModule": {
10205 "filename": "lib/rule.ts",
10206 "line": 29
10207 },
10208 "name": "ruleName",
10209 "optional": true,
10210 "type": {
10211 "primitive": "string"
10212 }
10213 },
10214 {
10215 "abstract": true,
10216 "docs": {
10217 "default": "- None.",
10218 "remarks": "For more information, see Schedule Expression Syntax for\nRules in the Amazon EventBridge User Guide.",
10219 "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html\n\nYou must specify this property, the `eventPattern` property, or both.",
10220 "stability": "stable",
10221 "summary": "The schedule or rate (frequency) that determines when EventBridge runs the rule."
10222 },
10223 "immutable": true,
10224 "locationInModule": {
10225 "filename": "lib/rule.ts",
10226 "line": 49
10227 },
10228 "name": "schedule",
10229 "optional": true,
10230 "type": {
10231 "fqn": "@aws-cdk/aws-events.Schedule"
10232 }
10233 },
10234 {
10235 "abstract": true,
10236 "docs": {
10237 "default": "- No targets.",
10238 "remarks": "Input will be the full matched event. If you wish to specify custom\ntarget input, use `addTarget(target[, inputOptions])`.",
10239 "stability": "stable",
10240 "summary": "Targets to invoke when this rule matches an event."
10241 },
10242 "immutable": true,
10243 "locationInModule": {
10244 "filename": "lib/rule.ts",
10245 "line": 76
10246 },
10247 "name": "targets",
10248 "optional": true,
10249 "type": {
10250 "collection": {
10251 "elementtype": {
10252 "fqn": "@aws-cdk/aws-events.IRuleTarget"
10253 },
10254 "kind": "array"
10255 }
10256 }
10257 }
10258 ],
10259 "symbolId": "lib/rule:RuleProps"
10260 },
10261 "@aws-cdk/aws-events.RuleTargetConfig": {
10262 "assembly": "@aws-cdk/aws-events",
10263 "datatype": true,
10264 "docs": {
10265 "stability": "stable",
10266 "summary": "Properties for an event rule target.",
10267 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const construct: cdk.Construct;\ndeclare const role: iam.Role;\ndeclare const ruleTargetInput: events.RuleTargetInput;\nconst ruleTargetConfig: events.RuleTargetConfig = {\n arn: 'arn',\n\n // the properties below are optional\n batchParameters: {\n jobDefinition: 'jobDefinition',\n jobName: 'jobName',\n\n // the properties below are optional\n arrayProperties: {\n size: 123,\n },\n retryStrategy: {\n attempts: 123,\n },\n },\n deadLetterConfig: {\n arn: 'arn',\n },\n ecsParameters: {\n taskDefinitionArn: 'taskDefinitionArn',\n\n // the properties below are optional\n capacityProviderStrategy: [{\n capacityProvider: 'capacityProvider',\n\n // the properties below are optional\n base: 123,\n weight: 123,\n }],\n enableEcsManagedTags: false,\n enableExecuteCommand: false,\n group: 'group',\n launchType: 'launchType',\n networkConfiguration: {\n awsVpcConfiguration: {\n subnets: ['subnets'],\n\n // the properties below are optional\n assignPublicIp: 'assignPublicIp',\n securityGroups: ['securityGroups'],\n },\n },\n placementConstraints: [{\n expression: 'expression',\n type: 'type',\n }],\n placementStrategies: [{\n field: 'field',\n type: 'type',\n }],\n platformVersion: 'platformVersion',\n propagateTags: 'propagateTags',\n referenceId: 'referenceId',\n tagList: [{\n key: 'key',\n value: 'value',\n }],\n taskCount: 123,\n },\n httpParameters: {\n headerParameters: {\n headerParametersKey: 'headerParameters',\n },\n pathParameterValues: ['pathParameterValues'],\n queryStringParameters: {\n queryStringParametersKey: 'queryStringParameters',\n },\n },\n id: 'id',\n input: ruleTargetInput,\n kinesisParameters: {\n partitionKeyPath: 'partitionKeyPath',\n },\n retryPolicy: {\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n },\n role: role,\n runCommandParameters: {\n runCommandTargets: [{\n key: 'key',\n values: ['values'],\n }],\n },\n sqsParameters: {\n messageGroupId: 'messageGroupId',\n },\n targetResource: construct,\n};",
10268 "custom": {
10269 "exampleMetadata": "fixture=_generated"
10270 }
10271 },
10272 "fqn": "@aws-cdk/aws-events.RuleTargetConfig",
10273 "kind": "interface",
10274 "locationInModule": {
10275 "filename": "lib/target.ts",
10276 "line": 24
10277 },
10278 "name": "RuleTargetConfig",
10279 "properties": [
10280 {
10281 "abstract": true,
10282 "docs": {
10283 "stability": "stable",
10284 "summary": "The Amazon Resource Name (ARN) of the target."
10285 },
10286 "immutable": true,
10287 "locationInModule": {
10288 "filename": "lib/target.ts",
10289 "line": 38
10290 },
10291 "name": "arn",
10292 "type": {
10293 "primitive": "string"
10294 }
10295 },
10296 {
10297 "abstract": true,
10298 "docs": {
10299 "default": "no parameters set",
10300 "stability": "stable",
10301 "summary": "Parameters used when the rule invokes Amazon AWS Batch Job/Queue."
10302 },
10303 "immutable": true,
10304 "locationInModule": {
10305 "filename": "lib/target.ts",
10306 "line": 49
10307 },
10308 "name": "batchParameters",
10309 "optional": true,
10310 "type": {
10311 "fqn": "@aws-cdk/aws-events.CfnRule.BatchParametersProperty"
10312 }
10313 },
10314 {
10315 "abstract": true,
10316 "docs": {
10317 "default": "no dead-letter queue set",
10318 "stability": "stable",
10319 "summary": "Contains information about a dead-letter queue configuration."
10320 },
10321 "immutable": true,
10322 "locationInModule": {
10323 "filename": "lib/target.ts",
10324 "line": 55
10325 },
10326 "name": "deadLetterConfig",
10327 "optional": true,
10328 "type": {
10329 "fqn": "@aws-cdk/aws-events.CfnRule.DeadLetterConfigProperty"
10330 }
10331 },
10332 {
10333 "abstract": true,
10334 "docs": {
10335 "stability": "stable",
10336 "summary": "The Amazon ECS task definition and task count to use, if the event target is an Amazon ECS task."
10337 },
10338 "immutable": true,
10339 "locationInModule": {
10340 "filename": "lib/target.ts",
10341 "line": 67
10342 },
10343 "name": "ecsParameters",
10344 "optional": true,
10345 "type": {
10346 "fqn": "@aws-cdk/aws-events.CfnRule.EcsParametersProperty"
10347 }
10348 },
10349 {
10350 "abstract": true,
10351 "docs": {
10352 "default": "- None",
10353 "stability": "stable",
10354 "summary": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge API destination."
10355 },
10356 "immutable": true,
10357 "locationInModule": {
10358 "filename": "lib/target.ts",
10359 "line": 74
10360 },
10361 "name": "httpParameters",
10362 "optional": true,
10363 "type": {
10364 "fqn": "@aws-cdk/aws-events.CfnRule.HttpParametersProperty"
10365 }
10366 },
10367 {
10368 "abstract": true,
10369 "docs": {
10370 "default": "- an auto-generated id",
10371 "deprecated": "no replacement. we will always use an autogenerated id.",
10372 "remarks": "Acceptable values\ninclude alphanumeric characters, periods (.), hyphens (-), and\nunderscores (_).",
10373 "stability": "deprecated",
10374 "summary": "A unique, user-defined identifier for the target."
10375 },
10376 "immutable": true,
10377 "locationInModule": {
10378 "filename": "lib/target.ts",
10379 "line": 33
10380 },
10381 "name": "id",
10382 "optional": true,
10383 "type": {
10384 "primitive": "string"
10385 }
10386 },
10387 {
10388 "abstract": true,
10389 "docs": {
10390 "default": "the entire event",
10391 "stability": "stable",
10392 "summary": "What input to send to the event target."
10393 },
10394 "immutable": true,
10395 "locationInModule": {
10396 "filename": "lib/target.ts",
10397 "line": 100
10398 },
10399 "name": "input",
10400 "optional": true,
10401 "type": {
10402 "fqn": "@aws-cdk/aws-events.RuleTargetInput"
10403 }
10404 },
10405 {
10406 "abstract": true,
10407 "docs": {
10408 "remarks": "If you don't include this parameter, eventId is used as the\npartition key.",
10409 "stability": "stable",
10410 "summary": "Settings that control shard assignment, when the target is a Kinesis stream."
10411 },
10412 "immutable": true,
10413 "locationInModule": {
10414 "filename": "lib/target.ts",
10415 "line": 81
10416 },
10417 "name": "kinesisParameters",
10418 "optional": true,
10419 "type": {
10420 "fqn": "@aws-cdk/aws-events.CfnRule.KinesisParametersProperty"
10421 }
10422 },
10423 {
10424 "abstract": true,
10425 "docs": {
10426 "default": "EventBridge default retry policy",
10427 "stability": "stable",
10428 "summary": "A RetryPolicy object that includes information about the retry policy settings."
10429 },
10430 "immutable": true,
10431 "locationInModule": {
10432 "filename": "lib/target.ts",
10433 "line": 61
10434 },
10435 "name": "retryPolicy",
10436 "optional": true,
10437 "type": {
10438 "fqn": "@aws-cdk/aws-events.CfnRule.RetryPolicyProperty"
10439 }
10440 },
10441 {
10442 "abstract": true,
10443 "docs": {
10444 "stability": "stable",
10445 "summary": "Role to use to invoke this event target."
10446 },
10447 "immutable": true,
10448 "locationInModule": {
10449 "filename": "lib/target.ts",
10450 "line": 43
10451 },
10452 "name": "role",
10453 "optional": true,
10454 "type": {
10455 "fqn": "@aws-cdk/aws-iam.IRole"
10456 }
10457 },
10458 {
10459 "abstract": true,
10460 "docs": {
10461 "stability": "stable",
10462 "summary": "Parameters used when the rule invokes Amazon EC2 Systems Manager Run Command."
10463 },
10464 "immutable": true,
10465 "locationInModule": {
10466 "filename": "lib/target.ts",
10467 "line": 87
10468 },
10469 "name": "runCommandParameters",
10470 "optional": true,
10471 "type": {
10472 "fqn": "@aws-cdk/aws-events.CfnRule.RunCommandParametersProperty"
10473 }
10474 },
10475 {
10476 "abstract": true,
10477 "docs": {
10478 "stability": "stable",
10479 "summary": "Parameters used when the FIFO sqs queue is used an event target by the rule."
10480 },
10481 "immutable": true,
10482 "locationInModule": {
10483 "filename": "lib/target.ts",
10484 "line": 93
10485 },
10486 "name": "sqsParameters",
10487 "optional": true,
10488 "type": {
10489 "fqn": "@aws-cdk/aws-events.CfnRule.SqsParametersProperty"
10490 }
10491 },
10492 {
10493 "abstract": true,
10494 "docs": {
10495 "default": "the target is not backed by any resource",
10496 "remarks": "This is the resource that will actually have some action performed on it when used as a target\n(for example, start a build for a CodeBuild project).\nWe need it to determine whether the rule belongs to a different account than the target -\nif so, we generate a more complex setup,\nincluding an additional stack containing the EventBusPolicy.",
10497 "see": "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html",
10498 "stability": "stable",
10499 "summary": "The resource that is backing this target."
10500 },
10501 "immutable": true,
10502 "locationInModule": {
10503 "filename": "lib/target.ts",
10504 "line": 113
10505 },
10506 "name": "targetResource",
10507 "optional": true,
10508 "type": {
10509 "fqn": "@aws-cdk/core.IConstruct"
10510 }
10511 }
10512 ],
10513 "symbolId": "lib/target:RuleTargetConfig"
10514 },
10515 "@aws-cdk/aws-events.RuleTargetInput": {
10516 "abstract": true,
10517 "assembly": "@aws-cdk/aws-events",
10518 "docs": {
10519 "custom": {
10520 "exampleMetadata": "infused"
10521 },
10522 "example": "import * as iam from '@aws-cdk/aws-iam';\nimport * as sfn from '@aws-cdk/aws-stepfunctions';\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n});\n\nconst dlq = new sqs.Queue(this, 'DeadLetterQueue');\n\nconst role = new iam.Role(this, 'Role', {\n assumedBy: new iam.ServicePrincipal('events.amazonaws.com'),\n});\nconst stateMachine = new sfn.StateMachine(this, 'SM', {\n definition: new sfn.Wait(this, 'Hello', { time: sfn.WaitTime.duration(cdk.Duration.seconds(10)) })\n});\n\nrule.addTarget(new targets.SfnStateMachine(stateMachine, {\n input: events.RuleTargetInput.fromObject({ SomeParam: 'SomeValue' }),\n deadLetterQueue: dlq,\n role: role\n}));",
10523 "stability": "stable",
10524 "summary": "The input to send to the event target."
10525 },
10526 "fqn": "@aws-cdk/aws-events.RuleTargetInput",
10527 "initializer": {
10528 "docs": {
10529 "stability": "stable"
10530 },
10531 "locationInModule": {
10532 "filename": "lib/input.ts",
10533 "line": 55
10534 }
10535 },
10536 "kind": "class",
10537 "locationInModule": {
10538 "filename": "lib/input.ts",
10539 "line": 10
10540 },
10541 "methods": [
10542 {
10543 "docs": {
10544 "stability": "stable",
10545 "summary": "Take the event target input from a path in the event JSON."
10546 },
10547 "locationInModule": {
10548 "filename": "lib/input.ts",
10549 "line": 51
10550 },
10551 "name": "fromEventPath",
10552 "parameters": [
10553 {
10554 "name": "path",
10555 "type": {
10556 "primitive": "string"
10557 }
10558 }
10559 ],
10560 "returns": {
10561 "type": {
10562 "fqn": "@aws-cdk/aws-events.RuleTargetInput"
10563 }
10564 },
10565 "static": true
10566 },
10567 {
10568 "docs": {
10569 "remarks": "This is only useful when passing to a target that does not\ntake a single argument.\n\nMay contain strings returned by `EventField.from()` to substitute in parts\nof the matched event.",
10570 "stability": "stable",
10571 "summary": "Pass text to the event target, splitting on newlines."
10572 },
10573 "locationInModule": {
10574 "filename": "lib/input.ts",
10575 "line": 34
10576 },
10577 "name": "fromMultilineText",
10578 "parameters": [
10579 {
10580 "name": "text",
10581 "type": {
10582 "primitive": "string"
10583 }
10584 }
10585 ],
10586 "returns": {
10587 "type": {
10588 "fqn": "@aws-cdk/aws-events.RuleTargetInput"
10589 }
10590 },
10591 "static": true
10592 },
10593 {
10594 "docs": {
10595 "remarks": "May contain strings returned by `EventField.from()` to substitute in parts of the\nmatched event.",
10596 "stability": "stable",
10597 "summary": "Pass a JSON object to the event target."
10598 },
10599 "locationInModule": {
10600 "filename": "lib/input.ts",
10601 "line": 44
10602 },
10603 "name": "fromObject",
10604 "parameters": [
10605 {
10606 "name": "obj",
10607 "type": {
10608 "primitive": "any"
10609 }
10610 }
10611 ],
10612 "returns": {
10613 "type": {
10614 "fqn": "@aws-cdk/aws-events.RuleTargetInput"
10615 }
10616 },
10617 "static": true
10618 },
10619 {
10620 "docs": {
10621 "remarks": "May contain strings returned by `EventField.from()` to substitute in parts of the\nmatched event.\n\nThe Rule Target input value will be a single string: the string you pass\nhere. Do not use this method to pass a complex value like a JSON object to\na Rule Target. Use `RuleTargetInput.fromObject()` instead.",
10622 "stability": "stable",
10623 "summary": "Pass text to the event target."
10624 },
10625 "locationInModule": {
10626 "filename": "lib/input.ts",
10627 "line": 21
10628 },
10629 "name": "fromText",
10630 "parameters": [
10631 {
10632 "name": "text",
10633 "type": {
10634 "primitive": "string"
10635 }
10636 }
10637 ],
10638 "returns": {
10639 "type": {
10640 "fqn": "@aws-cdk/aws-events.RuleTargetInput"
10641 }
10642 },
10643 "static": true
10644 },
10645 {
10646 "abstract": true,
10647 "docs": {
10648 "stability": "stable",
10649 "summary": "Return the input properties for this input object."
10650 },
10651 "locationInModule": {
10652 "filename": "lib/input.ts",
10653 "line": 61
10654 },
10655 "name": "bind",
10656 "parameters": [
10657 {
10658 "name": "rule",
10659 "type": {
10660 "fqn": "@aws-cdk/aws-events.IRule"
10661 }
10662 }
10663 ],
10664 "returns": {
10665 "type": {
10666 "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties"
10667 }
10668 }
10669 }
10670 ],
10671 "name": "RuleTargetInput",
10672 "symbolId": "lib/input:RuleTargetInput"
10673 },
10674 "@aws-cdk/aws-events.RuleTargetInputProperties": {
10675 "assembly": "@aws-cdk/aws-events",
10676 "datatype": true,
10677 "docs": {
10678 "stability": "stable",
10679 "summary": "The input properties for an event target.",
10680 "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as events from '@aws-cdk/aws-events';\nconst ruleTargetInputProperties: events.RuleTargetInputProperties = {\n input: 'input',\n inputPath: 'inputPath',\n inputPathsMap: {\n inputPathsMapKey: 'inputPathsMap',\n },\n inputTemplate: 'inputTemplate',\n};",
10681 "custom": {
10682 "exampleMetadata": "fixture=_generated"
10683 }
10684 },
10685 "fqn": "@aws-cdk/aws-events.RuleTargetInputProperties",
10686 "kind": "interface",
10687 "locationInModule": {
10688 "filename": "lib/input.ts",
10689 "line": 67
10690 },
10691 "name": "RuleTargetInputProperties",
10692 "properties": [
10693 {
10694 "abstract": true,
10695 "docs": {
10696 "default": "- input for the event target. If the input contains a paths map\nvalues wil be extracted from event and inserted into the `inputTemplate`.",
10697 "stability": "stable",
10698 "summary": "Literal input to the target service (must be valid JSON)."
10699 },
10700 "immutable": true,
10701 "locationInModule": {
10702 "filename": "lib/input.ts",
10703 "line": 74
10704 },
10705 "name": "input",
10706 "optional": true,
10707 "type": {
10708 "primitive": "string"
10709 }
10710 },
10711 {
10712 "abstract": true,
10713 "docs": {
10714 "default": "- None. The entire matched event is passed as input",
10715 "stability": "stable",
10716 "summary": "JsonPath to take input from the input event."
10717 },
10718 "immutable": true,
10719 "locationInModule": {
10720 "filename": "lib/input.ts",
10721 "line": 81
10722 },
10723 "name": "inputPath",
10724 "optional": true,
10725 "type": {
10726 "primitive": "string"
10727 }
10728 },
10729 {
10730 "abstract": true,
10731 "docs": {
10732 "default": "- No values extracted from event.",
10733 "stability": "stable",
10734 "summary": "Paths map to extract values from event and insert into `inputTemplate`."
10735 },
10736 "immutable": true,
10737 "locationInModule": {
10738 "filename": "lib/input.ts",
10739 "line": 95
10740 },
10741 "name": "inputPathsMap",
10742 "optional": true,
10743 "type": {
10744 "collection": {
10745 "elementtype": {
10746 "primitive": "string"
10747 },
10748 "kind": "map"
10749 }
10750 }
10751 },
10752 {
10753 "abstract": true,
10754 "docs": {
10755 "default": "- None.",
10756 "stability": "stable",
10757 "summary": "Input template to insert paths map into."
10758 },
10759 "immutable": true,
10760 "locationInModule": {
10761 "filename": "lib/input.ts",
10762 "line": 88
10763 },
10764 "name": "inputTemplate",
10765 "optional": true,
10766 "type": {
10767 "primitive": "string"
10768 }
10769 }
10770 ],
10771 "symbolId": "lib/input:RuleTargetInputProperties"
10772 },
10773 "@aws-cdk/aws-events.Schedule": {
10774 "abstract": true,
10775 "assembly": "@aws-cdk/aws-events",
10776 "docs": {
10777 "custom": {
10778 "exampleMetadata": "infused"
10779 },
10780 "example": "const connection = new events.Connection(this, 'Connection', {\n authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),\n description: 'Connection with API Key x-api-key',\n});\n\nconst destination = new events.ApiDestination(this, 'Destination', {\n connection,\n endpoint: 'https://example.com',\n description: 'Calling example.com with API key x-api-key',\n});\n\nconst rule = new events.Rule(this, 'Rule', {\n schedule: events.Schedule.rate(cdk.Duration.minutes(1)),\n targets: [new targets.ApiDestination(destination)],\n});",
10781 "stability": "stable",
10782 "summary": "Schedule for scheduled event rules."
10783 },
10784 "fqn": "@aws-cdk/aws-events.Schedule",
10785 "initializer": {
10786 "docs": {
10787 "stability": "stable"
10788 },
10789 "locationInModule": {
10790 "filename": "lib/schedule.ts",
10791 "line": 74
10792 }
10793 },
10794 "kind": "class",
10795 "locationInModule": {
10796 "filename": "lib/schedule.ts",
10797 "line": 10
10798 },
10799 "methods": [
10800 {
10801 "docs": {
10802 "stability": "stable",
10803 "summary": "Create a schedule from a set of cron fields."
10804 },
10805 "locationInModule": {
10806 "filename": "lib/schedule.ts",
10807 "line": 44
10808 },
10809 "name": "cron",
10810 "parameters": [
10811 {
10812 "name": "options",
10813 "type": {
10814 "fqn": "@aws-cdk/aws-events.CronOptions"
10815 }
10816 }
10817 ],
10818 "returns": {
10819 "type": {
10820 "fqn": "@aws-cdk/aws-events.Schedule"
10821 }
10822 },
10823 "static": true
10824 },
10825 {
10826 "docs": {
10827 "stability": "stable",
10828 "summary": "Construct a schedule from a literal schedule expression."
10829 },
10830 "locationInModule": {
10831 "filename": "lib/schedule.ts",
10832 "line": 16
10833 },
10834 "name": "expression",
10835 "parameters": [
10836 {
10837 "docs": {
10838 "remarks": "Must be in a format that EventBridge will recognize",
10839 "summary": "The expression to use."
10840 },
10841 "name": "expression",
10842 "type": {
10843 "primitive": "string"
10844 }
10845 }
10846 ],
10847 "returns": {
10848 "type": {
10849 "fqn": "@aws-cdk/aws-events.Schedule"
10850 }
10851 },
10852 "static": true
10853 },
10854 {
10855 "docs": {
10856 "stability": "stable",
10857 "summary": "Construct a schedule from an interval and a time unit."
10858 },
10859 "locationInModule": {
10860 "filename": "lib/schedule.ts",
10861 "line": 23
10862 },
10863 "name": "rate",
10864 "parameters": [
10865 {
10866 "name": "duration",
10867 "type": {
10868 "fqn": "@aws-cdk/core.Duration"
10869 }
10870 }
10871 ],
10872 "returns": {
10873 "type": {
10874 "fqn": "@aws-cdk/aws-events.Schedule"
10875 }
10876 },
10877 "static": true
10878 }
10879 ],
10880 "name": "Schedule",
10881 "properties": [
10882 {
10883 "abstract": true,
10884 "docs": {
10885 "stability": "stable",
10886 "summary": "Retrieve the expression for this schedule."
10887 },
10888 "immutable": true,
10889 "locationInModule": {
10890 "filename": "lib/schedule.ts",
10891 "line": 72
10892 },
10893 "name": "expressionString",
10894 "type": {
10895 "primitive": "string"
10896 }
10897 }
10898 ],
10899 "symbolId": "lib/schedule:Schedule"
10900 }
10901 },
10902 "version": "1.155.0",
10903 "fingerprint": "**********"
10904}