@mapbox/cloudfriend 5.1.2-SNAPSHOT-13 → 6.0.0-SNAPSHOT-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.nyc_output/520655c5-a674-40fe-935c-4cace7e4719f.json +1 -0
- package/.nyc_output/cfc820e0-b613-4675-b027-ca1a7c3c3d64.json +1 -0
- package/.nyc_output/processinfo/520655c5-a674-40fe-935c-4cace7e4719f.json +1 -0
- package/.nyc_output/processinfo/cfc820e0-b613-4675-b027-ca1a7c3c3d64.json +1 -0
- package/.nyc_output/processinfo/index.json +1 -0
- package/.python-version +1 -0
- package/.travis.yml +5 -2
- package/coverage/base.css +224 -0
- package/coverage/block-navigation.js +79 -0
- package/coverage/cloudfriend/bin/build-template.js.html +124 -0
- package/coverage/cloudfriend/bin/index.html +110 -0
- package/coverage/cloudfriend/index.html +110 -0
- package/coverage/cloudfriend/index.js.html +301 -0
- package/coverage/cloudfriend/lib/build.js.html +211 -0
- package/coverage/cloudfriend/lib/conditions.js.html +424 -0
- package/coverage/cloudfriend/lib/index.html +200 -0
- package/coverage/cloudfriend/lib/intrinsic.js.html +880 -0
- package/coverage/cloudfriend/lib/merge.js.html +472 -0
- package/coverage/cloudfriend/lib/pseudo.js.html +364 -0
- package/coverage/cloudfriend/lib/rules.js.html +343 -0
- package/coverage/cloudfriend/lib/shortcuts/cross-account-role.js.html +238 -0
- package/coverage/cloudfriend/lib/shortcuts/event-lambda.js.html +361 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-database.js.html +280 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-json-table.js.html +229 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-orc-table.js.html +220 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-parquet-table.js.html +262 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-presto-view.js.html +352 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-spark-view.js.html +235 -0
- package/coverage/cloudfriend/lib/shortcuts/glue-table.js.html +475 -0
- package/coverage/cloudfriend/lib/shortcuts/hookshot.js.html +1462 -0
- package/coverage/cloudfriend/lib/shortcuts/index.html +410 -0
- package/coverage/cloudfriend/lib/shortcuts/index.js.html +148 -0
- package/coverage/cloudfriend/lib/shortcuts/kinesis-firehose-base.js.html +412 -0
- package/coverage/cloudfriend/lib/shortcuts/lambda.js.html +799 -0
- package/coverage/cloudfriend/lib/shortcuts/log-subscription-lambda.js.html +304 -0
- package/coverage/cloudfriend/lib/shortcuts/queue-lambda.js.html +358 -0
- package/coverage/cloudfriend/lib/shortcuts/queue.js.html +613 -0
- package/coverage/cloudfriend/lib/shortcuts/role.js.html +376 -0
- package/coverage/cloudfriend/lib/shortcuts/s3-kinesis-firehose.js.html +562 -0
- package/coverage/cloudfriend/lib/shortcuts/scheduled-lambda.js.html +340 -0
- package/coverage/cloudfriend/lib/shortcuts/service-role.js.html +301 -0
- package/coverage/cloudfriend/lib/shortcuts/stream-lambda.js.html +373 -0
- package/coverage/cloudfriend/lib/validate.js.html +148 -0
- package/coverage/index.html +155 -0
- package/coverage/prettify.css +1 -0
- package/coverage/prettify.js +2 -0
- package/coverage/sort-arrow-sprite.png +0 -0
- package/coverage/sorter.js +170 -0
- package/lib/shortcuts/api.md +267 -245
- package/lib/shortcuts/hookshot.js +3 -3
- package/lib/shortcuts/lambda.js +2 -2
- package/package.json +5 -8
- package/test/fixtures/shortcuts/event-lambda-defaults.json +1 -1
- package/test/fixtures/shortcuts/event-lambda-full.json +1 -1
- package/test/fixtures/shortcuts/hookshot-github-secret-ref.json +5 -5
- package/test/fixtures/shortcuts/hookshot-github-secret-string.json +5 -5
- package/test/fixtures/shortcuts/hookshot-github.json +5 -5
- package/test/fixtures/shortcuts/hookshot-passthrough-access-log-format.json +6 -6
- package/test/fixtures/shortcuts/hookshot-passthrough-alarms.json +6 -6
- package/test/fixtures/shortcuts/hookshot-passthrough-enhanced-logging.json +6 -6
- package/test/fixtures/shortcuts/hookshot-passthrough-full-blown-logging.json +6 -6
- package/test/fixtures/shortcuts/hookshot-passthrough-logging.json +6 -6
- package/test/fixtures/shortcuts/hookshot-passthrough.json +6 -6
- package/test/fixtures/shortcuts/lambda-defaults.json +1 -1
- package/test/fixtures/shortcuts/lambda-docker.json +2 -2
- package/test/fixtures/shortcuts/lambda-full.json +1 -1
- package/test/fixtures/shortcuts/lambda-provided-role.json +1 -1
- package/test/fixtures/shortcuts/lambda-zipfile.json +1 -1
- package/test/fixtures/shortcuts/log-subscription-lambda-defaults.json +1 -1
- package/test/fixtures/shortcuts/log-subscription-lambda-no-defaults.json +1 -1
- package/test/fixtures/shortcuts/queue-lambda-zero.json +1 -1
- package/test/fixtures/shortcuts/queue-lambda.json +1 -1
- package/test/fixtures/shortcuts/scheduled-lambda-defaults.json +1 -1
- package/test/fixtures/shortcuts/scheduled-lambda-full.json +1 -1
- package/test/fixtures/shortcuts/stream-lambda-defaults.json +1 -1
- package/test/fixtures/shortcuts/stream-lambda-no-defaults.json +1 -1
- package/test/shortcuts.test.js +1 -1
package/lib/shortcuts/api.md
CHANGED
|
@@ -2,64 +2,64 @@
|
|
|
2
2
|
|
|
3
3
|
### Table of Contents
|
|
4
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
|
-
|
|
5
|
+
* [Lambda][1]
|
|
6
|
+
* [Parameters][2]
|
|
7
|
+
* [Examples][3]
|
|
8
|
+
* [ScheduledLambda][4]
|
|
9
|
+
* [Parameters][5]
|
|
10
|
+
* [Examples][6]
|
|
11
|
+
* [EventLambda][7]
|
|
12
|
+
* [Parameters][8]
|
|
13
|
+
* [Examples][9]
|
|
14
|
+
* [QueueLambda][10]
|
|
15
|
+
* [Parameters][11]
|
|
16
|
+
* [Examples][12]
|
|
17
|
+
* [StreamLambda][13]
|
|
18
|
+
* [Parameters][14]
|
|
19
|
+
* [Examples][15]
|
|
20
|
+
* [Role][16]
|
|
21
|
+
* [Parameters][17]
|
|
22
|
+
* [Examples][18]
|
|
23
|
+
* [CrossAccountRole][19]
|
|
24
|
+
* [Parameters][20]
|
|
25
|
+
* [Examples][21]
|
|
26
|
+
* [ServiceRole][22]
|
|
27
|
+
* [Parameters][23]
|
|
28
|
+
* [Examples][24]
|
|
29
|
+
* [Queue][25]
|
|
30
|
+
* [Parameters][26]
|
|
31
|
+
* [Examples][27]
|
|
32
|
+
* [S3KinesisFirehose][28]
|
|
33
|
+
* [Parameters][29]
|
|
34
|
+
* [Examples][30]
|
|
35
|
+
* [KinesisFirehoseBase][31]
|
|
36
|
+
* [Parameters][32]
|
|
37
|
+
* [GlueDatabase][33]
|
|
38
|
+
* [Parameters][34]
|
|
39
|
+
* [Examples][35]
|
|
40
|
+
* [GlueTable][36]
|
|
41
|
+
* [Parameters][37]
|
|
42
|
+
* [Examples][38]
|
|
43
|
+
* [GlueJsonTable][39]
|
|
44
|
+
* [Parameters][40]
|
|
45
|
+
* [GlueOrcTable][41]
|
|
46
|
+
* [Parameters][42]
|
|
47
|
+
* [GlueParquetTable][43]
|
|
48
|
+
* [Parameters][44]
|
|
49
|
+
* [GluePrestoView][45]
|
|
50
|
+
* [Parameters][46]
|
|
51
|
+
* [GlueSparkView][47]
|
|
52
|
+
* [Parameters][48]
|
|
53
|
+
* [hookshot.Passthrough][49]
|
|
54
|
+
* [Parameters][50]
|
|
55
|
+
* [Examples][51]
|
|
56
|
+
* [hookshot.Github][52]
|
|
57
|
+
* [Parameters][53]
|
|
58
|
+
* [Properties][54]
|
|
59
|
+
* [Examples][55]
|
|
60
|
+
* [LogSubscriptionLambda][56]
|
|
61
|
+
* [Parameters][57]
|
|
62
|
+
* [Examples][58]
|
|
63
63
|
|
|
64
64
|
## Lambda
|
|
65
65
|
|
|
@@ -68,45 +68,46 @@ Log Group, a Role, an Alarm on function errors, and the Lambda Function itself.
|
|
|
68
68
|
|
|
69
69
|
### Parameters
|
|
70
70
|
|
|
71
|
-
|
|
72
|
-
|
|
71
|
+
* `options` **[Object][59]** Options.
|
|
72
|
+
|
|
73
|
+
* `options.LogicalName` **[String][60]** The logical name of the Lambda function
|
|
73
74
|
within the CloudFormation template. This is used to construct the logical
|
|
74
75
|
names of the other resources, as well as the Lambda function's name.
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
76
|
+
* `options.Code` **[Object][59]** See [AWS documentation][61].
|
|
77
|
+
* `options.DeadLetterConfig` **[Object][59]** See [AWS documentation][62]. (optional, default `undefined`)
|
|
78
|
+
* `options.Description` **[String][60]** See [AWS documentation][63]. (optional, default `'${logical name} in the ${stack name} stack'`)
|
|
79
|
+
* `options.Environment` **[Object][59]** See [AWS documentation][64]. (optional, default `undefined`)
|
|
80
|
+
* `options.FunctionName` **[String][60]** See [AWS documentation][65]. (optional, default `'${stack name}-${logical name}'`)
|
|
81
|
+
* `options.Handler` **[String][60]** See [AWS documentation][66]. (optional, default `'index.handler'`)
|
|
82
|
+
* `options.KmsKeyArn` **[String][60]** See [AWS documentation][67]. (optional, default `undefined`)
|
|
83
|
+
* `options.Layers` **[Array][68]<[String][60]>** See [AWS documentation][69]. (optional, default `undefined`)
|
|
84
|
+
* `options.MemorySize` **[Number][70]** See [AWS documentation][71]. (optional, default `128`)
|
|
85
|
+
* `options.ReservedConcurrentExecutions` **[Number][70]** See [AWS documentation][72]. (optional, default `undefined`)
|
|
86
|
+
* `options.Runtime` **[String][60]** See [AWS documentation][73]. (optional, default `'nodejs16.x'`)
|
|
87
|
+
* `options.Tags` **[Array][68]<[Object][59]>** See [AWS documentation][74]. (optional, default `undefined`)
|
|
88
|
+
* `options.Timeout` **[Number][70]** See [AWS documentation][75]. (optional, default `300`)
|
|
89
|
+
* `options.TracingConfig` **[Object][59]** See [AWS documentation][76]. (optional, default `undefined`)
|
|
90
|
+
* `options.VpcConfig` **[Object][59]** See [AWS documentation][77]. (optional, default `undefined`)
|
|
91
|
+
* `options.Condition` **[String][60]** If there is a `Condition` defined in the template
|
|
91
92
|
that should control whether to create this Lambda function, specify
|
|
92
93
|
the name of the condition here. See [AWS documentation][78]. (optional, default `undefined`)
|
|
93
|
-
|
|
94
|
+
* `options.DependsOn` **[String][60]** Specify a stack resource dependency
|
|
94
95
|
to this Lambda function. See [AWS documentation][79]. (optional, default `undefined`)
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
96
|
+
* `options.Statement` **[Array][68]<[Object][59]>** Policy statements that will be added to a generated IAM role defining the permissions your Lambda function needs to run. *Do not use this option when specifying your own role via RoleArn.* (optional, default `[]`)
|
|
97
|
+
* `options.RoleArn` **[String][60]** If specified, the Lambda function will use this role instead of creating a new role. *If this option is specified, do not use the Statement option; add the permissions you need to your Role directly.* (optional, default `undefined`)
|
|
98
|
+
* `options.AlarmName` **[String][60]** See [AWS documentation][80]. (optional, default `'${stack name}-${logical name}-Errors-${region}'`)
|
|
99
|
+
* `options.AlarmDescription` **[String][60]** See [AWS documentation][81]. (optional, default `'Error alarm for ${stack name}-${logical name} lambda function in ${stack name} stack'`)
|
|
100
|
+
* `options.AlarmActions` **[Array][68]<[String][60]>** See [AWS documentation][82]. (optional, default `[]`)
|
|
101
|
+
* `options.Period` **[Number][70]** See [AWS documentation][83]. (optional, default `60`)
|
|
102
|
+
* `options.EvaluationPeriods` **[Number][70]** See [AWS documentation][84]. (optional, default `1`)
|
|
103
|
+
* `options.Statistic` **[String][60]** See [AWS documentation][85]. (optional, default `'Sum'`)
|
|
104
|
+
* `options.DatapointsToAlarm` **[Number][70]** See [AWS documentation][86]. (optional, default `1`)
|
|
105
|
+
* `options.Threshold` **[Number][70]** See [AWS documentation][87]. (optional, default `0`)
|
|
106
|
+
* `options.ComparisonOperator` **[String][60]** See [AWS documentation][88]. (optional, default `'GreaterThanThreshold'`)
|
|
107
|
+
* `options.TreatMissingData` **[String][60]** See [AWS documentation][89]. (optional, default `'notBreaching'`)
|
|
108
|
+
* `options.EvaluateLowSampleCountPercentile` **[String][60]** See [AWS documentation][90]. (optional, default `undefined`)
|
|
109
|
+
* `options.ExtendedStatistic` **[String][60]** See [AWS documentation][91]] (optional, default `undefined`)
|
|
110
|
+
* `options.OKActions` **[Array][68]<[String][60]>** See [AWS documentation][92]. (optional, default `undefined`)
|
|
110
111
|
|
|
111
112
|
### Examples
|
|
112
113
|
|
|
@@ -136,9 +137,10 @@ a Lambda permission.
|
|
|
136
137
|
|
|
137
138
|
### Parameters
|
|
138
139
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
140
|
+
* `options` **[Object][59]** Extends the options for [`Lambda`][1] with the following additional attributes:
|
|
141
|
+
|
|
142
|
+
* `options.ScheduleExpression` **[String][60]** See [AWS documentation][93].
|
|
143
|
+
* `options.State` **[String][60]** See [AWS documentation][94]. (optional, default `'ENABLED'`)
|
|
142
144
|
|
|
143
145
|
### Examples
|
|
144
146
|
|
|
@@ -169,10 +171,11 @@ a Lambda permission.
|
|
|
169
171
|
|
|
170
172
|
### Parameters
|
|
171
173
|
|
|
172
|
-
|
|
174
|
+
* `options` **[Object][59]** Extends the options for [`Lambda`][1]
|
|
173
175
|
with the following additional attributes:
|
|
174
|
-
|
|
175
|
-
|
|
176
|
+
|
|
177
|
+
* `options.EventPattern` **[String][60]** See [AWS documentation][95].
|
|
178
|
+
* `options.State` **[String][60]** See [AWS documentation][94]. (optional, default `'ENABLED'`)
|
|
176
179
|
|
|
177
180
|
### Examples
|
|
178
181
|
|
|
@@ -209,10 +212,11 @@ mapping.
|
|
|
209
212
|
|
|
210
213
|
### Parameters
|
|
211
214
|
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
215
|
+
* `options` **[Object][59]** Extends the options for [`Lambda`][1] with the following additional attributes:
|
|
216
|
+
|
|
217
|
+
* `options.EventSourceArn` **[String][60]** See [AWS documentation][96].
|
|
218
|
+
* `options.ReservedConcurrentExecutions` **[Number][70]** See [AWS documentation][72].
|
|
219
|
+
* `options.BatchSize` **[Number][70]** See [AWS documentation][97]. (optional, default `1`)
|
|
216
220
|
|
|
217
221
|
### Examples
|
|
218
222
|
|
|
@@ -244,12 +248,13 @@ source mapping.
|
|
|
244
248
|
|
|
245
249
|
### Parameters
|
|
246
250
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
251
|
+
* `options` **[Object][59]** Extends the options for [`Lambda`][1] with the following additional attributes:
|
|
252
|
+
|
|
253
|
+
* `options.EventSourceArn` **[String][60]** See [AWS documentation][96].
|
|
254
|
+
* `options.BatchSize` **[Number][70]** See [AWS documentation][97]. (optional, default `1`)
|
|
255
|
+
* `options.MaximumBatchingWindowInSeconds` **[Number][70]** See [AWS documentation][98]. (optional, default `undefined`)
|
|
256
|
+
* `options.Enabled` **[Boolean][99]** See [AWS documentation][100]. (optional, default `true`)
|
|
257
|
+
* `options.StartingPosition` **[String][60]** See [AWS documentation][101]. (optional, default `'LATEST'`)
|
|
253
258
|
|
|
254
259
|
### Examples
|
|
255
260
|
|
|
@@ -276,23 +281,24 @@ Create an IAM role.
|
|
|
276
281
|
|
|
277
282
|
### Parameters
|
|
278
283
|
|
|
279
|
-
|
|
280
|
-
|
|
284
|
+
* `options` **[Object][59]** Options.
|
|
285
|
+
|
|
286
|
+
* `options.LogicalName` **[String][60]** The logical name of the IAM role
|
|
281
287
|
within the CloudFormation template.
|
|
282
|
-
|
|
288
|
+
* `options.AssumeRolePrincipals` **[Array][68]<[Object][59]>** An array of [principal objects][102]
|
|
283
289
|
defining entities able to assume this role. Will be included in the role's
|
|
284
290
|
[`AssumeRolePolicyDocument`][103].
|
|
285
|
-
|
|
291
|
+
* `options.Statement` **[Array][68]<[Object][59]>** An array of permissions statements
|
|
286
292
|
to be included in the [`PolicyDocument`][104]. (optional, default `[]`)
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
+
* `options.ManagedPolicyArns` **[Array][68]<[String][60]>** See [AWS documentation][105]. (optional, default `undefined`)
|
|
294
|
+
* `options.MaxSessionDuration` **[Number][70]** See [AWS documentation][106]. (optional, default `undefined`)
|
|
295
|
+
* `options.Path` **[String][60]** See [AWS documentation][107]. (optional, default `undefined`)
|
|
296
|
+
* `options.RoleName` **[String][60]** See [AWS documentation][108]. (optional, default `undefined`)
|
|
297
|
+
* `options.Tags` **[Array][68]<[Object][59]>** See [AWS documentation][109]. (optional, default `undefined`)
|
|
298
|
+
* `options.Condition` **[String][60]** -If there is a `Condition` defined
|
|
293
299
|
in the template that should control whether to create this IAM role,
|
|
294
300
|
specify the name of the condition here. See [AWS documentation][78]. (optional, default `undefined`)
|
|
295
|
-
|
|
301
|
+
* `options.DependsOn` **[String][60]** Specify a stack resource dependency
|
|
296
302
|
to this IAM role. See [AWS documentation][79]. (optional, default `undefined`)
|
|
297
303
|
|
|
298
304
|
### Examples
|
|
@@ -327,11 +333,12 @@ Create an IAM role that will be assumed from another AWS Account.
|
|
|
327
333
|
|
|
328
334
|
### Parameters
|
|
329
335
|
|
|
330
|
-
|
|
336
|
+
* `options` **[Object][59]** Extends
|
|
331
337
|
the options for [`Role`][16]. You do not need to provide
|
|
332
338
|
an `AssumeRolePrincipals` attribute, but do need to include the following
|
|
333
339
|
additional attributes:
|
|
334
|
-
|
|
340
|
+
|
|
341
|
+
* `options.Accounts` **[Array][68]<([String][60] | [Object][59])>** An array of accounts that can
|
|
335
342
|
assume this IAM Role. These could be account IDs (`123456789012`),
|
|
336
343
|
account ARNs (`arn:aws:iam::123456789012:root`), or CloudFormation intrinsic
|
|
337
344
|
function objects (`cf.sub('arn:aws:iam::${AccountIdParameter}:root')`).
|
|
@@ -366,11 +373,12 @@ Create an IAM role that will be assumed by an AWS service, e.g. Lambda or ECS.
|
|
|
366
373
|
|
|
367
374
|
### Parameters
|
|
368
375
|
|
|
369
|
-
|
|
376
|
+
* `options` **[Object][59]** Extends
|
|
370
377
|
the options for [`Role`][16]. You do not need to provide
|
|
371
378
|
an `AssumeRolePrincipals` attribute, but do need to include the following
|
|
372
379
|
additional attributes:
|
|
373
|
-
|
|
380
|
+
|
|
381
|
+
* `options.Service` **[String][60]** The name of the AWS service that will assume this role, e.g. `lambda`.
|
|
374
382
|
|
|
375
383
|
### Examples
|
|
376
384
|
|
|
@@ -406,34 +414,35 @@ and `ExistingTopicArn` is ignored.
|
|
|
406
414
|
|
|
407
415
|
### Parameters
|
|
408
416
|
|
|
409
|
-
|
|
410
|
-
|
|
417
|
+
* `options` **[Object][59]** Options.
|
|
418
|
+
|
|
419
|
+
* `options.LogicalName` **[String][60]** The logical name of the SQS queue
|
|
411
420
|
within the CloudFormation template. This is also used to construct the logical
|
|
412
421
|
names of the other resources.
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
422
|
+
* `options.VisibilityTimeout` **[Number][70]** See [AWS documentation][110]. (optional, default `300`)
|
|
423
|
+
* `options.maxReceiveCount` **[Number][70]** See [AWS documentation][111]. (optional, default `10`)
|
|
424
|
+
* `options.ContentBasedDeduplication` **[Boolean][99]** See [AWS documentation][112]. (optional, default `undefined`)
|
|
425
|
+
* `options.DelaySeconds` **[Number][70]** See [AWS documentation][113]. (optional, default `undefined`)
|
|
426
|
+
* `options.FifoQueue` **[Boolean][99]** See [AWS documentation][114]. (optional, default `undefined`)
|
|
427
|
+
* `options.KmsMasterKeyId` **[String][60]** See [AWS documentation][115]. (optional, default `undefined`)
|
|
428
|
+
* `options.KmsDataKeyReusePeriodSeconds` **[Number][70]** See [AWS documentation][116]. (optional, default `undefined`)
|
|
429
|
+
* `options.MaximumMessageSize` **[Number][70]** See [AWS documentation][117]. (optional, default `undefined`)
|
|
430
|
+
* `options.MessageRetentionPeriod` **[Number][70]** See [AWS documentation][118]. (optional, default `1209600`)
|
|
431
|
+
* `options.QueueName` **[String][60]** See [AWS documentation][119].
|
|
423
432
|
If `FifoQueue` is `true`, the suffix `.fifo` will be added to the queue name. (optional, default `'${stack name}-${logical name}'`)
|
|
424
|
-
|
|
425
|
-
|
|
433
|
+
* `options.ReceiveMessageWaitTimeSeconds` **[Number][70]** See [AWS documentation][120]. (optional, default `undefined`)
|
|
434
|
+
* `options.Condition` **[String][60]** If there is a `Condition` defined
|
|
426
435
|
in the template that should control whether to create this SQS queue,
|
|
427
436
|
specify the name of the condition here. See [AWS documentation][78]. (optional, default `undefined`)
|
|
428
|
-
|
|
437
|
+
* `options.DependsOn` **[String][60]** Specify a stack resource dependency
|
|
429
438
|
to this SQS queue. See [AWS documentation][79]. (optional, default `undefined`)
|
|
430
|
-
|
|
439
|
+
* `options.ExistingTopicArn` **[String][60]?** Specify an SNS topic ARN to subscribe the queue to.
|
|
431
440
|
If this option is provided, `TopicName` is irrelevant because no new topic is created.
|
|
432
441
|
This option is ignored if `FifoQueue: true`, because FIFO queues cannot subscribe to SNS topics.
|
|
433
|
-
|
|
442
|
+
* `options.TopicName` **[String][60]** See [AWS documentation][121].
|
|
434
443
|
This option is ignored if `FifoQueue: true`, because FIFO queues cannot subscribe to SNS topics. (optional, default `'${stack name}-${logical name}'`)
|
|
435
|
-
|
|
436
|
-
|
|
444
|
+
* `options.DisplayName` **[String][60]** See [AWS documentation][122]. (optional, default `undefined`)
|
|
445
|
+
* `options.DeadLetterVisibilityTimeout` **[Number][70]** [VisibilityTimeout][110] for the dead-letter queue. (optional, default `300`)
|
|
437
446
|
|
|
438
447
|
### Examples
|
|
439
448
|
|
|
@@ -463,27 +472,28 @@ alarm is triggered.
|
|
|
463
472
|
|
|
464
473
|
### Parameters
|
|
465
474
|
|
|
466
|
-
|
|
467
|
-
|
|
475
|
+
* `options` **[Object][59]** Options.
|
|
476
|
+
|
|
477
|
+
* `options.LogicalName` **[String][60]** The logical name of the Kinesis Firehouse delivery stream
|
|
468
478
|
within the CloudFormation template. This is also used to construct the logical
|
|
469
479
|
names of the other resources.
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
480
|
+
* `options.DestinationBucket` **[String][60]** The name of the S3 bucket to write to.
|
|
481
|
+
* `options.Prefix` **[String][60]** The prefix path (folder) within the DestinationBucket to write to. (optional, default `'raw/${logical name}/'`)
|
|
482
|
+
* `options.KinesisStreamARN` **([String][60] | [Object][59])** The ARN of a source Kinesis Stream. (optional, default `undefined`)
|
|
483
|
+
* `options.BufferingIntervalInSeconds` **[Number][70]** See [AWS documentation][123]. (optional, default `900`)
|
|
484
|
+
* `options.BufferingSizeInMBs` **[Number][70]** See [AWS documentation][124]. (optional, default `128`)
|
|
485
|
+
* `options.AlarmName` **[String][60]** See [AWS documentation][80]. (optional, default `'${stack name}-${logical name}-Freshness-${region}'`)
|
|
486
|
+
* `options.AlarmDescription` **[String][60]** See [AWS documentation][81]. (optional, default `'Freshness alarm for ${stack name}-${logical name} kinesis firehose in ${stack name} stack'`)
|
|
487
|
+
* `options.AlarmActions` **[Array][68]<[String][60]>** See [AWS documentation][82]. (optional, default `[]`)
|
|
488
|
+
* `options.Period` **[Number][70]** See [AWS documentation][83]. (optional, default `60`)
|
|
489
|
+
* `options.EvaluationPeriods` **[Number][70]** See [AWS documentation][84]. (optional, default `1`)
|
|
490
|
+
* `options.Statistic` **[String][60]** See [AWS documentation][85]. (optional, default `'Maximum'`)
|
|
491
|
+
* `options.Threshold` **[Number][70]** See [AWS documentation][87]. (optional, default `(BufferingIntervalInSeconds*2)`)
|
|
492
|
+
* `options.ComparisonOperator` **[String][60]** See [AWS documentation][88]. (optional, default `'GreaterThanThreshold'`)
|
|
493
|
+
* `options.TreatMissingData` **[String][60]** See [AWS documentation][89]. (optional, default `'notBreaching'`)
|
|
494
|
+
* `options.EvaluateLowSampleCountPercentile` **[String][60]** See [AWS documentation][90]. (optional, default `undefined`)
|
|
495
|
+
* `options.ExtendedStatistic` **[String][60]** See [AWS documentation][91]] (optional, default `undefined`)
|
|
496
|
+
* `options.OKActions` **[Array][68]<[String][60]>** See [AWS documentation][92]. (optional, default `undefined`)
|
|
487
497
|
|
|
488
498
|
### Examples
|
|
489
499
|
|
|
@@ -510,11 +520,12 @@ a policy allowing records to be delivered to the delivery stream.
|
|
|
510
520
|
|
|
511
521
|
### Parameters
|
|
512
522
|
|
|
513
|
-
|
|
514
|
-
|
|
523
|
+
* `options` **[Object][59]** Options.
|
|
524
|
+
|
|
525
|
+
* `options.LogicalName` **[String][60]** The logical name of the Kinesis Firehouse delivery stream
|
|
515
526
|
within the CloudFormation template. This is also used to construct the logical
|
|
516
527
|
names of the other resources.
|
|
517
|
-
|
|
528
|
+
* `options.KinesisStreamARN` **([String][60] | [Object][59])** The ARN of a source Kinesis Stream. (optional, default `undefined`)
|
|
518
529
|
|
|
519
530
|
## GlueDatabase
|
|
520
531
|
|
|
@@ -522,17 +533,18 @@ Create a Glue Database.
|
|
|
522
533
|
|
|
523
534
|
### Parameters
|
|
524
535
|
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
536
|
+
* `options` **[Object][59]** Options.
|
|
537
|
+
|
|
538
|
+
* `options.LogicalName` **[String][60]** The logical name of the Glue Database within the CloudFormation template.
|
|
539
|
+
* `options.Name` **[String][60]** The name of the database. See [AWS documentation][125].
|
|
540
|
+
* `options.CatalogId` **[String][60]** The AWS account ID for the account in which to create the database. See [AWS documentation][126]. (optional, default `AccountId`)
|
|
541
|
+
* `options.Description` **[String][60]** The description of the database. See [AWS documentation][127]. (optional, default `'Created by the ${AWS::StackName} CloudFormation stack'`)
|
|
542
|
+
* `options.LocationUri` **[String][60]** The location of the database. See [AWS documentation][128]. (optional, default `undefined`)
|
|
543
|
+
* `options.Parameters` **[String][60]** Parameters of the database. See [AWS documentation][129]. (optional, default `undefined`)
|
|
544
|
+
* `options.Condition` **[String][60]** If there is a `Condition` defined
|
|
533
545
|
in the template that should control whether to create this database,
|
|
534
546
|
specify the name of the condition here. See [AWS documentation][78]. (optional, default `undefined`)
|
|
535
|
-
|
|
547
|
+
* `options.DependsOn` **[String][60]** Specify a stack resource dependency
|
|
536
548
|
to this database. See [AWS documentation][79]. (optional, default `undefined`)
|
|
537
549
|
|
|
538
550
|
### Examples
|
|
@@ -556,41 +568,42 @@ Create a Glue Table.
|
|
|
556
568
|
|
|
557
569
|
Pre-configured versions of this shortcut are available for tables stored as line-delimited JSON or ORC:
|
|
558
570
|
|
|
559
|
-
|
|
560
|
-
|
|
571
|
+
* [GlueJsonTable][39]
|
|
572
|
+
* [GlueOrcTable][41]
|
|
561
573
|
|
|
562
574
|
### Parameters
|
|
563
575
|
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
576
|
+
* `options` **[Object][59]** Options.
|
|
577
|
+
|
|
578
|
+
* `options.LogicalName` **[String][60]** The logical name of the Glue Table within the CloudFormation template.
|
|
579
|
+
* `options.Name` **[String][60]** The name of the table. See [AWS documentation][130].
|
|
580
|
+
* `options.DatabaseName` **[String][60]** The name of the database the table
|
|
568
581
|
resides in. See [AWS documentation][131].
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
582
|
+
* `options.Columns` **[Array][68]<[Object][59]>** List of the table's columns. See [AWS documentation][132].
|
|
583
|
+
* `options.CatalogId` **[String][60]** The AWS account ID for the account in which to create the table. See [AWS documentation][133]. (optional, default `AccountId`)
|
|
584
|
+
* `options.Owner` **[String][60]** The table owner. See [AWS documentation][134]. (optional, default `undefined`)
|
|
585
|
+
* `options.Parameters` **[Object][59]** Table parameters. See [AWS documentation][135]. (optional, default `undefined`)
|
|
586
|
+
* `options.PartitionKeys` **[Array][68]<[String][60]>** List of partitioning columns. See [AWS documentation][136]. (optional, default `[]`)
|
|
587
|
+
* `options.Description` **[String][60]** The description of the table. See [AWS documentation][137]. (optional, default `'Created by the ${AWS::StackName} CloudFormation stack'`)
|
|
588
|
+
* `options.Retention` **[Number][70]** Retention time for the table. See [AWS documentation][138]. (optional, default `undefined`)
|
|
589
|
+
* `options.TableType` **[String][60]** The type of this table. See [AWS documentation][139]. (optional, default `undefined`)
|
|
590
|
+
* `options.ViewExpandedText` **[String][60]** The expanded text of the view. See [AWS documentation][140]. (optional, default `undefined`)
|
|
591
|
+
* `options.ViewOriginalText` **[String][60]** The original text of the view. See [AWS documentation][141]. (optional, default `undefined`)
|
|
592
|
+
* `options.BucketColumns` **[Array][68]<[String][60]>** List of bucketing columns. See [AWS documentation][142]. (optional, default `undefined`)
|
|
593
|
+
* `options.Compressed` **[Boolean][99]** Whether the data is compressed. See [AWS documentation][143]. (optional, default `false`)
|
|
594
|
+
* `options.InputFormat` **[String][60]** The table's input format. See [AWS documentation][144]. (optional, default `undefined`)
|
|
595
|
+
* `options.Location` **[String][60]** The physical location of the table. See [AWS documentation][145]. (optional, default `''`)
|
|
596
|
+
* `options.NumberOfBuckets` **[Number][70]** See [AWS documentation][146]. (optional, default `0`)
|
|
597
|
+
* `options.OutputFormat` **[String][60]** The table's output format. See [AWS documentation][147]. (optional, default `undefined`)
|
|
598
|
+
* `options.StorageParameters` **[Object][59]** Storage parameters. See [AWS documentation][148]. (optional, default `undefined`)
|
|
599
|
+
* `options.SerdeInfo` **[Object][59]** The serialization/deserialization information. See [AWS documentation][149]. (optional, default `{}`)
|
|
600
|
+
* `options.SkewedInfo` **[Object][59]** Frequent value information. See [AWS documentation][150]. (optional, default `undefined`)
|
|
601
|
+
* `options.SortColumns` **[Array][68]<[Object][59]>** List specifying the sort order. See [AWS documentation][151]. (optional, default `undefined`)
|
|
602
|
+
* `options.StoredAsSubDirectories` **[Boolean][99]** See [AWS documentation][152]. (optional, default `true`)
|
|
603
|
+
* `options.Condition` **[String][60]** If there is a `Condition` defined
|
|
591
604
|
in the template that should control whether to create this database,
|
|
592
605
|
specify the name of the condition here. See [AWS documentation][78]. (optional, default `undefined`)
|
|
593
|
-
|
|
606
|
+
* `options.DependsOn` **[String][60]** Specify a stack resource dependency
|
|
594
607
|
to this database. See [AWS documentation][79]. (optional, default `undefined`)
|
|
595
608
|
|
|
596
609
|
### Examples
|
|
@@ -620,13 +633,15 @@ Create a Glue Table backed by line-delimited JSON files on S3.
|
|
|
620
633
|
|
|
621
634
|
### Parameters
|
|
622
635
|
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
636
|
+
* `options` **[Object][59]** Accepts the same options as [`GlueTable`][36], though the following additional attributes are either required or hard-wired:
|
|
637
|
+
|
|
638
|
+
* `options.Location` **[String][60]** The physical location of the table. See [AWS documentation][145].
|
|
639
|
+
* `options.TableType` **[String][60]** Hard-wired by this shortcut. (optional, default `'EXTERNAL_TABLE'`)
|
|
640
|
+
* `options.InputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.mapred.TextInputFormat'`)
|
|
641
|
+
* `options.OutputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat'`)
|
|
642
|
+
* `options.SerdeInfo` **[Object][59]?** Hard-wired by this shortcut.
|
|
643
|
+
|
|
644
|
+
* `options.SerdeInfo.SerializationLibrary` **[Object][59]** Hard-wired by this shortcut. (optional, default `'org.openx.data.jsonserde.JsonSerDe'`)
|
|
630
645
|
|
|
631
646
|
## GlueOrcTable
|
|
632
647
|
|
|
@@ -636,13 +651,15 @@ Create a Glue Table backed by ORC files on S3.
|
|
|
636
651
|
|
|
637
652
|
### Parameters
|
|
638
653
|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
654
|
+
* `options` **[Object][59]** Accepts the same options as [`GlueTable`][36], though the following additional attributes are either required or hard-wired:
|
|
655
|
+
|
|
656
|
+
* `options.Location` **[String][60]** The physical location of the table. See [AWS documentation][145].
|
|
657
|
+
* `options.TableType` **[String][60]** Hard-wired by this shortcut. (optional, default `'EXTERNAL_TABLE'`)
|
|
658
|
+
* `options.InputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.orc.OrcInputFormat'`)
|
|
659
|
+
* `options.OutputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat'`)
|
|
660
|
+
* `options.SerdeInfo` **[Object][59]?** Hard-wired by this shortcut.
|
|
661
|
+
|
|
662
|
+
* `options.SerdeInfo.SerializationLibrary` **[Object][59]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.orc.OrcSerde'`)
|
|
646
663
|
|
|
647
664
|
## GlueParquetTable
|
|
648
665
|
|
|
@@ -652,18 +669,20 @@ Create a Glue table backed by Parquet files on S3.
|
|
|
652
669
|
|
|
653
670
|
### Parameters
|
|
654
671
|
|
|
655
|
-
|
|
672
|
+
* `options` **[Object][59]** Accepts the same options as cloudfriend's
|
|
656
673
|
[`GlueTable`][153],
|
|
657
674
|
though the following additional attributes are either required or hard-wired:
|
|
658
|
-
|
|
675
|
+
|
|
676
|
+
* `options.Location` **[String][60]** The physical location of the table. See
|
|
659
677
|
[AWS
|
|
660
678
|
documentation][145].
|
|
661
|
-
|
|
679
|
+
* `options.TableType` **[String][60]** Hard-wired by this
|
|
662
680
|
shortcut. (optional, default `'EXTERNAL_TABLE'`)
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
681
|
+
* `options.InputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat'`)
|
|
682
|
+
* `options.OutputFormat` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat'`)
|
|
683
|
+
* `options.SerdeInfo` **[Object][59]?** Hard-wired by this shortcut.
|
|
684
|
+
|
|
685
|
+
* `options.SerdeInfo.SerializationLibrary` **[String][60]** Hard-wired by this shortcut. (optional, default `'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe'`)
|
|
667
686
|
|
|
668
687
|
## GluePrestoView
|
|
669
688
|
|
|
@@ -673,9 +692,10 @@ Create a Glue Presto View.
|
|
|
673
692
|
|
|
674
693
|
### Parameters
|
|
675
694
|
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
695
|
+
* `options` **[Object][59]** Accepts the same options as [`GlueTable`][36], though the following additional attributes are either required or hard-wired:
|
|
696
|
+
|
|
697
|
+
* `options.OriginalSql` **[String][60]** The SQL query that defines the view.
|
|
698
|
+
* `options.TableType` **[String][60]** Hard-wired by this shortcut. (optional, default `'VIRTUAL_VIEW'`)
|
|
679
699
|
|
|
680
700
|
## GlueSparkView
|
|
681
701
|
|
|
@@ -685,9 +705,10 @@ Create a Glue Presto View.
|
|
|
685
705
|
|
|
686
706
|
### Parameters
|
|
687
707
|
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
708
|
+
* `options` **[Object][59]** Accepts the same options as [`GlueTable`][36], though the following additional attributes are either required or hard-wired:
|
|
709
|
+
|
|
710
|
+
* `options.OriginalSql` **[String][60]** The SQL query that defines the view.
|
|
711
|
+
* `options.TableType` **[String][60]** Hard-wired by this shortcut. (optional, default `'VIRTUAL_VIEW'`)
|
|
691
712
|
|
|
692
713
|
## hookshot.Passthrough
|
|
693
714
|
|
|
@@ -719,20 +740,20 @@ and a random string that can be used as a shared secret.
|
|
|
719
740
|
|
|
720
741
|
### Parameters
|
|
721
742
|
|
|
722
|
-
|
|
743
|
+
* `Prefix` **[String][60]** This will be used to prefix the set of CloudFormation
|
|
723
744
|
resources created by this shortcut.
|
|
724
|
-
|
|
745
|
+
* `PassthroughTo` **[String][60]** The logical name of the Lambda function that you
|
|
725
746
|
have written which will receive a request and generate a response to provide
|
|
726
747
|
to the caller.
|
|
727
|
-
|
|
748
|
+
* `LoggingLevel` **[String][60]** One of `OFF`, `INFO`, or `ERROR`. Logs are delivered
|
|
728
749
|
to a CloudWatch Log Group named `API-Gateway-Execution-Logs_{rest-api-id}/hookshot`. (optional, default `'OFF'`)
|
|
729
|
-
|
|
750
|
+
* `DataTraceEnabled` **[Boolean][99]** Set to `true` to enable full request/response
|
|
730
751
|
logging in the API's logs. (optional, default `false`)
|
|
731
|
-
|
|
732
|
-
|
|
752
|
+
* `MetricsEnabled` **[Boolean][99]** Set to `true` to enable additional metrics in CloudWatch. (optional, default `false`)
|
|
753
|
+
* `AccessLogFormat` **[String][60]?** A single line format of the access logs of
|
|
733
754
|
data, as specified by selected `$context` variables. The format must include at
|
|
734
755
|
least `$context.requestId`. [See AWS documentation for details][156].
|
|
735
|
-
|
|
756
|
+
* `WebhookSecret` **([String][60] | [Object][59])?** A secret string to be used to verify
|
|
736
757
|
payload signatures that are delivered to the endpoint. This is optional. If
|
|
737
758
|
not specified, a string will be generated for you. Implementation of
|
|
738
759
|
signature verification is up to the caller.
|
|
@@ -773,14 +794,14 @@ Lambda function.
|
|
|
773
794
|
|
|
774
795
|
### Parameters
|
|
775
796
|
|
|
776
|
-
|
|
797
|
+
* `Prefix` **[String][60]** this will be used to prefix the set of CloudFormation
|
|
777
798
|
resources created by this shortcut.
|
|
778
|
-
|
|
799
|
+
* `PassthroughTo` **[String][60]** the logical name of the Lambda function that you
|
|
779
800
|
have written which will receive a request and generate a response to provide
|
|
780
801
|
to the caller.
|
|
781
|
-
|
|
802
|
+
* `LoggingLevel` **[String][60]** one of `OFF`, `INFO`, or `ERROR`. Logs are delivered
|
|
782
803
|
to a CloudWatch LogGroup named `API-Gateway-Execution-Logs_{rest-api-id}/hookshot`
|
|
783
|
-
|
|
804
|
+
* `WebhookSecret` **([String][60] | [Object][59])?** A secret string to be used to verify
|
|
784
805
|
payload signatures that are delivered to the endpoint. This is optional. If
|
|
785
806
|
not specified, a string will be generated for you. You should provide this
|
|
786
807
|
value to GitHub, and signature verification will be performed before your
|
|
@@ -788,8 +809,8 @@ Lambda function.
|
|
|
788
809
|
|
|
789
810
|
### Properties
|
|
790
811
|
|
|
791
|
-
|
|
792
|
-
|
|
812
|
+
* `Resources` **[Object][59]** the CloudFormation resources created by this shortcut.
|
|
813
|
+
* `Outputs` **[Object][59]** the CloudFormation outputs created by this
|
|
793
814
|
shortcut. This includes the URL for the API Gateway endpoint, and a secret
|
|
794
815
|
string. Use these two values to configure GitHub to send webhooks to your
|
|
795
816
|
API Gateway endpoint.
|
|
@@ -827,9 +848,10 @@ and a Lambda permission.
|
|
|
827
848
|
|
|
828
849
|
### Parameters
|
|
829
850
|
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
851
|
+
* `options` **[Object][59]** Extends the options for [`Lambda`][1] with the following additional attributes:
|
|
852
|
+
|
|
853
|
+
* `options.LogGroupName` **[String][60]** See [AWS documentation][157].
|
|
854
|
+
* `options.FilterPattern` **[String][60]** See [AWS documentation][158]. (optional, default `''`)
|
|
833
855
|
|
|
834
856
|
### Examples
|
|
835
857
|
|