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",