-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
Copy pathsam.schema.json
8574 lines (8574 loc) · 578 KB
/
sam.schema.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
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"AlexaSkillEvent": {
"additionalProperties": false,
"properties": {
"Properties": {
"allOf": [
{
"$ref": "#/definitions/AlexaSkillEventProperties"
}
],
"markdownDescription": "Object describing properties of this event mapping\\. The set of properties must conform to the defined Type\\. \n*Type*: [AlexaSkill](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-alexaskill.html) \\| [Api](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-api.html) \\| [CloudWatchEvent](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchevent.html) \\| [CloudWatchLogs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchlogs.html) \\| [Cognito](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cognito.html) \\| [DocumentDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-documentdb.html) \\| [DynamoDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-dynamodb.html) \\| [EventBridgeRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-eventbridgerule.html) \\| [HttpApi](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-httpapi.html) \\| [IoTRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-iotrule.html) \\| [Kinesis](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-kinesis.html) \\| [MQ](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-mq.html) \\| [MSK](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-msk.html) \\| [S3](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-s3.html) \\| [Schedule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedule.html) \\| [ScheduleV2](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedulev2.html) \\| [SelfManagedKafka](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-selfmanagedkafka.html) \\| [SNS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sns.html) \\| [SQS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sqs.html) \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Properties"
},
"Type": {
"enum": [
"AlexaSkill"
],
"markdownDescription": "The event type\\. \n*Valid values*: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"Type"
],
"title": "AlexaSkillEvent",
"type": "object"
},
"AlexaSkillEventProperties": {
"additionalProperties": false,
"properties": {
"SkillId": {
"markdownDescription": "The Alexa Skill ID for your Alexa Skill\\. For more information about Skill ID see [Configure the trigger for a Lambda function](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) in the Alexa Skills Kit documentation\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "SkillId",
"type": "string"
}
},
"title": "AlexaSkillEventProperties",
"type": "object"
},
"ApiAuth": {
"additionalProperties": false,
"properties": {
"ApiKeyRequired": {
"markdownDescription": "Requires an API key for this API, path, and method\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "ApiKeyRequired",
"type": "boolean"
},
"AuthorizationScopes": {
"items": {
"type": "string"
},
"markdownDescription": "The authorization scopes to apply to this API, path, and method\\. \nThe scopes that you specify will override any scopes applied by the `DefaultAuthorizer` property if you have specified it\\. \n*Type*: List \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AuthorizationScopes",
"type": "array"
},
"Authorizer": {
"markdownDescription": "The `Authorizer` for a specific function\\. \nIf you have a global authorizer specified for your `AWS::Serverless::Api` resource, you can override the authorizer by setting `Authorizer` to `NONE`\\. For an example, see [Override a global authorizer for your Amazon API Gateway REST API](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/#sam-property-function-apifunctionauth--examples--override.html#sam-property-function-apifunctionauth--examples--override)\\. \nIf you use the `DefinitionBody` property of an `AWS::Serverless::Api` resource to describe your API, you must use `OverrideApiAuth` with `Authorizer` to override your global authorizer\\. See `OverrideApiAuth` for more information\\.\n*Valid values*: `AWS_IAM`, `NONE`, or the logical ID for any authorizer defined in your AWS SAM template\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Authorizer",
"type": "string"
},
"InvokeRole": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "Specifies the `InvokeRole` to use for `AWS_IAM` authorization\\. \n*Type*: String \n*Required*: No \n*Default*: `CALLER_CREDENTIALS` \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\. \n*Additional notes*: `CALLER_CREDENTIALS` maps to `arn:aws:iam::*:user/*`, which uses the caller credentials to invoke the endpoint\\.",
"title": "InvokeRole"
},
"OverrideApiAuth": {
"title": "Overrideapiauth",
"type": "boolean"
},
"ResourcePolicy": {
"allOf": [
{
"$ref": "#/definitions/samtranslator__internal__schema_source__aws_serverless_function__ResourcePolicy"
}
],
"markdownDescription": "Configure Resource Policy for this path on an API\\. \n*Type*: [ResourcePolicyStatement](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-resourcepolicystatement.html) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "ResourcePolicy"
}
},
"title": "ApiAuth",
"type": "object"
},
"ApiKey": {
"additionalProperties": false,
"properties": {
"ApiKeyId": {
"$ref": "#/definitions/PassThroughProp"
},
"Description": {
"$ref": "#/definitions/PassThroughProp"
},
"ExpiresOn": {
"$ref": "#/definitions/PassThroughProp"
}
},
"title": "ApiKey",
"type": "object"
},
"Authorizer": {
"additionalProperties": false,
"properties": {
"LambdaAuthorizer": {
"$ref": "#/definitions/LambdaAuthorizerConfig"
},
"OpenIDConnect": {
"$ref": "#/definitions/OpenIDConnectConfig"
},
"Type": {
"enum": [
"AWS_IAM",
"API_KEY",
"AWS_LAMBDA",
"OPENID_CONNECT",
"AMAZON_COGNITO_USER_POOLS"
],
"title": "Type",
"type": "string"
},
"UserPool": {
"$ref": "#/definitions/UserPoolConfig"
}
},
"required": [
"Type"
],
"title": "Authorizer",
"type": "object"
},
"Cache": {
"additionalProperties": false,
"properties": {
"ApiCachingBehavior": {
"$ref": "#/definitions/PassThroughProp"
},
"AtRestEncryptionEnabled": {
"$ref": "#/definitions/PassThroughProp"
},
"TransitEncryptionEnabled": {
"$ref": "#/definitions/PassThroughProp"
},
"Ttl": {
"$ref": "#/definitions/PassThroughProp"
},
"Type": {
"$ref": "#/definitions/PassThroughProp"
}
},
"required": [
"ApiCachingBehavior",
"Ttl",
"Type"
],
"title": "Cache",
"type": "object"
},
"Caching": {
"additionalProperties": false,
"properties": {
"CachingKeys": {
"items": {
"$ref": "#/definitions/PassThroughProp"
},
"title": "Cachingkeys",
"type": "array"
},
"Ttl": {
"$ref": "#/definitions/PassThroughProp"
}
},
"required": [
"Ttl"
],
"title": "Caching",
"type": "object"
},
"CloudWatchLogsEvent": {
"additionalProperties": false,
"properties": {
"Properties": {
"allOf": [
{
"$ref": "#/definitions/CloudWatchLogsEventProperties"
}
],
"markdownDescription": "Object describing properties of this event mapping\\. The set of properties must conform to the defined Type\\. \n*Type*: [AlexaSkill](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-alexaskill.html) \\| [Api](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-api.html) \\| [CloudWatchEvent](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchevent.html) \\| [CloudWatchLogs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchlogs.html) \\| [Cognito](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cognito.html) \\| [DocumentDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-documentdb.html) \\| [DynamoDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-dynamodb.html) \\| [EventBridgeRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-eventbridgerule.html) \\| [HttpApi](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-httpapi.html) \\| [IoTRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-iotrule.html) \\| [Kinesis](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-kinesis.html) \\| [MQ](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-mq.html) \\| [MSK](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-msk.html) \\| [S3](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-s3.html) \\| [Schedule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedule.html) \\| [ScheduleV2](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedulev2.html) \\| [SelfManagedKafka](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-selfmanagedkafka.html) \\| [SNS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sns.html) \\| [SQS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sqs.html) \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Properties"
},
"Type": {
"enum": [
"CloudWatchLogs"
],
"markdownDescription": "The event type\\. \n*Valid values*: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"Type",
"Properties"
],
"title": "CloudWatchLogsEvent",
"type": "object"
},
"CloudWatchLogsEventProperties": {
"additionalProperties": false,
"properties": {
"FilterPattern": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The filtering expressions that restrict what gets delivered to the destination AWS resource\\. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`FilterPattern`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern) property of an `AWS::Logs::SubscriptionFilter` resource\\.",
"title": "FilterPattern"
},
"LogGroupName": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The log group to associate with the subscription filter\\. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`LogGroupName`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname) property of an `AWS::Logs::SubscriptionFilter` resource\\.",
"title": "LogGroupName"
}
},
"required": [
"FilterPattern",
"LogGroupName"
],
"title": "CloudWatchLogsEventProperties",
"type": "object"
},
"CodeUri": {
"additionalProperties": false,
"properties": {
"Bucket": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "An Amazon S3 bucket in the same AWS Region as your function\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3Bucket`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket) property of the `AWS::Lambda::Function` `Code` data type\\.",
"title": "Bucket"
},
"Key": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "The Amazon S3 key of the deployment package\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3Key`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key) property of the `AWS::Lambda::Function` `Code` data type\\.",
"title": "Key"
},
"Version": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "For versioned objects, the version of the deployment package object to use\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3ObjectVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion) property of the `AWS::Lambda::Function` `Code` data type\\.",
"title": "Version"
}
},
"required": [
"Bucket",
"Key"
],
"title": "CodeUri",
"type": "object"
},
"CognitoAuthorizer": {
"additionalProperties": false,
"properties": {
"AuthorizationScopes": {
"items": {
"type": "string"
},
"markdownDescription": "List of authorization scopes for this authorizer\\. \n*Type*: List \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AuthorizationScopes",
"type": "array"
},
"Identity": {
"allOf": [
{
"$ref": "#/definitions/CognitoAuthorizerIdentity"
}
],
"markdownDescription": "This property can be used to specify an `IdentitySource` in an incoming request for an authorizer\\. \n*Type*: [CognitoAuthorizationIdentity](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-cognitoauthorizationidentity.html) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Identity"
},
"UserPoolArn": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "Can refer to a user pool/specify a userpool arn to which you want to add this cognito authorizer \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "UserPoolArn"
}
},
"required": [
"UserPoolArn"
],
"title": "CognitoAuthorizer",
"type": "object"
},
"CognitoAuthorizerIdentity": {
"additionalProperties": false,
"properties": {
"Header": {
"markdownDescription": "Specify the header name for Authorization in the OpenApi definition\\. \n*Type*: String \n*Required*: No \n*Default*: Authorization \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Header",
"type": "string"
},
"ReauthorizeEvery": {
"anyOf": [
{
"type": "object"
},
{
"type": "integer"
}
],
"markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches authorizer results\\. If you specify a value greater than 0, API Gateway caches the authorizer responses\\. By default, API Gateway sets this property to 300\\. The maximum value is 3600, or 1 hour\\. \n*Type*: Integer \n*Required*: No \n*Default*: 300 \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "ReauthorizeEvery"
},
"ValidationExpression": {
"markdownDescription": "Specify a validation expression for validating the incoming Identity \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "ValidationExpression",
"type": "string"
}
},
"title": "CognitoAuthorizerIdentity",
"type": "object"
},
"CognitoEvent": {
"additionalProperties": false,
"properties": {
"Properties": {
"allOf": [
{
"$ref": "#/definitions/CognitoEventProperties"
}
],
"markdownDescription": "Object describing properties of this event mapping\\. The set of properties must conform to the defined Type\\. \n*Type*: [AlexaSkill](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-alexaskill.html) \\| [Api](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-api.html) \\| [CloudWatchEvent](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchevent.html) \\| [CloudWatchLogs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchlogs.html) \\| [Cognito](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cognito.html) \\| [DocumentDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-documentdb.html) \\| [DynamoDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-dynamodb.html) \\| [EventBridgeRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-eventbridgerule.html) \\| [HttpApi](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-httpapi.html) \\| [IoTRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-iotrule.html) \\| [Kinesis](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-kinesis.html) \\| [MQ](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-mq.html) \\| [MSK](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-msk.html) \\| [S3](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-s3.html) \\| [Schedule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedule.html) \\| [ScheduleV2](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedulev2.html) \\| [SelfManagedKafka](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-selfmanagedkafka.html) \\| [SNS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sns.html) \\| [SQS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sqs.html) \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Properties"
},
"Type": {
"enum": [
"Cognito"
],
"markdownDescription": "The event type\\. \n*Valid values*: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"Type",
"Properties"
],
"title": "CognitoEvent",
"type": "object"
},
"CognitoEventProperties": {
"additionalProperties": false,
"properties": {
"Trigger": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The Lambda trigger configuration information for the new user pool\\. \n*Type*: List \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`LambdaConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html) property of an `AWS::Cognito::UserPool` resource\\.",
"title": "Trigger"
},
"UserPool": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "Reference to UserPool defined in the same template \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "UserPool"
}
},
"required": [
"Trigger",
"UserPool"
],
"title": "CognitoEventProperties",
"type": "object"
},
"ContentUri": {
"additionalProperties": false,
"properties": {
"Bucket": {
"__samPassThrough": {
"markdownDescriptionOverride": "The Amazon S3 bucket of the layer archive\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3Bucket`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket) property of the `AWS::Lambda::LayerVersion` `Content` data type\\.",
"schemaPath": [
"definitions",
"AWS::Lambda::LayerVersion.Content",
"properties",
"S3Bucket"
]
},
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"title": "Bucket"
},
"Key": {
"__samPassThrough": {
"markdownDescriptionOverride": "The Amazon S3 key of the layer archive\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3Key`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key) property of the `AWS::Lambda::LayerVersion` `Content` data type\\.",
"schemaPath": [
"definitions",
"AWS::Lambda::LayerVersion.Content",
"properties",
"S3Key"
]
},
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"title": "Key"
},
"Version": {
"__samPassThrough": {
"markdownDescriptionOverride": "For versioned objects, the version of the layer archive object to use\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`S3ObjectVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion) property of the `AWS::Lambda::LayerVersion` `Content` data type\\.",
"schemaPath": [
"definitions",
"AWS::Lambda::LayerVersion.Content",
"properties",
"S3ObjectVersion"
]
},
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"title": "Version"
}
},
"required": [
"Bucket",
"Key"
],
"title": "ContentUri",
"type": "object"
},
"Cors": {
"additionalProperties": false,
"properties": {
"AllowCredentials": {
"markdownDescription": "Boolean indicating whether request is allowed to contain credentials\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AllowCredentials",
"type": "boolean"
},
"AllowHeaders": {
"markdownDescription": "String of headers to allow\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AllowHeaders",
"type": "string"
},
"AllowMethods": {
"markdownDescription": "String containing the HTTP methods to allow\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AllowMethods",
"type": "string"
},
"AllowOrigin": {
"markdownDescription": "String of origin to allow\\. This can be a comma\\-separated list in string format\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "AllowOrigin",
"type": "string"
},
"MaxAge": {
"markdownDescription": "String containing the number of seconds to cache CORS Preflight request\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "MaxAge",
"type": "string"
}
},
"required": [
"AllowOrigin"
],
"title": "Cors",
"type": "object"
},
"DataSources": {
"additionalProperties": false,
"properties": {
"DynamoDb": {
"additionalProperties": {
"$ref": "#/definitions/DynamoDBDataSource"
},
"title": "Dynamodb",
"type": "object"
},
"Lambda": {
"additionalProperties": {
"$ref": "#/definitions/LambdaDataSource"
},
"title": "Lambda",
"type": "object"
}
},
"title": "DataSources",
"type": "object"
},
"DeadLetterQueue": {
"additionalProperties": false,
"properties": {
"TargetArn": {
"markdownDescription": "The Amazon Resource Name \\(ARN\\) of an Amazon SQS queue or Amazon SNS topic\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the [`TargetArn`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn) property of the `AWS::Lambda::Function` `DeadLetterConfig` data type\\.",
"title": "TargetArn",
"type": "string"
},
"Type": {
"enum": [
"SNS",
"SQS"
],
"markdownDescription": "The type of dead letter queue\\. \n*Valid values*: `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"TargetArn",
"Type"
],
"title": "DeadLetterQueue",
"type": "object"
},
"DeltaSync": {
"additionalProperties": false,
"properties": {
"BaseTableTTL": {
"$ref": "#/definitions/PassThroughProp"
},
"DeltaSyncTableName": {
"$ref": "#/definitions/PassThroughProp"
},
"DeltaSyncTableTTL": {
"$ref": "#/definitions/PassThroughProp"
}
},
"required": [
"BaseTableTTL",
"DeltaSyncTableName",
"DeltaSyncTableTTL"
],
"title": "DeltaSync",
"type": "object"
},
"DeploymentPreference": {
"additionalProperties": false,
"properties": {
"Alarms": {
"anyOf": [
{
"type": "object"
},
{
"items": {
"type": "object"
},
"type": "array"
}
],
"markdownDescription": "A list of CloudWatch alarms that you want to be triggered by any errors raised by the deployment\\. \nThis property accepts the `Fn::If` intrinsic function\\. See the Examples section at the bottom of this topic for an example template that uses `Fn::If`\\. \n*Type*: List \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Alarms"
},
"Enabled": {
"anyOf": [
{
"type": "object"
},
{
"type": "boolean"
}
],
"markdownDescription": "Whether this deployment preference is enabled\\. \n*Type*: Boolean \n*Required*: No \n*Default*: True \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Enabled"
},
"Hooks": {
"allOf": [
{
"$ref": "#/definitions/Hooks"
}
],
"markdownDescription": "Validation Lambda functions that are run before and after traffic shifting\\. \n*Type*: [Hooks](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-hooks.html) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Hooks"
},
"PassthroughCondition": {
"anyOf": [
{
"type": "object"
},
{
"type": "boolean"
}
],
"markdownDescription": "If True, and if this deployment preference is enabled, the function's Condition will be passed through to the generated CodeDeploy resource\\. Generally, you should set this to True\\. Otherwise, the CodeDeploy resource would be created even if the function's Condition resolves to False\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "PassthroughCondition"
},
"Role": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "An IAM role ARN that CodeDeploy will use for traffic shifting\\. An IAM role will not be created if this is provided\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Role"
},
"TriggerConfigurations": {
"__samPassThrough": {
"markdownDescriptionOverride": "A list of trigger configurations you want to associate with the deployment group\\. Used to notify an SNS topic on lifecycle events\\. \n*Type*: List \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`TriggerConfigurations`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations) property of an `AWS::CodeDeploy::DeploymentGroup` resource\\.",
"schemaPath": [
"definitions",
"AWS::CodeDeploy::DeploymentGroup",
"properties",
"Properties",
"properties",
"TriggerConfigurations"
]
},
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"title": "TriggerConfigurations"
},
"Type": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"markdownDescription": "There are two categories of deployment types at the moment: Linear and Canary\\. For more information about available deployment types see [Deploying serverless applications gradually with AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/automating-updates-to-serverless-apps.html)\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type"
}
},
"title": "DeploymentPreference",
"type": "object"
},
"DocumentDBEvent": {
"additionalProperties": false,
"properties": {
"Properties": {
"allOf": [
{
"$ref": "#/definitions/DocumentDBEventProperties"
}
],
"markdownDescription": "Object describing properties of this event mapping\\. The set of properties must conform to the defined Type\\. \n*Type*: [AlexaSkill](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-alexaskill.html) \\| [Api](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-api.html) \\| [CloudWatchEvent](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchevent.html) \\| [CloudWatchLogs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchlogs.html) \\| [Cognito](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cognito.html) \\| [DocumentDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-documentdb.html) \\| [DynamoDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-dynamodb.html) \\| [EventBridgeRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-eventbridgerule.html) \\| [HttpApi](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-httpapi.html) \\| [IoTRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-iotrule.html) \\| [Kinesis](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-kinesis.html) \\| [MQ](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-mq.html) \\| [MSK](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-msk.html) \\| [S3](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-s3.html) \\| [Schedule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedule.html) \\| [ScheduleV2](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedulev2.html) \\| [SelfManagedKafka](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-selfmanagedkafka.html) \\| [SNS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sns.html) \\| [SQS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sqs.html) \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Properties"
},
"Type": {
"enum": [
"DocumentDB"
],
"markdownDescription": "The event type\\. \n*Valid values*: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"Type",
"Properties"
],
"title": "DocumentDBEvent",
"type": "object"
},
"DocumentDBEventProperties": {
"additionalProperties": false,
"properties": {
"BatchSize": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The maximum number of items to retrieve in a single batch\\. \n*Type*: Integer \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "BatchSize"
},
"Cluster": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon DocumentDB cluster\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "Cluster"
},
"CollectionName": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The name of the collection to consume within the database\\. If you do not specify a collection, Lambda consumes all collections\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` property of an `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data type\\.",
"title": "CollectionName"
},
"DatabaseName": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The name of the database to consume within the Amazon DocumentDB cluster\\. \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` property of an `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig`data type\\.",
"title": "DatabaseName"
},
"Enabled": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "If `true`, the event source mapping is active\\. To pause polling and invocation, set to `false`\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "Enabled"
},
"FilterCriteria": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "An object that defines the criteria that determines whether Lambda should process an event\\. For more information, see [ Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) in the *AWS Lambda Developer Guide*\\. \n*Type*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "FilterCriteria"
},
"FullDocument": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "Determines what Amazon DocumentDB sends to your event stream during document update operations\\. If set to `UpdateLookup`, Amazon DocumentDB sends a delta describing the changes, along with a copy of the entire document\\. Otherwise, Amazon DocumentDB sends only a partial document that contains the changes\\. \n*Type*: String \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` property of an `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` data type\\.",
"title": "FullDocument"
},
"MaximumBatchingWindowInSeconds": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The maximum amount of time to gather records before invoking the function, in seconds\\. \n*Type*: Integer \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "MaximumBatchingWindowInSeconds"
},
"SecretsManagerKmsKeyId": {
"markdownDescription": "The AWS Key Management Service \\(AWS KMS\\) key ID of a customer managed key from AWS Secrets Manager\\. Required when you use a customer managed key from Secrets Manager with a Lambda execution role that doesn\u2019t include the `kms:Decrypt` permission\\. \nThe value of this property is a UUID\\. For example: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`\\. \n*Type*: String \n*Required*: Conditional \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn\u2019t have an AWS CloudFormation equivalent\\.",
"title": "SecretsManagerKmsKeyId",
"type": "string"
},
"SourceAccessConfigurations": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "An array of the authentication protocol or virtual host\\. Specify this using the [ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html) data type\\. \nFor the `DocumentDB` event source type, the only valid configuration type is `BASIC_AUTH`\\. \n+ `BASIC_AUTH` \u2013 The Secrets Manager secret that stores your broker credentials\\. For this type, the credential must be in the following format: `{\"username\": \"your-username\", \"password\": \"your-password\"}`\\. Only one object of type `BASIC_AUTH` is allowed\\.\n*Type*: List \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "SourceAccessConfigurations"
},
"StartingPosition": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The position in a stream from which to start reading\\. \n+ `AT_TIMESTAMP` \u2013 Specify a time from which to start reading records\\.\n+ `LATEST` \u2013 Read only new records\\.\n+ `TRIM_HORIZON` \u2013 Process all available records\\.\n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "StartingPosition"
},
"StartingPositionTimestamp": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The time from which to start reading, in Unix time seconds\\. Define `StartingPositionTimestamp` when `StartingPosition` is specified as `AT_TIMESTAMP`\\. \n*Type*: Double \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "StartingPositionTimestamp"
}
},
"required": [
"Cluster",
"DatabaseName",
"SourceAccessConfigurations"
],
"title": "DocumentDBEventProperties",
"type": "object"
},
"DomainName": {
"additionalProperties": false,
"properties": {
"CertificateArn": {
"$ref": "#/definitions/PassThroughProp"
},
"Description": {
"$ref": "#/definitions/PassThroughProp"
},
"DomainName": {
"$ref": "#/definitions/PassThroughProp"
}
},
"required": [
"CertificateArn",
"DomainName"
],
"title": "DomainName",
"type": "object"
},
"DynamoDBDataSource": {
"additionalProperties": false,
"properties": {
"DeltaSync": {
"$ref": "#/definitions/DeltaSync"
},
"Description": {
"$ref": "#/definitions/PassThroughProp"
},
"Name": {
"$ref": "#/definitions/PassThroughProp"
},
"Permissions": {
"items": {
"enum": [
"Read",
"Write"
],
"type": "string"
},
"title": "Permissions",
"type": "array"
},
"Region": {
"$ref": "#/definitions/PassThroughProp"
},
"ServiceRoleArn": {
"$ref": "#/definitions/PassThroughProp"
},
"TableArn": {
"$ref": "#/definitions/PassThroughProp"
},
"TableName": {
"$ref": "#/definitions/PassThroughProp"
},
"UseCallerCredentials": {
"$ref": "#/definitions/PassThroughProp"
},
"Versioned": {
"$ref": "#/definitions/PassThroughProp"
}
},
"required": [
"TableName"
],
"title": "DynamoDBDataSource",
"type": "object"
},
"DynamoDBEvent": {
"additionalProperties": false,
"properties": {
"Properties": {
"allOf": [
{
"$ref": "#/definitions/DynamoDBEventProperties"
}
],
"markdownDescription": "Object describing properties of this event mapping\\. The set of properties must conform to the defined Type\\. \n*Type*: [AlexaSkill](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-alexaskill.html) \\| [Api](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-api.html) \\| [CloudWatchEvent](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchevent.html) \\| [CloudWatchLogs](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cloudwatchlogs.html) \\| [Cognito](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-cognito.html) \\| [DocumentDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-documentdb.html) \\| [DynamoDB](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-dynamodb.html) \\| [EventBridgeRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-eventbridgerule.html) \\| [HttpApi](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-httpapi.html) \\| [IoTRule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-iotrule.html) \\| [Kinesis](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-kinesis.html) \\| [MQ](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-mq.html) \\| [MSK](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-msk.html) \\| [S3](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-s3.html) \\| [Schedule](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedule.html) \\| [ScheduleV2](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-schedulev2.html) \\| [SelfManagedKafka](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-selfmanagedkafka.html) \\| [SNS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sns.html) \\| [SQS](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-function-sqs.html) \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Properties"
},
"Type": {
"enum": [
"DynamoDB"
],
"markdownDescription": "The event type\\. \n*Valid values*: `AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` \n*Type*: String \n*Required*: Yes \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
"title": "Type",
"type": "string"
}
},
"required": [
"Type",
"Properties"
],
"title": "DynamoDBEvent",
"type": "object"
},
"DynamoDBEventProperties": {
"additionalProperties": false,
"properties": {
"BatchSize": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The maximum number of items to retrieve in a single batch\\. \n*Type*: Integer \n*Required*: No \n*Default*: 100 \n*AWS CloudFormation compatibility*: This property is passed directly to the [`BatchSize`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize) property of an `AWS::Lambda::EventSourceMapping` resource\\. \n*Minimum*: `1` \n*Maximum*: `1000`",
"title": "BatchSize"
},
"BisectBatchOnFunctionError": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "If the function returns an error, split the batch in two and retry\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`BisectBatchOnFunctionError`](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "BisectBatchOnFunctionError"
},
"DestinationConfig": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "An Amazon Simple Queue Service \\(Amazon SQS\\) queue or Amazon Simple Notification Service \\(Amazon SNS\\) topic destination for discarded records\\. \n*Type*: [DestinationConfig](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`DestinationConfig`](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "DestinationConfig"
},
"Enabled": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "Disables the event source mapping to pause polling and invocation\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`Enabled`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "Enabled"
},
"FilterCriteria": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "A object that defines the criteria to determine whether Lambda should process an event\\. For more information, see [AWS Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) in the *AWS Lambda Developer Guide*\\. \n*Type*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`FilterCriteria`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "FilterCriteria"
},
"FunctionResponseTypes": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "A list of the response types currently applied to the event source mapping\\. For more information, see [Reporting batch item failures](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) in the *AWS Lambda Developer Guide*\\. \n*Valid values*: `ReportBatchItemFailures` \n*Type*: List \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`FunctionResponseTypes`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "FunctionResponseTypes"
},
"KmsKeyArn": {
"$ref": "#/definitions/PassThroughProp"
},
"MaximumBatchingWindowInSeconds": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The maximum amount of time to gather records before invoking the function, in seconds\\. \n*Type*: Integer \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`MaximumBatchingWindowInSeconds`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "MaximumBatchingWindowInSeconds"
},
"MaximumRecordAgeInSeconds": {
"allOf": [
{
"$ref": "#/definitions/PassThroughProp"
}
],
"markdownDescription": "The maximum age of a record that Lambda sends to a function for processing\\. \n*Type*: Integer \n*Required*: No \n*AWS CloudFormation compatibility*: This property is passed directly to the [`MaximumRecordAgeInSeconds`](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds) property of an `AWS::Lambda::EventSourceMapping` resource\\.",
"title": "MaximumRecordAgeInSeconds"
},
"MaximumRetryAttempts": {
"allOf": [
{