-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathdecdk.specs.json
9895 lines (9895 loc) · 436 KB
/
decdk.specs.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"schemaVersion": "3.0.0",
"ModuleTypes": {
"aws-cdk-lib.aws_lambda": {
"ResourceTypes": {
"Alias": {
"Properties": {
"maxEventAge": {
"Remarks": "Minimum: 60 seconds\nMaximum: 6 hours",
"Summary": "The maximum age of a request that Lambda sends to a function for processing.",
"Required": false,
"Type": "aws-cdk-lib.Duration"
},
"onFailure": {
"Remarks": "",
"Summary": "The destination for failed invocations.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.IDestination"
},
"onSuccess": {
"Remarks": "",
"Summary": "The destination for successful invocations.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.IDestination"
},
"retryAttempts": {
"Remarks": "Minimum: 0\nMaximum: 2",
"Summary": "The maximum number of times to retry when the function returns an error.",
"Required": false,
"Type": "Number"
},
"additionalVersions": {
"Remarks": "Individual additional version weights specified here should add up to\n(less than) one. All remaining weight is routed to the default\nversion.\n\nFor example, the config is\n\n version: \"1\"\n additionalVersions: [{ version: \"2\", weight: 0.05 }]\n\nThen 5% of traffic will be routed to function version 2, while\nthe remaining 95% of traffic will be routed to function version 1.",
"Summary": "Additional versions with individual weights this alias points to.",
"Required": false,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_lambda.VersionWeight"
},
"description": {
"Remarks": "",
"Summary": "Description for the alias.",
"Required": false,
"Type": "String"
},
"provisionedConcurrentExecutions": {
"Remarks": "",
"Summary": "Specifies a provisioned concurrency configuration for a function's alias.",
"Required": false,
"Type": "Number"
},
"aliasName": {
"Remarks": "",
"Summary": "Name of this alias.",
"Required": true,
"Type": "String"
},
"version": {
"Remarks": "Use lambda.currentVersion to reference a version with your latest changes.",
"Summary": "Function version this alias refers to.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.IVersion"
}
},
"Methods": {
"aws-cdk-lib.aws_lambda.Alias.isConstruct": {
"Parameters": {
"x": {
"Summary": "Any object.",
"Type": "Any"
}
},
"Summary": "Checks if `x` is a construct.",
"Remarks": "Use this method instead of `instanceof` to properly detect `Construct`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `constructs` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `Construct` in each copy of the `constructs` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `constructs`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.",
"Static": true,
"ReturnType": "Boolean"
},
"toString": {
"Parameters": {},
"Summary": "Returns a string representation of this construct.",
"Remarks": "",
"Static": false,
"ReturnType": "String"
},
"aws-cdk-lib.aws_lambda.Alias.isOwnedResource": {
"Parameters": {
"construct": {
"Summary": "",
"Type": "constructs.IConstruct"
}
},
"Summary": "Returns true if the construct was created by CDK, and false otherwise.",
"Remarks": "",
"Static": true,
"ReturnType": "Boolean"
},
"aws-cdk-lib.aws_lambda.Alias.isResource": {
"Parameters": {
"construct": {
"Summary": "",
"Type": "constructs.IConstruct"
}
},
"Summary": "Check whether the given construct is a Resource.",
"Remarks": "",
"Static": true,
"ReturnType": "Boolean"
},
"applyRemovalPolicy": {
"Parameters": {
"policy": {
"Summary": "",
"Type": "aws-cdk-lib.RemovalPolicy"
}
},
"Summary": "Apply the given removal policy to this resource.",
"Remarks": "The Removal Policy controls what happens to this resource when it stops\nbeing managed by CloudFormation, either because you've removed it from the\nCDK application or because you've made a change that requires the resource\nto be replaced.\n\nThe resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS\naccount for data recovery and cleanup later (`RemovalPolicy.RETAIN`).",
"Static": false
},
"generatePhysicalName": {
"Parameters": {},
"Summary": "",
"Remarks": "",
"Static": false,
"ReturnType": "String"
},
"getResourceArnAttribute": {
"Parameters": {
"arnAttr": {
"Summary": "The CFN attribute which resolves to the ARN of the resource.",
"Type": "String"
},
"arnComponents": {
"Summary": "The format of the ARN of this resource.",
"Type": "aws-cdk-lib.ArnComponents"
}
},
"Summary": "Returns an environment-sensitive token that should be used for the resource's \"ARN\" attribute (e.g. `bucket.bucketArn`).",
"Remarks": "Normally, this token will resolve to `arnAttr`, but if the resource is\nreferenced across environments, `arnComponents` will be used to synthesize\na concrete ARN with the resource's physical name. Make sure to reference\n`this.physicalName` in `arnComponents`.",
"Static": false,
"ReturnType": "String"
},
"getResourceNameAttribute": {
"Parameters": {
"nameAttr": {
"Summary": "The CFN attribute which resolves to the resource's name.",
"Type": "String"
}
},
"Summary": "Returns an environment-sensitive token that should be used for the resource's \"name\" attribute (e.g. `bucket.bucketName`).",
"Remarks": "Normally, this token will resolve to `nameAttr`, but if the resource is\nreferenced across environments, it will be resolved to `this.physicalName`,\nwhich will be a concrete name.",
"Static": false,
"ReturnType": "String"
},
"addEventSource": {
"Parameters": {
"source": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.IEventSource"
}
},
"Summary": "Adds an event source to this function.",
"Remarks": "Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.\n\nThe following example adds an SQS Queue as an event source:\n```\nimport { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';\nmyFunction.addEventSource(new SqsEventSource(myQueue));\n```",
"Static": false
},
"addEventSourceMapping": {
"Parameters": {
"id": {
"Summary": "",
"Type": "String"
},
"options": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.EventSourceMappingOptions"
}
},
"Summary": "Adds an event source that maps to this AWS Lambda function.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_lambda.EventSourceMapping"
},
"addFunctionUrl": {
"Parameters": {
"options": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.FunctionUrlOptions"
}
},
"Summary": "Adds a url to this lambda function.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_lambda.FunctionUrl"
},
"addPermission": {
"Parameters": {
"id": {
"Summary": "The id for the permission construct.",
"Type": "String"
},
"permission": {
"Summary": "The permission to grant to this Lambda function.",
"Type": "aws-cdk-lib.aws_lambda.Permission"
}
},
"Summary": "Adds a permission to the Lambda resource policy.",
"Remarks": "",
"Static": false
},
"addToRolePolicy": {
"Parameters": {
"statement": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.PolicyStatement"
}
},
"Summary": "Adds a statement to the IAM role assumed by the instance.",
"Remarks": "",
"Static": false
},
"configureAsyncInvoke": {
"Parameters": {
"options": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.EventInvokeConfigOptions"
}
},
"Summary": "Configures options for asynchronous invocation.",
"Remarks": "",
"Static": false
},
"considerWarningOnInvokeFunctionPermissions": {
"Parameters": {
"_scope": {
"Summary": "",
"Type": "constructs.Construct"
},
"_action": {
"Summary": "",
"Type": "String"
}
},
"Summary": "A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function.",
"Remarks": "- function.currentVersion is invoked before or after the permission is created.\n\nThis applies only to permissions on Lambda functions, not versions or aliases.\nThis function is overridden as a noOp for QualifiedFunctionBase.",
"Static": false
},
"grantInvoke": {
"Parameters": {
"grantee": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.IGrantable"
}
},
"Summary": "Grant the given identity permissions to invoke this Lambda.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_iam.Grant"
},
"grantInvokeCompositePrincipal": {
"Parameters": {
"compositePrincipal": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.CompositePrincipal"
}
},
"Summary": "Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.",
"Remarks": "",
"Static": false,
"ReturnType": "List"
},
"grantInvokeLatestVersion": {
"Parameters": {
"grantee": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.IGrantable"
}
},
"Summary": "Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_iam.Grant"
},
"grantInvokeUrl": {
"Parameters": {
"grantee": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.IGrantable"
}
},
"Summary": "Grant the given identity permissions to invoke this Lambda Function URL.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_iam.Grant"
},
"grantInvokeVersion": {
"Parameters": {
"grantee": {
"Summary": "",
"Type": "aws-cdk-lib.aws_iam.IGrantable"
},
"version": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.IVersion"
}
},
"Summary": "Grant the given identity permissions to invoke the given version of this Lambda.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_iam.Grant"
},
"metric": {
"Parameters": {
"metricName": {
"Summary": "",
"Type": "String"
},
"props": {
"Summary": "",
"Type": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
}
},
"Summary": "Return the given named metric for this Function.",
"Remarks": "",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_cloudwatch.Metric"
},
"metricDuration": {
"Parameters": {
"props": {
"Summary": "",
"Type": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
}
},
"Summary": "How long execution of this Lambda takes.",
"Remarks": "Average over 5 minutes",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_cloudwatch.Metric"
},
"metricErrors": {
"Parameters": {
"props": {
"Summary": "",
"Type": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
}
},
"Summary": "How many invocations of this Lambda fail.",
"Remarks": "Sum over 5 minutes",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_cloudwatch.Metric"
},
"metricInvocations": {
"Parameters": {
"props": {
"Summary": "",
"Type": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
}
},
"Summary": "How often this Lambda is invoked.",
"Remarks": "Sum over 5 minutes",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_cloudwatch.Metric"
},
"metricThrottles": {
"Parameters": {
"props": {
"Summary": "",
"Type": "aws-cdk-lib.aws_cloudwatch.MetricOptions"
}
},
"Summary": "How often this Lambda is throttled.",
"Remarks": "Sum over 5 minutes",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_cloudwatch.Metric"
},
"warnInvokeFunctionPermissions": {
"Parameters": {
"scope": {
"Summary": "",
"Type": "constructs.Construct"
}
},
"Summary": "",
"Remarks": "",
"Static": false
},
"aws-cdk-lib.aws_lambda.Alias.fromAliasAttributes": {
"Parameters": {
"scope": {
"Summary": "",
"Type": "constructs.Construct"
},
"id": {
"Summary": "",
"Type": "String"
},
"attrs": {
"Summary": "",
"Type": "aws-cdk-lib.aws_lambda.AliasAttributes"
}
},
"Summary": "",
"Remarks": "",
"Static": true,
"ReturnType": "aws-cdk-lib.aws_lambda.IAlias"
},
"addAutoScaling": {
"Parameters": {
"options": {
"Summary": "Autoscaling options.",
"Type": "aws-cdk-lib.aws_lambda.AutoScalingOptions"
}
},
"Summary": "Configure provisioned concurrency autoscaling on a function alias.",
"Remarks": "Returns a scalable attribute that can call\n`scaleOnUtilization()` and `scaleOnSchedule()`.",
"Static": false,
"ReturnType": "aws-cdk-lib.aws_lambda.IScalableFunctionAttribute"
}
},
"PublicProperties": {
"node": {
"Remarks": "",
"Summary": "The tree node.",
"Required": true,
"Type": "constructs.Node"
},
"env": {
"Remarks": "For resources that are created and managed by the CDK\n(generally, those created by creating new class instances like Role, Bucket, etc.),\nthis is always the same as the environment of the stack they belong to;\nhowever, for imported resources\n(those obtained from static methods like fromRoleArn, fromBucketName, etc.),\nthat might be different than the stack they were imported into.",
"Summary": "The environment this resource belongs to.",
"Required": true,
"Type": "aws-cdk-lib.ResourceEnvironment"
},
"stack": {
"Remarks": "",
"Summary": "The stack in which this resource is defined.",
"Required": true,
"Type": "aws-cdk-lib.Stack"
},
"architecture": {
"Remarks": "",
"Summary": "The architecture of this Lambda Function.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.Architecture"
},
"connections": {
"Remarks": "Will fail if not a VPC-enabled Lambda Function",
"Summary": "Access the Connections object.",
"Required": true,
"Type": "aws-cdk-lib.aws_ec2.Connections"
},
"functionArn": {
"Remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.",
"Summary": "ARN of this alias.",
"Required": true,
"Type": "String"
},
"functionName": {
"Remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.",
"Summary": "ARN of this alias.",
"Required": true,
"Type": "String"
},
"grantPrincipal": {
"Remarks": "",
"Summary": "The principal this Lambda Function is running as.",
"Required": true,
"Type": "aws-cdk-lib.aws_iam.IPrincipal"
},
"isBoundToVpc": {
"Remarks": "If this is is `false`, trying to access the `connections` object will fail.",
"Summary": "Whether or not this Lambda function was bound to a VPC.",
"Required": true,
"Type": "Boolean"
},
"latestVersion": {
"Remarks": "Note that this is reference to a non-specific AWS Lambda version, which\nmeans the function this version refers to can return different results in\ndifferent invocations.\n\nTo obtain a reference to an explicit version which references the current\nfunction configuration, use `lambdaFunction.currentVersion` instead.",
"Summary": "The `$LATEST` version of this function.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.IVersion"
},
"permissionsNode": {
"Remarks": "",
"Summary": "The construct node where permissions are attached.",
"Required": true,
"Type": "constructs.Node"
},
"resourceArnsForGrantInvoke": {
"Remarks": "",
"Summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().",
"Required": true,
"Type": "List",
"ItemType": "String"
},
"role": {
"Remarks": "Undefined if the function was imported without a role.",
"Summary": "The IAM role associated with this function.",
"Required": false,
"Type": "aws-cdk-lib.aws_iam.IRole"
},
"lambda": {
"Remarks": "",
"Summary": "The underlying `IFunction`.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.IFunction"
},
"aliasName": {
"Remarks": "",
"Summary": "Name of this alias.",
"Required": true,
"Type": "String"
},
"version": {
"Remarks": "",
"Summary": "The underlying Lambda function version.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.IVersion"
}
}
},
"CodeSigningConfig": {
"Properties": {
"signingProfiles": {
"Remarks": "",
"Summary": "List of signing profiles that defines a trusted user who can sign a code package.",
"Required": true,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_signer.ISigningProfile"
},
"description": {
"Remarks": "",
"Summary": "Code signing configuration description.",
"Required": false,
"Type": "String"
},
"untrustedArtifactOnDeployment": {
"Remarks": "If you set the policy to Enforce, Lambda blocks the deployment request\nif signature validation checks fail.\nIf you set the policy to Warn, Lambda allows the deployment and\ncreates a CloudWatch log.",
"Summary": "Code signing configuration policy for deployment validation failure.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.UntrustedArtifactOnDeployment"
}
},
"Methods": {
"aws-cdk-lib.aws_lambda.CodeSigningConfig.isConstruct": {
"Parameters": {
"x": {
"Summary": "Any object.",
"Type": "Any"
}
},
"Summary": "Checks if `x` is a construct.",
"Remarks": "Use this method instead of `instanceof` to properly detect `Construct`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `constructs` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `Construct` in each copy of the `constructs` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `constructs`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.",
"Static": true,
"ReturnType": "Boolean"
},
"toString": {
"Parameters": {},
"Summary": "Returns a string representation of this construct.",
"Remarks": "",
"Static": false,
"ReturnType": "String"
},
"aws-cdk-lib.aws_lambda.CodeSigningConfig.isOwnedResource": {
"Parameters": {
"construct": {
"Summary": "",
"Type": "constructs.IConstruct"
}
},
"Summary": "Returns true if the construct was created by CDK, and false otherwise.",
"Remarks": "",
"Static": true,
"ReturnType": "Boolean"
},
"aws-cdk-lib.aws_lambda.CodeSigningConfig.isResource": {
"Parameters": {
"construct": {
"Summary": "",
"Type": "constructs.IConstruct"
}
},
"Summary": "Check whether the given construct is a Resource.",
"Remarks": "",
"Static": true,
"ReturnType": "Boolean"
},
"applyRemovalPolicy": {
"Parameters": {
"policy": {
"Summary": "",
"Type": "aws-cdk-lib.RemovalPolicy"
}
},
"Summary": "Apply the given removal policy to this resource.",
"Remarks": "The Removal Policy controls what happens to this resource when it stops\nbeing managed by CloudFormation, either because you've removed it from the\nCDK application or because you've made a change that requires the resource\nto be replaced.\n\nThe resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS\naccount for data recovery and cleanup later (`RemovalPolicy.RETAIN`).",
"Static": false
},
"generatePhysicalName": {
"Parameters": {},
"Summary": "",
"Remarks": "",
"Static": false,
"ReturnType": "String"
},
"getResourceArnAttribute": {
"Parameters": {
"arnAttr": {
"Summary": "The CFN attribute which resolves to the ARN of the resource.",
"Type": "String"
},
"arnComponents": {
"Summary": "The format of the ARN of this resource.",
"Type": "aws-cdk-lib.ArnComponents"
}
},
"Summary": "Returns an environment-sensitive token that should be used for the resource's \"ARN\" attribute (e.g. `bucket.bucketArn`).",
"Remarks": "Normally, this token will resolve to `arnAttr`, but if the resource is\nreferenced across environments, `arnComponents` will be used to synthesize\na concrete ARN with the resource's physical name. Make sure to reference\n`this.physicalName` in `arnComponents`.",
"Static": false,
"ReturnType": "String"
},
"getResourceNameAttribute": {
"Parameters": {
"nameAttr": {
"Summary": "The CFN attribute which resolves to the resource's name.",
"Type": "String"
}
},
"Summary": "Returns an environment-sensitive token that should be used for the resource's \"name\" attribute (e.g. `bucket.bucketName`).",
"Remarks": "Normally, this token will resolve to `nameAttr`, but if the resource is\nreferenced across environments, it will be resolved to `this.physicalName`,\nwhich will be a concrete name.",
"Static": false,
"ReturnType": "String"
},
"aws-cdk-lib.aws_lambda.CodeSigningConfig.fromCodeSigningConfigArn": {
"Parameters": {
"scope": {
"Summary": "The parent creating construct (usually `this`).",
"Type": "constructs.Construct"
},
"id": {
"Summary": "The construct's name.",
"Type": "String"
},
"codeSigningConfigArn": {
"Summary": "The ARN of code signing config.",
"Type": "String"
}
},
"Summary": "Creates a Signing Profile construct that represents an external Signing Profile.",
"Remarks": "",
"Static": true,
"ReturnType": "aws-cdk-lib.aws_lambda.ICodeSigningConfig"
}
},
"PublicProperties": {
"node": {
"Remarks": "",
"Summary": "The tree node.",
"Required": true,
"Type": "constructs.Node"
},
"env": {
"Remarks": "For resources that are created and managed by the CDK\n(generally, those created by creating new class instances like Role, Bucket, etc.),\nthis is always the same as the environment of the stack they belong to;\nhowever, for imported resources\n(those obtained from static methods like fromRoleArn, fromBucketName, etc.),\nthat might be different than the stack they were imported into.",
"Summary": "The environment this resource belongs to.",
"Required": true,
"Type": "aws-cdk-lib.ResourceEnvironment"
},
"stack": {
"Remarks": "",
"Summary": "The stack in which this resource is defined.",
"Required": true,
"Type": "aws-cdk-lib.Stack"
},
"codeSigningConfigArn": {
"Remarks": "",
"Summary": "The ARN of Code Signing Config.",
"Required": true,
"Type": "String"
},
"codeSigningConfigId": {
"Remarks": "",
"Summary": "The id of Code Signing Config.",
"Required": true,
"Type": "String"
}
}
},
"DockerImageFunction": {
"Properties": {
"maxEventAge": {
"Remarks": "Minimum: 60 seconds\nMaximum: 6 hours",
"Summary": "The maximum age of a request that Lambda sends to a function for processing.",
"Required": false,
"Type": "aws-cdk-lib.Duration"
},
"onFailure": {
"Remarks": "",
"Summary": "The destination for failed invocations.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.IDestination"
},
"onSuccess": {
"Remarks": "",
"Summary": "The destination for successful invocations.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.IDestination"
},
"retryAttempts": {
"Remarks": "Minimum: 0\nMaximum: 2",
"Summary": "The maximum number of times to retry when the function returns an error.",
"Required": false,
"Type": "Number"
},
"adotInstrumentation": {
"Remarks": "",
"Summary": "Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.AdotInstrumentationConfig"
},
"allowAllIpv6Outbound": {
"Remarks": "If set to true, there will only be a single egress rule which allows all\noutbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the\nLambda to connect to network targets using ipv6.\n\nDo not specify this property if the `securityGroups` or `securityGroup` property is set.\nInstead, configure `allowAllIpv6Outbound` directly on the security group.",
"Summary": "Whether to allow the Lambda to send all ipv6 network traffic.",
"Required": false,
"Type": "Boolean"
},
"allowAllOutbound": {
"Remarks": "If set to false, you must individually add traffic rules to allow the\nLambda to connect to network targets.\n\nDo not specify this property if the `securityGroups` or `securityGroup` property is set.\nInstead, configure `allowAllOutbound` directly on the security group.",
"Summary": "Whether to allow the Lambda to send all network traffic (except ipv6).",
"Required": false,
"Type": "Boolean"
},
"allowPublicSubnet": {
"Remarks": "Use this property to acknowledge this limitation and still place the function in a public subnet.",
"Summary": "Lambda Functions in a public subnet can NOT access the internet.",
"Required": false,
"Type": "Boolean"
},
"applicationLogLevel": {
"Remarks": "",
"Summary": "Sets the application log level for the function.",
"Required": false,
"Type": "String"
},
"applicationLogLevelV2": {
"Remarks": "",
"Summary": "Sets the application log level for the function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.ApplicationLogLevel"
},
"architecture": {
"Remarks": "",
"Summary": "The system architectures compatible with this lambda function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.Architecture"
},
"codeSigningConfig": {
"Remarks": "",
"Summary": "Code signing config associated with this function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.ICodeSigningConfig"
},
"currentVersionOptions": {
"Remarks": "",
"Summary": "Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.VersionOptions"
},
"deadLetterQueue": {
"Remarks": "If SNS topic is desired, specify `deadLetterTopic` property instead.",
"Summary": "The SQS queue to use if DLQ is enabled.",
"Required": false,
"Type": "aws-cdk-lib.aws_sqs.IQueue"
},
"deadLetterQueueEnabled": {
"Remarks": "If `deadLetterQueue` is undefined,\nan SQS queue with default options will be defined for your Function.",
"Summary": "Enabled DLQ.",
"Required": false,
"Type": "Boolean"
},
"deadLetterTopic": {
"Remarks": "Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created\nrather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.",
"Summary": "The SNS topic to use as a DLQ.",
"Required": false,
"Type": "aws-cdk-lib.aws_sns.ITopic"
},
"description": {
"Remarks": "",
"Summary": "A description of the function.",
"Required": false,
"Type": "String"
},
"environment": {
"Remarks": "Use environment variables to apply configuration changes, such\nas test and production environment configurations, without changing your\nLambda function source code.",
"Summary": "Key-value pairs that Lambda caches and makes available for your Lambda functions.",
"Required": false,
"Type": "Map",
"ItemType": "String"
},
"environmentEncryption": {
"Remarks": "",
"Summary": "The AWS KMS key that's used to encrypt your function's environment variables.",
"Required": false,
"Type": "aws-cdk-lib.aws_kms.IKey"
},
"ephemeralStorageSize": {
"Remarks": "",
"Summary": "The size of the function’s /tmp directory in MiB.",
"Required": false,
"Type": "aws-cdk-lib.Size"
},
"events": {
"Remarks": "You can also add event sources using `addEventSource`.",
"Summary": "Event sources for this function.",
"Required": false,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_lambda.IEventSource"
},
"filesystem": {
"Remarks": "",
"Summary": "The filesystem configuration for the lambda function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.FileSystem"
},
"functionName": {
"Remarks": "",
"Summary": "A name for the function.",
"Required": false,
"Type": "String"
},
"initialPolicy": {
"Remarks": "You can call `addToRolePolicy` to the created lambda to add statements post creation.",
"Summary": "Initial policy statements to add to the created Lambda Role.",
"Required": false,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_iam.PolicyStatement"
},
"insightsVersion": {
"Remarks": "",
"Summary": "Specify the version of CloudWatch Lambda insights to use for monitoring.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.LambdaInsightsVersion"
},
"ipv6AllowedForDualStack": {
"Remarks": "Only used if 'vpc' is supplied.",
"Summary": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.",
"Required": false,
"Type": "Boolean"
},
"layers": {
"Remarks": "You can configure your Lambda function to pull in\nadditional code during initialization in the form of layers. Layers are packages of libraries or other dependencies\nthat can be used by multiple functions.",
"Summary": "A list of layers to add to the function's execution environment.",
"Required": false,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_lambda.ILayerVersion"
},
"logFormat": {
"Remarks": "",
"Summary": "Sets the logFormat for the function.",
"Required": false,
"Type": "String"
},
"loggingFormat": {
"Remarks": "",
"Summary": "Sets the loggingFormat for the function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.LoggingFormat"
},
"logGroup": {
"Remarks": "By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/\\<function name\\>.\nHowever you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.\n\nUse the `logGroup` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.\n\nProviding a user-controlled log group was rolled out to commercial regions on 2023-11-16.\nIf you are deploying to another type of region, please check regional availability first.",
"Summary": "The log group the function sends logs to.",
"Required": false,
"Type": "aws-cdk-lib.aws_logs.ILogGroup"
},
"logRetention": {
"Remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `INFINITE`.\n\nThis is a legacy API and we strongly recommend you move away from it if you can.\nInstead create a fully customizable log group with `logs.LogGroup` and use the `logGroup` property\nto instruct the Lambda function to send logs to it.\nMigrating from `logRetention` to `logGroup` will cause the name of the log group to change.\nUsers and code and referencing the name verbatim will have to adjust.\n\nIn AWS CDK code, you can access the log group name directly from the LogGroup construct:\n```ts\nimport * as logs from 'aws-cdk-lib/aws-logs';\n\ndeclare const myLogGroup: logs.LogGroup;\nmyLogGroup.logGroupName;\n```",
"Summary": "The number of days log events are kept in CloudWatch Logs.",
"Required": false,
"Type": "aws-cdk-lib.aws_logs.RetentionDays"
},
"logRetentionRetryOptions": {
"Remarks": "These options control the retry policy when interacting with CloudWatch APIs.\n\nThis is a legacy API and we strongly recommend you migrate to `logGroup` if you can.\n`logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.",
"Summary": "When log retention is specified, a custom resource attempts to create the CloudWatch log group.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.LogRetentionRetryOptions"
},
"logRetentionRole": {
"Remarks": "This is a legacy API and we strongly recommend you migrate to `logGroup` if you can.\n`logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.",
"Summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy.",
"Required": false,
"Type": "aws-cdk-lib.aws_iam.IRole"
},
"memorySize": {
"Remarks": "Lambda uses this value to proportionally allocate the amount of CPU\npower. For more information, see Resource Model in the AWS Lambda\nDeveloper Guide.",
"Summary": "The amount of memory, in MB, that is allocated to your Lambda function.",
"Required": false,
"Type": "Number"
},
"paramsAndSecrets": {
"Remarks": "",
"Summary": "Specify the configuration of Parameters and Secrets Extension.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion"
},
"profiling": {
"Remarks": "",
"Summary": "Enable profiling.",
"Required": false,
"Type": "Boolean"
},
"profilingGroup": {
"Remarks": "",
"Summary": "Profiling Group.",
"Required": false,
"Type": "aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup"
},
"recursiveLoop": {
"Remarks": "It lets Lambda detect and terminate unintended recursive loops.",
"Summary": "Sets the Recursive Loop Protection for Lambda Function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.RecursiveLoop"
},
"reservedConcurrentExecutions": {
"Remarks": "",
"Summary": "The maximum of concurrent executions you want to reserve for the function.",
"Required": false,
"Type": "Number"
},
"role": {
"Remarks": "This is the role that will be assumed by the function upon execution.\nIt controls the permissions that the function will have. The Role must\nbe assumable by the 'lambda.amazonaws.com' service principal.\n\nThe default Role automatically has permissions granted for Lambda execution. If you\nprovide a Role, you must add the relevant AWS managed policies yourself.\n\nThe relevant managed policies are \"service-role/AWSLambdaBasicExecutionRole\" and\n\"service-role/AWSLambdaVPCAccessExecutionRole\".",
"Summary": "Lambda execution role.",
"Required": false,
"Type": "aws-cdk-lib.aws_iam.IRole"
},
"runtimeManagementMode": {
"Remarks": "",
"Summary": "Sets the runtime management configuration for a function's version.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.RuntimeManagementMode"
},
"securityGroups": {
"Remarks": "Only used if 'vpc' is supplied.",
"Summary": "The list of security groups to associate with the Lambda's network interfaces.",
"Required": false,
"Type": "List",
"ItemType": "aws-cdk-lib.aws_ec2.ISecurityGroup"
},
"snapStart": {
"Remarks": "SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime",
"Summary": "Enable SnapStart for Lambda Function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.SnapStartConf"
},
"systemLogLevel": {
"Remarks": "",
"Summary": "Sets the system log level for the function.",
"Required": false,
"Type": "String"
},
"systemLogLevelV2": {
"Remarks": "",
"Summary": "Sets the system log level for the function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.SystemLogLevel"
},
"timeout": {
"Remarks": "Because the execution time affects cost, set this value\nbased on the function's expected execution time.",
"Summary": "The function execution time (in seconds) after which Lambda terminates the function.",
"Required": false,
"Type": "aws-cdk-lib.Duration"
},
"tracing": {
"Remarks": "",
"Summary": "Enable AWS X-Ray Tracing for Lambda Function.",
"Required": false,
"Type": "aws-cdk-lib.aws_lambda.Tracing"
},
"vpc": {
"Remarks": "Specify this if the Lambda function needs to access resources in a VPC.\nThis is required when `vpcSubnets` is specified.",
"Summary": "VPC network to place Lambda network interfaces.",
"Required": false,
"Type": "aws-cdk-lib.aws_ec2.IVpc"
},
"vpcSubnets": {
"Remarks": "This requires `vpc` to be specified in order for interfaces to actually be\nplaced in the subnets. If `vpc` is not specify, this will raise an error.\n\nNote: Internet access for Lambda Functions requires a NAT Gateway, so picking\npublic subnets is not allowed (unless `allowPublicSubnet` is set to `true`).",
"Summary": "Where to place the network interfaces within the VPC.",
"Required": false,
"Type": "aws-cdk-lib.aws_ec2.SubnetSelection"
},
"code": {
"Remarks": "You can point to a file in an\nAmazon Simple Storage Service (Amazon S3) bucket or specify your source\ncode as inline text.",
"Summary": "The source code of your Lambda function.",
"Required": true,
"Type": "aws-cdk-lib.aws_lambda.DockerImageCode"
}
},
"Methods": {
"aws-cdk-lib.aws_lambda.DockerImageFunction.isConstruct": {
"Parameters": {
"x": {
"Summary": "Any object.",
"Type": "Any"
}
},
"Summary": "Checks if `x` is a construct.",
"Remarks": "Use this method instead of `instanceof` to properly detect `Construct`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `constructs` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `Construct` in each copy of the `constructs` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `constructs`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.",