cdk-serverless 2.14.6 → 2.15.0
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/docs/constructs/assets/hierarchy.js +1 -0
- package/docs/constructs/assets/icons.js +18 -0
- package/docs/constructs/assets/icons.svg +1 -0
- package/docs/constructs/assets/main.js +5 -3
- package/docs/constructs/assets/navigation.js +1 -0
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +1424 -1193
- package/docs/constructs/classes/AssetCdn.html +21 -187
- package/docs/constructs/classes/BaseApi.html +15 -177
- package/docs/constructs/classes/CognitoAuthentication.html +26 -223
- package/docs/constructs/classes/GraphQlApi.html +37 -516
- package/docs/constructs/classes/LambdaFunction.html +213 -1159
- package/docs/constructs/classes/RestApi.html +43 -397
- package/docs/constructs/classes/SingleTableDatastore.html +20 -174
- package/docs/constructs/classes/Workflow.html +24 -195
- package/docs/constructs/hierarchy.html +1 -0
- package/docs/constructs/index.html +34 -110
- package/docs/constructs/interfaces/AssetCdnProps.html +6 -99
- package/docs/constructs/interfaces/BaseApiProps.html +45 -202
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +40 -188
- package/docs/constructs/interfaces/GraphQlApiProps.html +46 -218
- package/docs/constructs/interfaces/ICognitoAuthentication.html +3 -91
- package/docs/constructs/interfaces/IJwtAuthentication.html +7 -103
- package/docs/constructs/interfaces/JsResolverOptions.html +11 -106
- package/docs/constructs/interfaces/LambdaFunctionProps.html +35 -202
- package/docs/constructs/interfaces/LambdaTracingOptions.html +6 -90
- package/docs/constructs/interfaces/RestApiProps.html +62 -261
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +12 -111
- package/docs/constructs/interfaces/SingleTableDesign.html +12 -121
- package/docs/constructs/interfaces/VtlResolverOptions.html +8 -103
- package/docs/constructs/interfaces/WorkflowProps.html +6 -109
- package/docs/constructs/modules.html +1 -93
- package/docs/constructs/types/LambdaOptions.html +1 -62
- package/docs/lambda/assets/hierarchy.js +1 -0
- package/docs/lambda/assets/icons.js +18 -0
- package/docs/lambda/assets/icons.svg +1 -0
- package/docs/lambda/assets/main.js +5 -3
- package/docs/lambda/assets/navigation.js +1 -0
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +1424 -1193
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +38 -309
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +37 -308
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +38 -309
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +37 -306
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +36 -299
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +34 -288
- package/docs/lambda/classes/auth.JwtAuthorizer.html +34 -282
- package/docs/lambda/classes/errors.BadRequestError.html +16 -181
- package/docs/lambda/classes/errors.ForbiddenError.html +16 -181
- package/docs/lambda/classes/errors.HttpError.html +17 -189
- package/docs/lambda/classes/errors.NotFoundError.html +16 -181
- package/docs/lambda/classes/errors.UnauthenticatedError.html +16 -181
- package/docs/lambda/functions/api.createAppSyncHandler.html +3 -80
- package/docs/lambda/functions/api.createHttpHandler.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandler.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -78
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -76
- package/docs/lambda/hierarchy.html +1 -0
- package/docs/lambda/index.html +34 -90
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +6 -105
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +7 -105
- package/docs/lambda/interfaces/api.HttpResponseContext.html +5 -100
- package/docs/lambda/interfaces/api.Operation.html +3 -92
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +4 -106
- package/docs/lambda/modules/api.html +1 -82
- package/docs/lambda/modules/auth.html +1 -64
- package/docs/lambda/modules/errors.html +1 -60
- package/docs/lambda/modules.html +1 -47
- package/docs/lambda/types/api.APIGatewayv1Handler.html +2 -62
- package/docs/lambda/types/api.AppSyncHandler.html +2 -82
- package/docs/lambda/types/api.HttpHandler.html +2 -84
- package/docs/projen/assets/hierarchy.js +1 -0
- package/docs/projen/assets/icons.js +18 -0
- package/docs/projen/assets/icons.svg +1 -0
- package/docs/projen/assets/main.js +5 -3
- package/docs/projen/assets/navigation.js +1 -0
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +1424 -1193
- package/docs/projen/classes/Datastore.html +26 -246
- package/docs/projen/classes/GraphQlApi.html +25 -212
- package/docs/projen/classes/RestApi.html +49 -347
- package/docs/projen/classes/ServerlessProject.html +245 -1409
- package/docs/projen/classes/Workflow.html +39 -273
- package/docs/projen/index.html +34 -98
- package/docs/projen/interfaces/DatastoreOptions.html +3 -77
- package/docs/projen/interfaces/GraphQlApiOptions.html +3 -77
- package/docs/projen/interfaces/RestApiOptions.html +3 -77
- package/docs/projen/interfaces/ServerlessProjectOptions.html +822 -2053
- package/docs/projen/interfaces/WorkflowOptions.html +3 -77
- package/docs/projen/modules.html +1 -69
- package/docs/projen/variables/PACKAGE_NAME.html +1 -50
- package/lib/constructs/authentication.d.ts +13 -0
- package/lib/constructs/authentication.js +47 -13
- package/lib/constructs/base-api.js +1 -1
- package/lib/constructs/func.js +1 -1
- package/lib/constructs/graphql.js +21 -11
- package/lib/constructs/rest-api.js +18 -8
- package/lib/constructs/table.js +1 -1
- package/lib/constructs/workflow.js +18 -8
- package/lib/lambda/auth.js +1 -1
- package/lib/lambda/handler.d.ts +1 -1
- package/lib/lambda/handler.js +21 -11
- package/lib/lambda/index.js +18 -8
- package/lib/projen/core.js +18 -8
- package/lib/projen/datastore.js +18 -8
- package/lib/projen/graphql.js +21 -11
- package/lib/projen/lazy-sampledir.js +1 -1
- package/lib/projen/rest-api.js +18 -8
- package/lib/projen/workflow.js +18 -8
- package/lib/tests/integ-test-util.js +3 -3
- package/package.json +26 -25
|
@@ -1,219 +1,106 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
<div class="tsd-toolbar-contents container">
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
-
<div class="field">
|
|
6
|
-
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
-
<ul class="results">
|
|
8
|
-
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
|
|
10
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
-
<div class="container container-main">
|
|
12
|
-
<div class="col-content">
|
|
13
|
-
<div class="tsd-page-title">
|
|
14
|
-
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../modules.html">cdk-serverless</a></li>
|
|
16
|
-
<li><a href="LambdaFunction.html">LambdaFunction</a></li></ul>
|
|
17
|
-
<h1>Class LambdaFunction</h1></div>
|
|
18
|
-
<section class="tsd-panel tsd-comment">
|
|
19
|
-
<div class="tsd-comment tsd-typography"><p>The LambdaFunction construct extends the AWS CDK NodejsFunction to provide additional configurations and environment settings for AWS Lambda functions.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LambdaFunction | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="LambdaFunction.html">LambdaFunction</a></li></ul><h1>Class LambdaFunction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The LambdaFunction construct extends the AWS CDK NodejsFunction to provide additional configurations and environment settings for AWS Lambda functions.
|
|
20
2
|
This construct facilitates setting up a Lambda function with various custom options, environment variables, and permissions required to interact with AWS services
|
|
21
3
|
such as DynamoDB, Cognito, and S3. It supports setting up Lambda functions with pre-defined bundles, custom handlers, and integrations with AWS services.
|
|
22
4
|
The construct also provides methods to dynamically update the configuration and permissions of the Lambda function after it has been created.</p>
|
|
23
|
-
</div>
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
</
|
|
27
|
-
</div></section>
|
|
28
|
-
<
|
|
29
|
-
<
|
|
30
|
-
<
|
|
31
|
-
<
|
|
32
|
-
<
|
|
33
|
-
<
|
|
34
|
-
<
|
|
35
|
-
<
|
|
36
|
-
<
|
|
37
|
-
<
|
|
38
|
-
<
|
|
39
|
-
<
|
|
40
|
-
<
|
|
41
|
-
<
|
|
42
|
-
</div></section>
|
|
43
|
-
<
|
|
44
|
-
<
|
|
45
|
-
<
|
|
46
|
-
<a href="LambdaFunction.html#
|
|
47
|
-
<a href="LambdaFunction.html#
|
|
48
|
-
|
|
49
|
-
<a href="LambdaFunction.html#
|
|
50
|
-
<a href="LambdaFunction.html#
|
|
51
|
-
<a href="LambdaFunction.html#
|
|
52
|
-
<a href="LambdaFunction.html#
|
|
53
|
-
<a href="LambdaFunction.html#
|
|
54
|
-
<a href="LambdaFunction.html#
|
|
55
|
-
<a href="LambdaFunction.html#
|
|
56
|
-
<a href="LambdaFunction.html#
|
|
57
|
-
<a href="LambdaFunction.html#
|
|
58
|
-
<a href="LambdaFunction.html#
|
|
59
|
-
<a href="LambdaFunction.html#
|
|
60
|
-
<a href="LambdaFunction.html#
|
|
61
|
-
</
|
|
62
|
-
<
|
|
63
|
-
<
|
|
64
|
-
<
|
|
65
|
-
<a href="LambdaFunction.html#
|
|
66
|
-
<a href="LambdaFunction.html#
|
|
67
|
-
<a href="LambdaFunction.html#
|
|
68
|
-
<a href="LambdaFunction.html#
|
|
69
|
-
<a href="LambdaFunction.html#
|
|
70
|
-
</
|
|
71
|
-
<
|
|
72
|
-
<
|
|
73
|
-
<
|
|
74
|
-
<a href="LambdaFunction.html#
|
|
75
|
-
<a href="LambdaFunction.html#
|
|
76
|
-
<a href="LambdaFunction.html#
|
|
77
|
-
<a href="LambdaFunction.html#
|
|
78
|
-
<a href="LambdaFunction.html#
|
|
79
|
-
<a href="LambdaFunction.html#
|
|
80
|
-
<a href="LambdaFunction.html#
|
|
81
|
-
<a href="LambdaFunction.html#
|
|
82
|
-
<a href="LambdaFunction.html#
|
|
83
|
-
<a href="LambdaFunction.html#
|
|
84
|
-
<a href="LambdaFunction.html#
|
|
85
|
-
<a href="LambdaFunction.html#
|
|
86
|
-
<a href="LambdaFunction.html#
|
|
87
|
-
<a href="LambdaFunction.html#
|
|
88
|
-
<a href="LambdaFunction.html#
|
|
89
|
-
<a href="LambdaFunction.html#
|
|
90
|
-
<a href="LambdaFunction.html#
|
|
91
|
-
<a href="LambdaFunction.html#
|
|
92
|
-
<a href="LambdaFunction.html#
|
|
93
|
-
<a href="LambdaFunction.html#
|
|
94
|
-
<a href="LambdaFunction.html#
|
|
95
|
-
<a href="LambdaFunction.html#
|
|
96
|
-
<a href="LambdaFunction.html#
|
|
97
|
-
<a href="LambdaFunction.html#
|
|
98
|
-
<a href="LambdaFunction.html#
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
<a href="
|
|
103
|
-
<a href="LambdaFunction.html#
|
|
104
|
-
|
|
105
|
-
<
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
</div></section></div></details></section></section>
|
|
123
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
124
|
-
<h2>Constructors</h2>
|
|
125
|
-
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
126
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
127
|
-
<ul class="tsd-signatures">
|
|
128
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_LambdaFunction"><span class="tsd-kind-constructor-signature">new <wbr/>Lambda<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#constructor.new_LambdaFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
129
|
-
<li class="tsd-description">
|
|
130
|
-
<div class="tsd-comment tsd-typography"><p>Creates an instance of LambdaFunction.</p>
|
|
131
|
-
</div>
|
|
132
|
-
<div class="tsd-parameters">
|
|
133
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
134
|
-
<ul class="tsd-parameter-list">
|
|
135
|
-
<li>
|
|
136
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
|
|
137
|
-
<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
|
|
138
|
-
</div></li>
|
|
139
|
-
<li>
|
|
140
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
|
|
141
|
-
<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
|
|
142
|
-
</div></li>
|
|
143
|
-
<li>
|
|
144
|
-
<h5><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></h5>
|
|
145
|
-
<div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
|
|
146
|
-
</div></li></ul></div>
|
|
147
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4>
|
|
148
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
149
|
-
<p>Overrides lambdaNodejs.NodejsFunction.constructor</p></aside></li></ul></section></section>
|
|
150
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
151
|
-
<h2>Properties</h2>
|
|
152
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="architecture" class="tsd-anchor"></a>
|
|
153
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>architecture</span><a href="#architecture" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
154
|
-
<div class="tsd-signature"><span class="tsd-kind-property">architecture</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Architecture</span></div>
|
|
155
|
-
<div class="tsd-comment tsd-typography"><p>The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).</p>
|
|
156
|
-
</div>
|
|
157
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
158
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.architecture</p></aside></section>
|
|
159
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="canCreatePermissions" class="tsd-anchor"></a>
|
|
160
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>can<wbr/>Create<wbr/>Permissions</span><a href="#canCreatePermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
161
|
-
<div class="tsd-signature"><span class="tsd-kind-property">can<wbr/>Create<wbr/>Permissions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources">
|
|
162
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.canCreatePermissions</p></aside></section>
|
|
163
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadLetterQueue" class="tsd-anchor"></a>
|
|
164
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Queue</span><a href="#deadLetterQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
165
|
-
<div class="tsd-signature"><span class="tsd-kind-property">dead<wbr/>Letter<wbr/>Queue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IQueue</span></div>
|
|
166
|
-
<div class="tsd-comment tsd-typography"><p>The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).</p>
|
|
167
|
-
</div>
|
|
168
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
169
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterQueue</p></aside></section>
|
|
170
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadLetterTopic" class="tsd-anchor"></a>
|
|
171
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Topic</span><a href="#deadLetterTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
172
|
-
<div class="tsd-signature"><span class="tsd-kind-property">dead<wbr/>Letter<wbr/>Topic</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ITopic</span></div>
|
|
173
|
-
<div class="tsd-comment tsd-typography"><p>The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).</p>
|
|
174
|
-
</div>
|
|
175
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
176
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterTopic</p></aside></section>
|
|
177
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="env" class="tsd-anchor"></a>
|
|
178
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
179
|
-
<div class="tsd-signature"><span class="tsd-kind-property">env</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ResourceEnvironment</span></div><aside class="tsd-sources">
|
|
180
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.env</p></aside></section>
|
|
181
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionArn" class="tsd-anchor"></a>
|
|
182
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Arn</span><a href="#functionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
183
|
-
<div class="tsd-signature"><span class="tsd-kind-property">function<wbr/>Arn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
184
|
-
<div class="tsd-comment tsd-typography"><p>ARN of this function</p>
|
|
185
|
-
</div>
|
|
186
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
187
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.functionArn</p></aside></section>
|
|
188
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionName" class="tsd-anchor"></a>
|
|
189
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Name</span><a href="#functionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
190
|
-
<div class="tsd-signature"><span class="tsd-kind-property">function<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
191
|
-
<div class="tsd-comment tsd-typography"><p>Name of this function</p>
|
|
192
|
-
</div>
|
|
193
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
194
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.functionName</p></aside></section>
|
|
195
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantPrincipal" class="tsd-anchor"></a>
|
|
196
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>grant<wbr/>Principal</span><a href="#grantPrincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
197
|
-
<div class="tsd-signature"><span class="tsd-kind-property">grant<wbr/>Principal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">IPrincipal</span></div>
|
|
198
|
-
<div class="tsd-comment tsd-typography"><p>The principal this Lambda Function is running as</p>
|
|
199
|
-
</div>
|
|
200
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
201
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.grantPrincipal</p></aside></section>
|
|
202
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
203
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
204
|
-
<div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div>
|
|
205
|
-
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
206
|
-
</div>
|
|
207
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
208
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.node</p></aside></section>
|
|
209
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="permissionsNode" class="tsd-anchor"></a>
|
|
210
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>permissions<wbr/>Node</span><a href="#permissionsNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
211
|
-
<div class="tsd-signature"><span class="tsd-kind-property">permissions<wbr/>Node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div><aside class="tsd-sources">
|
|
212
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.permissionsNode</p></aside></section>
|
|
213
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="physicalName" class="tsd-anchor"></a>
|
|
214
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>physical<wbr/>Name</span><a href="#physicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
215
|
-
<div class="tsd-signature"><span class="tsd-kind-property">physical<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
216
|
-
<div class="tsd-comment tsd-typography"><p>Returns a string-encoded token that resolves to the physical name that
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">lambdaFunction</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">LambdaFunction</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">'MyLambdaFunction'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">entry:</span><span class="hl-1"> </span><span class="hl-2">'path/to/lambda/handler.ts'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">handler:</span><span class="hl-1"> </span><span class="hl-2">'main'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">stageName:</span><span class="hl-1"> </span><span class="hl-2">'dev'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">table:</span><span class="hl-1"> </span><span class="hl-4">myDynamoDBTable</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">userPool:</span><span class="hl-1"> </span><span class="hl-4">myCognitoUserPool</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">assetBucket:</span><span class="hl-1"> </span><span class="hl-4">myS3Bucket</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">lambdaOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">timeout:</span><span class="hl-1"> </span><span class="hl-4">Duration</span><span class="hl-1">.</span><span class="hl-0">seconds</span><span class="hl-1">(</span><span class="hl-8">30</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">memorySize:</span><span class="hl-1"> </span><span class="hl-8">512</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">// Add additional permissions</span><br/><span class="hl-4">lambdaFunction</span><span class="hl-1">.</span><span class="hl-0">grantSendEmails</span><span class="hl-1">();</span><br/><span class="hl-4">lambdaFunction</span><span class="hl-1">.</span><span class="hl-0">grantTableWrite</span><span class="hl-1">();</span>
|
|
6
|
+
</code><button type="button">Copy</button></pre>
|
|
7
|
+
|
|
8
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy" data-refl="120"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">NodejsFunction</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LambdaFunction</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="LambdaFunction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
9
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="LambdaFunction.html#architecture" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>architecture</span></a>
|
|
10
|
+
<a href="LambdaFunction.html#cancreatepermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a>
|
|
11
|
+
<a href="LambdaFunction.html#deadletterqueue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue?</span></a>
|
|
12
|
+
<a href="LambdaFunction.html#deadlettertopic" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic?</span></a>
|
|
13
|
+
<a href="LambdaFunction.html#env" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>env</span></a>
|
|
14
|
+
<a href="LambdaFunction.html#functionarn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>function<wbr/>Arn</span></a>
|
|
15
|
+
<a href="LambdaFunction.html#functionname" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>function<wbr/>Name</span></a>
|
|
16
|
+
<a href="LambdaFunction.html#grantprincipal" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>grant<wbr/>Principal</span></a>
|
|
17
|
+
<a href="LambdaFunction.html#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a>
|
|
18
|
+
<a href="LambdaFunction.html#permissionsnode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a>
|
|
19
|
+
<a href="LambdaFunction.html#physicalname" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>physical<wbr/>Name</span></a>
|
|
20
|
+
<a href="LambdaFunction.html#role" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role?</span></a>
|
|
21
|
+
<a href="LambdaFunction.html#runtime" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a>
|
|
22
|
+
<a href="LambdaFunction.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a>
|
|
23
|
+
<a href="LambdaFunction.html#timeout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout?</span></a>
|
|
24
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="LambdaFunction.html#connections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>connections</span></a>
|
|
25
|
+
<a href="LambdaFunction.html#currentversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>current<wbr/>Version</span></a>
|
|
26
|
+
<a href="LambdaFunction.html#isboundtovpc" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span></a>
|
|
27
|
+
<a href="LambdaFunction.html#latestversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>latest<wbr/>Version</span></a>
|
|
28
|
+
<a href="LambdaFunction.html#loggroup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>log<wbr/>Group</span></a>
|
|
29
|
+
<a href="LambdaFunction.html#resourcearnsforgrantinvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a>
|
|
30
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="LambdaFunction.html#addalias" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Alias</span></a>
|
|
31
|
+
<a href="LambdaFunction.html#addenvironment" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Environment</span></a>
|
|
32
|
+
<a href="LambdaFunction.html#addeventsource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a>
|
|
33
|
+
<a href="LambdaFunction.html#addeventsourcemapping" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a>
|
|
34
|
+
<a href="LambdaFunction.html#addfunctionurl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Function<wbr/>Url</span></a>
|
|
35
|
+
<a href="LambdaFunction.html#addlayers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Layers</span></a>
|
|
36
|
+
<a href="LambdaFunction.html#addpermission" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Permission</span></a>
|
|
37
|
+
<a href="LambdaFunction.html#addtorolepolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a>
|
|
38
|
+
<a href="LambdaFunction.html#applyremovalpolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a>
|
|
39
|
+
<a href="LambdaFunction.html#configureasyncinvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a>
|
|
40
|
+
<a href="LambdaFunction.html#considerwarningoninvokefunctionpermissions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a>
|
|
41
|
+
<a href="LambdaFunction.html#generatephysicalname" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Physical<wbr/>Name</span></a>
|
|
42
|
+
<a href="LambdaFunction.html#getresourcearnattribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span></a>
|
|
43
|
+
<a href="LambdaFunction.html#getresourcenameattribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a>
|
|
44
|
+
<a href="LambdaFunction.html#grantdeleteasset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Delete<wbr/>Asset</span></a>
|
|
45
|
+
<a href="LambdaFunction.html#grantinvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke</span></a>
|
|
46
|
+
<a href="LambdaFunction.html#grantinvokecompositeprincipal" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span></a>
|
|
47
|
+
<a href="LambdaFunction.html#grantinvokelatestversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Latest<wbr/>Version</span></a>
|
|
48
|
+
<a href="LambdaFunction.html#grantinvokeurl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Url</span></a>
|
|
49
|
+
<a href="LambdaFunction.html#grantinvokeversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Version</span></a>
|
|
50
|
+
<a href="LambdaFunction.html#grantreadassets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Read<wbr/>Assets</span></a>
|
|
51
|
+
<a href="LambdaFunction.html#grantsendemails" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a>
|
|
52
|
+
<a href="LambdaFunction.html#granttablewrite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a>
|
|
53
|
+
<a href="LambdaFunction.html#grantuploadassets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a>
|
|
54
|
+
<a href="LambdaFunction.html#grantuserpoolread" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a>
|
|
55
|
+
<a href="LambdaFunction.html#grantuserpoolreadwrite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span></a>
|
|
56
|
+
<a href="LambdaFunction.html#invalidateversionbasedon" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invalidate<wbr/>Version<wbr/>Based<wbr/>On</span></a>
|
|
57
|
+
<a href="LambdaFunction.html#metric" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric</span></a>
|
|
58
|
+
<a href="LambdaFunction.html#metricduration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Duration</span></a>
|
|
59
|
+
<a href="LambdaFunction.html#metricerrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Errors</span></a>
|
|
60
|
+
<a href="LambdaFunction.html#metricinvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Invocations</span></a>
|
|
61
|
+
<a href="LambdaFunction.html#metricthrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a>
|
|
62
|
+
<a href="LambdaFunction.html#settable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Table</span></a>
|
|
63
|
+
<a href="LambdaFunction.html#settimeout" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a>
|
|
64
|
+
<a href="LambdaFunction.html#setuserpool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Pool</span></a>
|
|
65
|
+
<a href="LambdaFunction.html#tostring" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
66
|
+
<a href="LambdaFunction.html#warninvokefunctionpermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a>
|
|
67
|
+
<a href="LambdaFunction.html#classifyversionproperty" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>classify<wbr/>Version<wbr/>Property</span></a>
|
|
68
|
+
<a href="LambdaFunction.html#fromfunctionarn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Arn</span></a>
|
|
69
|
+
<a href="LambdaFunction.html#fromfunctionattributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Attributes</span></a>
|
|
70
|
+
<a href="LambdaFunction.html#fromfunctionname" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Name</span></a>
|
|
71
|
+
<a href="LambdaFunction.html#isconstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
72
|
+
<a href="LambdaFunction.html#isownedresource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a>
|
|
73
|
+
<a href="LambdaFunction.html#isresource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Resource</span></a>
|
|
74
|
+
<a href="LambdaFunction.html#metricall" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All</span></a>
|
|
75
|
+
<a href="LambdaFunction.html#metricallconcurrentexecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span></a>
|
|
76
|
+
<a href="LambdaFunction.html#metricallduration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Duration</span></a>
|
|
77
|
+
<a href="LambdaFunction.html#metricallerrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Errors</span></a>
|
|
78
|
+
<a href="LambdaFunction.html#metricallinvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a>
|
|
79
|
+
<a href="LambdaFunction.html#metricallthrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a>
|
|
80
|
+
<a href="LambdaFunction.html#metricallunreservedconcurrentexecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a>
|
|
81
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorlambdafunction" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">LambdaFunction</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#constructorlambdafunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an instance of LambdaFunction.</p>
|
|
82
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span><div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
|
|
83
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
|
|
84
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></span><div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
|
|
85
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides lambdaNodejs.NodejsFunction.constructor</p></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="architecture" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>architecture</span><a href="#architecture" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">architecture</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Architecture</span></div><div class="tsd-comment tsd-typography"><p>The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).</p>
|
|
86
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.architecture</p></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="cancreatepermissions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>can<wbr/>Create<wbr/>Permissions</span><a href="#cancreatepermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">canCreatePermissions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div><div class="tsd-comment tsd-typography"><p>Whether the addPermission() call adds any permissions</p>
|
|
87
|
+
<p>True for new Lambdas, false for version $LATEST and imported Lambdas
|
|
88
|
+
from different accounts.</p>
|
|
89
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.canCreatePermissions</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadletterqueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dead<wbr/>Letter<wbr/>Queue</span><a href="#deadletterqueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deadLetterQueue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IQueue</span></div><div class="tsd-comment tsd-typography"><p>The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).</p>
|
|
90
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.deadLetterQueue</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadlettertopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dead<wbr/>Letter<wbr/>Topic</span><a href="#deadlettertopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deadLetterTopic</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ITopic</span></div><div class="tsd-comment tsd-typography"><p>The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).</p>
|
|
91
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.deadLetterTopic</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="env" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">env</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ResourceEnvironment</span></div><div class="tsd-comment tsd-typography"><p>The environment this resource belongs to.
|
|
92
|
+
For resources that are created and managed by the CDK
|
|
93
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
94
|
+
this is always the same as the environment of the stack they belong to;
|
|
95
|
+
however, for imported resources
|
|
96
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
97
|
+
that might be different than the stack they were imported into.</p>
|
|
98
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.env</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionarn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>function<wbr/>Arn</span><a href="#functionarn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">functionArn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>ARN of this function</p>
|
|
99
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.functionArn</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>function<wbr/>Name</span><a href="#functionname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">functionName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of this function</p>
|
|
100
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.functionName</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantprincipal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>grant<wbr/>Principal</span><a href="#grantprincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">grantPrincipal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IPrincipal</span></div><div class="tsd-comment tsd-typography"><p>The principal this Lambda Function is running as</p>
|
|
101
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantPrincipal</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div><div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
102
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.node</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="permissionsnode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>permissions<wbr/>Node</span><a href="#permissionsnode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">permissionsNode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div><div class="tsd-comment tsd-typography"><p>The construct node where permissions are attached.</p>
|
|
103
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.permissionsNode</p></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="physicalname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>physical<wbr/>Name</span><a href="#physicalname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">physicalName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Returns a string-encoded token that resolves to the physical name that
|
|
217
104
|
should be passed to the CloudFormation resource.</p>
|
|
218
105
|
<p>This value will resolve to one of the following:</p>
|
|
219
106
|
<ul>
|
|
@@ -222,463 +109,104 @@ should be passed to the CloudFormation resource.</p>
|
|
|
222
109
|
<li>a concrete name generated automatically during synthesis, in
|
|
223
110
|
cross-environment scenarios.</li>
|
|
224
111
|
</ul>
|
|
225
|
-
</div>
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></div>
|
|
231
|
-
<div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
|
|
232
|
-
</div>
|
|
233
|
-
<div class="tsd-comment tsd-typography"></div></section>
|
|
234
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="role" class="tsd-anchor"></a>
|
|
235
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
236
|
-
<div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IRole</span></div>
|
|
237
|
-
<div class="tsd-comment tsd-typography"><p>Execution role associated with this function</p>
|
|
238
|
-
</div>
|
|
239
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
240
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.role</p></aside></section>
|
|
241
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runtime" class="tsd-anchor"></a>
|
|
242
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
243
|
-
<div class="tsd-signature"><span class="tsd-kind-property">runtime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Runtime</span></div>
|
|
244
|
-
<div class="tsd-comment tsd-typography"><p>The runtime configured for this lambda.</p>
|
|
245
|
-
</div>
|
|
246
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
247
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.runtime</p></aside></section>
|
|
248
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
|
|
249
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
250
|
-
<div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Stack</span></div><aside class="tsd-sources">
|
|
251
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.stack</p></aside></section>
|
|
252
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="timeout" class="tsd-anchor"></a>
|
|
253
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
254
|
-
<div class="tsd-signature"><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Duration</span></div>
|
|
255
|
-
<div class="tsd-comment tsd-typography"><p>The timeout configured for this lambda.</p>
|
|
256
|
-
</div>
|
|
257
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
258
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.timeout</p></aside></section></section>
|
|
259
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
260
|
-
<h2>Accessors</h2>
|
|
261
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="connections" class="tsd-anchor"></a>
|
|
262
|
-
<h3 class="tsd-anchor-link"><span>connections</span><a href="#connections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
263
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
264
|
-
<li class="tsd-signature" id="connections.connections-1"><span class="tsd-signature-symbol">get</span> connections<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Connections</span></li>
|
|
265
|
-
<li class="tsd-description">
|
|
266
|
-
<div class="tsd-comment tsd-typography"><p>Access the Connections object</p>
|
|
112
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.physicalName</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="role" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IRole</span></div><div class="tsd-comment tsd-typography"><p>Execution role associated with this function</p>
|
|
113
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.role</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">runtime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Runtime</span></div><div class="tsd-comment tsd-typography"><p>The runtime configured for this lambda.</p>
|
|
114
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.runtime</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Stack</span></div><div class="tsd-comment tsd-typography"><p>The stack in which this resource is defined.</p>
|
|
115
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.stack</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="timeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Duration</span></div><div class="tsd-comment tsd-typography"><p>The timeout configured for this lambda.</p>
|
|
116
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.timeout</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="connections" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connections</span><a href="#connections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="connections-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">connections</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Connections</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Access the Connections object</p>
|
|
267
117
|
<p>Will fail if not a VPC-enabled Lambda Function</p>
|
|
268
|
-
</div>
|
|
269
|
-
|
|
270
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
271
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.connections</p></aside></li></ul></section>
|
|
272
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="currentVersion" class="tsd-anchor"></a>
|
|
273
|
-
<h3 class="tsd-anchor-link"><span>current<wbr/>Version</span><a href="#currentVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
274
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
275
|
-
<li class="tsd-signature" id="currentVersion.currentVersion-1"><span class="tsd-signature-symbol">get</span> currentVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Version</span></li>
|
|
276
|
-
<li class="tsd-description">
|
|
277
|
-
<div class="tsd-comment tsd-typography"><p>Returns a <code>lambda.Version</code> which represents the current version of this
|
|
278
|
-
Lambda function. A new version will be created every time the function's
|
|
118
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Connections</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.connections</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="currentversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>current<wbr/>Version</span><a href="#currentversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="currentversion-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">currentVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Version</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a <code>lambda.Version</code> which represents the current version of this
|
|
119
|
+
Lambda function. A new version will be created every time the function's
|
|
279
120
|
configuration changes.</p>
|
|
280
121
|
<p>You can specify options for this version using the <code>currentVersionOptions</code>
|
|
281
122
|
prop when initializing the <code>lambda.Function</code>.</p>
|
|
282
|
-
</div>
|
|
283
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Version</span></h4>
|
|
284
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
285
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.currentVersion</p></aside></li></ul></section>
|
|
286
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isBoundToVpc" class="tsd-anchor"></a>
|
|
287
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span><a href="#isBoundToVpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
288
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
289
|
-
<li class="tsd-signature" id="isBoundToVpc.isBoundToVpc-1"><span class="tsd-signature-symbol">get</span> isBoundToVpc<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
290
|
-
<li class="tsd-description">
|
|
291
|
-
<div class="tsd-comment tsd-typography"><p>Whether or not this Lambda function was bound to a VPC</p>
|
|
123
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Version</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.currentVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isboundtovpc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span><a href="#isboundtovpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="isboundtovpc-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">isBoundToVpc</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether or not this Lambda function was bound to a VPC</p>
|
|
292
124
|
<p>If this is is <code>false</code>, trying to access the <code>connections</code> object will fail.</p>
|
|
293
|
-
</div>
|
|
294
|
-
<
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
<
|
|
298
|
-
|
|
299
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
300
|
-
<li class="tsd-signature" id="latestVersion.latestVersion-1"><span class="tsd-signature-symbol">get</span> latestVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IVersion</span></li>
|
|
301
|
-
<li class="tsd-description">
|
|
302
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IVersion</span></h4><aside class="tsd-sources">
|
|
303
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.latestVersion</p></aside></li></ul></section>
|
|
304
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logGroup" class="tsd-anchor"></a>
|
|
305
|
-
<h3 class="tsd-anchor-link"><span>log<wbr/>Group</span><a href="#logGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
306
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
307
|
-
<li class="tsd-signature" id="logGroup.logGroup-1"><span class="tsd-signature-symbol">get</span> logGroup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">ILogGroup</span></li>
|
|
308
|
-
<li class="tsd-description">
|
|
309
|
-
<div class="tsd-comment tsd-typography"><p>The LogGroup where the Lambda function's logs are made available.</p>
|
|
125
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.isBoundToVpc</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="latestversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>latest<wbr/>Version</span><a href="#latestversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="latestversion-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">latestVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IVersion</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The <code>$LATEST</code> version of this function.</p>
|
|
126
|
+
<p>Note that this is reference to a non-specific AWS Lambda version, which
|
|
127
|
+
means the function this version refers to can return different results in
|
|
128
|
+
different invocations.</p>
|
|
129
|
+
<p>To obtain a reference to an explicit version which references the current
|
|
130
|
+
function configuration, use <code>lambdaFunction.currentVersion</code> instead.</p>
|
|
131
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IVersion</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.latestVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="loggroup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>log<wbr/>Group</span><a href="#loggroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="loggroup-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">logGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ILogGroup</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The LogGroup where the Lambda function's logs are made available.</p>
|
|
310
132
|
<p>If either <code>logRetention</code> is set or this property is called, a CloudFormation custom resource is added to the stack that
|
|
311
|
-
pre-creates the log group as part of the stack deployment, if it already doesn
|
|
133
|
+
pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
|
|
312
134
|
period (never expire, by default).</p>
|
|
313
135
|
<p>Further, if the log group already exists and the <code>logRetention</code> is not set, the custom resource will reset the log retention
|
|
314
136
|
to never expire even if it was configured with a different value.</p>
|
|
315
|
-
</div>
|
|
316
|
-
|
|
317
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
318
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.logGroup</p></aside></li></ul></section>
|
|
319
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="resourceArnsForGrantInvoke" class="tsd-anchor"></a>
|
|
320
|
-
<h3 class="tsd-anchor-link"><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span><a href="#resourceArnsForGrantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
321
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
322
|
-
<li class="tsd-signature" id="resourceArnsForGrantInvoke.resourceArnsForGrantInvoke-1"><span class="tsd-signature-symbol">get</span> resourceArnsForGrantInvoke<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
|
|
323
|
-
<li class="tsd-description">
|
|
324
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
325
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.resourceArnsForGrantInvoke</p></aside></li></ul></section></section>
|
|
326
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
327
|
-
<h2>Methods</h2>
|
|
328
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addAlias" class="tsd-anchor"></a>
|
|
329
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Alias</span><a href="#addAlias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
330
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
331
|
-
<li class="tsd-signature tsd-anchor-link" id="addAlias.addAlias-1"><span class="tsd-kind-call-signature">add<wbr/>Alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliasName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Alias</span><a href="#addAlias.addAlias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
332
|
-
<li class="tsd-description">
|
|
333
|
-
<div class="tsd-comment tsd-typography"><p>Defines an alias for this function.</p>
|
|
137
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ILogGroup</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.logGroup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="resourcearnsforgrantinvoke" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span><a href="#resourcearnsforgrantinvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature" id="resourcearnsforgrantinvoke-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">resourceArnsForGrantInvoke</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()</p>
|
|
138
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.resourceArnsForGrantInvoke</p></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addalias" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Alias</span><a href="#addalias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addalias-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addAlias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliasName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AliasOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Alias</span><a href="#addalias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines an alias for this function.</p>
|
|
334
139
|
<p>The alias will automatically be updated to point to the latest version of
|
|
335
140
|
the function as it is being updated during a deployment.</p>
|
|
336
|
-
<pre><code class="
|
|
337
|
-
</code><button>Copy</button></pre>
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
<
|
|
341
|
-
<ul class="tsd-parameter-
|
|
342
|
-
<li>
|
|
343
|
-
<h5><span class="tsd-kind-parameter">aliasName</span>: <span class="tsd-signature-type">string</span></h5>
|
|
344
|
-
<div class="tsd-comment tsd-typography"><p>The name of the alias</p>
|
|
345
|
-
</div></li>
|
|
346
|
-
<li>
|
|
347
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AliasOptions</span></h5>
|
|
348
|
-
<div class="tsd-comment tsd-typography"><p>Alias options</p>
|
|
349
|
-
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
350
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Alias</span></h4>
|
|
351
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
352
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addAlias</p></aside></li></ul></section>
|
|
353
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEnvironment" class="tsd-anchor"></a>
|
|
354
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Environment</span><a href="#addEnvironment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
355
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
356
|
-
<li class="tsd-signature tsd-anchor-link" id="addEnvironment.addEnvironment-1"><span class="tsd-kind-call-signature">add<wbr/>Environment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#addEnvironment.addEnvironment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
357
|
-
<li class="tsd-description">
|
|
358
|
-
<div class="tsd-comment tsd-typography"><p>Adds an environment variable to this Lambda function.
|
|
141
|
+
<pre><code class="ts"><span class="hl-5">declare</span><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">fn</span><span class="hl-1">: </span><span class="hl-9">lambda</span><span class="hl-1">.</span><span class="hl-9">Function</span><span class="hl-1">;</span><br/><br/><span class="hl-4">fn</span><span class="hl-1">.</span><span class="hl-0">addAlias</span><span class="hl-1">(</span><span class="hl-2">'Live'</span><span class="hl-1">);</span><br/><br/><span class="hl-6">// Is equivalent to</span><br/><br/><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-4">lambda</span><span class="hl-1">.</span><span class="hl-0">Alias</span><span class="hl-1">(</span><span class="hl-5">this</span><span class="hl-1">, </span><span class="hl-2">'AliasLive'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">aliasName:</span><span class="hl-1"> </span><span class="hl-2">'Live'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">version:</span><span class="hl-1"> </span><span class="hl-4">fn</span><span class="hl-1">.</span><span class="hl-4">currentVersion</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
142
|
+
</code><button type="button">Copy</button></pre>
|
|
143
|
+
|
|
144
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">aliasName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the alias</p>
|
|
145
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AliasOptions</span></span><div class="tsd-comment tsd-typography"><p>Alias options</p>
|
|
146
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Alias</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addAlias</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addenvironment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Environment</span><a href="#addenvironment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addenvironment-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addEnvironment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">EnvironmentOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addenvironment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an environment variable to this Lambda function.
|
|
359
147
|
If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
360
|
-
</div>
|
|
361
|
-
<div class="tsd-
|
|
362
|
-
<
|
|
363
|
-
<ul class="tsd-parameter-
|
|
364
|
-
<
|
|
365
|
-
<
|
|
366
|
-
<
|
|
367
|
-
</
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
371
|
-
</div></li>
|
|
372
|
-
<li>
|
|
373
|
-
|
|
374
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
375
|
-
</div><
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
<
|
|
380
|
-
|
|
381
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
382
|
-
<li class="tsd-signature tsd-anchor-link" id="addEventSource.addEventSource-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addEventSource.addEventSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
383
|
-
<li class="tsd-description">
|
|
384
|
-
<div class="tsd-parameters">
|
|
385
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
386
|
-
<ul class="tsd-parameter-list">
|
|
387
|
-
<li>
|
|
388
|
-
<h5><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type ">IEventSource</span></h5></li></ul></div>
|
|
389
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
390
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSource</p></aside></li></ul></section>
|
|
391
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEventSourceMapping" class="tsd-anchor"></a>
|
|
392
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><a href="#addEventSourceMapping" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
393
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
394
|
-
<li class="tsd-signature tsd-anchor-link" id="addEventSourceMapping.addEventSourceMapping-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">EventSourceMapping</span><a href="#addEventSourceMapping.addEventSourceMapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
395
|
-
<li class="tsd-description">
|
|
396
|
-
<div class="tsd-parameters">
|
|
397
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
398
|
-
<ul class="tsd-parameter-list">
|
|
399
|
-
<li>
|
|
400
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
401
|
-
<li>
|
|
402
|
-
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">EventSourceMappingOptions</span></h5></li></ul></div>
|
|
403
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">EventSourceMapping</span></h4><aside class="tsd-sources">
|
|
404
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSourceMapping</p></aside></li></ul></section>
|
|
405
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addFunctionUrl" class="tsd-anchor"></a>
|
|
406
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Function<wbr/>Url</span><a href="#addFunctionUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
407
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
408
|
-
<li class="tsd-signature tsd-anchor-link" id="addFunctionUrl.addFunctionUrl-1"><span class="tsd-kind-call-signature">add<wbr/>Function<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FunctionUrl</span><a href="#addFunctionUrl.addFunctionUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
409
|
-
<li class="tsd-description">
|
|
410
|
-
<div class="tsd-parameters">
|
|
411
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
412
|
-
<ul class="tsd-parameter-list">
|
|
413
|
-
<li>
|
|
414
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">FunctionUrlOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
415
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FunctionUrl</span></h4><aside class="tsd-sources">
|
|
416
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addFunctionUrl</p></aside></li></ul></section>
|
|
417
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addLayers" class="tsd-anchor"></a>
|
|
418
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Layers</span><a href="#addLayers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
419
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
420
|
-
<li class="tsd-signature tsd-anchor-link" id="addLayers.addLayers-1"><span class="tsd-kind-call-signature">add<wbr/>Layers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addLayers.addLayers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
421
|
-
<li class="tsd-description">
|
|
422
|
-
<div class="tsd-comment tsd-typography"><p>Adds one or more Lambda Layers to this Lambda function.</p>
|
|
423
|
-
</div>
|
|
424
|
-
<div class="tsd-parameters">
|
|
425
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
426
|
-
<ul class="tsd-parameter-list">
|
|
427
|
-
<li>
|
|
428
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span>: <span class="tsd-signature-type ">ILayerVersion</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
429
|
-
<div class="tsd-comment tsd-typography"><p>the layers to be added.</p>
|
|
430
|
-
</div><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
|
|
431
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
432
|
-
<div class="tsd-comment tsd-typography">
|
|
433
|
-
<h4>Throws</h4><p>if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.</p>
|
|
434
|
-
</div><aside class="tsd-sources">
|
|
435
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addLayers</p></aside></li></ul></section>
|
|
436
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPermission" class="tsd-anchor"></a>
|
|
437
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Permission</span><a href="#addPermission" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
438
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
439
|
-
<li class="tsd-signature tsd-anchor-link" id="addPermission.addPermission-1"><span class="tsd-kind-call-signature">add<wbr/>Permission</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">permission</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPermission.addPermission-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
440
|
-
<li class="tsd-description">
|
|
441
|
-
<div class="tsd-comment tsd-typography"><p>Adds a permission to the Lambda resource policy.</p>
|
|
442
|
-
</div>
|
|
443
|
-
<div class="tsd-parameters">
|
|
444
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
445
|
-
<ul class="tsd-parameter-list">
|
|
446
|
-
<li>
|
|
447
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
|
|
448
|
-
<div class="tsd-comment tsd-typography"><p>The id for the permission construct</p>
|
|
449
|
-
</div></li>
|
|
450
|
-
<li>
|
|
451
|
-
<h5><span class="tsd-kind-parameter">permission</span>: <span class="tsd-signature-type ">Permission</span></h5>
|
|
452
|
-
<div class="tsd-comment tsd-typography"><p>The permission to grant to this Lambda function.</p>
|
|
453
|
-
</div></li></ul></div>
|
|
454
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
455
|
-
<div class="tsd-comment tsd-typography">
|
|
456
|
-
<h4>See</h4><p>Permission for details.</p>
|
|
457
|
-
</div><aside class="tsd-sources">
|
|
458
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addPermission</p></aside></li></ul></section>
|
|
459
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addToRolePolicy" class="tsd-anchor"></a>
|
|
460
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span><a href="#addToRolePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
461
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
462
|
-
<li class="tsd-signature tsd-anchor-link" id="addToRolePolicy.addToRolePolicy-1"><span class="tsd-kind-call-signature">add<wbr/>To<wbr/>Role<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addToRolePolicy.addToRolePolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
463
|
-
<li class="tsd-description">
|
|
464
|
-
<div class="tsd-comment tsd-typography"><p>Adds a statement to the IAM role assumed by the instance.</p>
|
|
465
|
-
</div>
|
|
466
|
-
<div class="tsd-parameters">
|
|
467
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
468
|
-
<ul class="tsd-parameter-list">
|
|
469
|
-
<li>
|
|
470
|
-
<h5><span class="tsd-kind-parameter">statement</span>: <span class="tsd-signature-type ">PolicyStatement</span></h5></li></ul></div>
|
|
471
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
472
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
473
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.addToRolePolicy</p></aside></li></ul></section>
|
|
474
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="applyRemovalPolicy" class="tsd-anchor"></a>
|
|
475
|
-
<h3 class="tsd-anchor-link"><span>apply<wbr/>Removal<wbr/>Policy</span><a href="#applyRemovalPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
476
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
477
|
-
<li class="tsd-signature tsd-anchor-link" id="applyRemovalPolicy.applyRemovalPolicy-1"><span class="tsd-kind-call-signature">apply<wbr/>Removal<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">policy</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyRemovalPolicy.applyRemovalPolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
478
|
-
<li class="tsd-description">
|
|
479
|
-
<div class="tsd-comment tsd-typography"><p>Apply the given removal policy to this resource</p>
|
|
148
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The environment variable key.</p>
|
|
149
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The environment variable's value.</p>
|
|
150
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EnvironmentOptions</span></span><div class="tsd-comment tsd-typography"><p>Environment variable options.</p>
|
|
151
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addEnvironment</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addeventsource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source</span><a href="#addeventsource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addeventsource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addEventSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IEventSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addeventsource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an event source to this function.</p>
|
|
152
|
+
<p>Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.</p>
|
|
153
|
+
<p>The following example adds an SQS Queue as an event source:</p>
|
|
154
|
+
<pre><code><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">SqsEventSource</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">'aws-cdk-lib/aws-lambda-event-sources'</span><span class="hl-1">;</span><br/><span class="hl-4">myFunction</span><span class="hl-1">.</span><span class="hl-0">addEventSource</span><span class="hl-1">(</span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">SqsEventSource</span><span class="hl-1">(</span><span class="hl-4">myQueue</span><span class="hl-1">));</span>
|
|
155
|
+
</code><button>Copy</button></pre>
|
|
156
|
+
|
|
157
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">IEventSource</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addEventSource</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addeventsourcemapping" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><a href="#addeventsourcemapping" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addeventsourcemapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addEventSourceMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventSourceMappingOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventSourceMapping</span><a href="#addeventsourcemapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an event source that maps to this AWS Lambda function.</p>
|
|
158
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>construct ID</p>
|
|
159
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EventSourceMappingOptions</span></span><div class="tsd-comment tsd-typography"><p>mapping options</p>
|
|
160
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventSourceMapping</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addEventSourceMapping</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addfunctionurl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Function<wbr/>Url</span><a href="#addfunctionurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addfunctionurl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addFunctionUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">FunctionUrlOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FunctionUrl</span><a href="#addfunctionurl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a url to this lambda function.</p>
|
|
161
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">FunctionUrlOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FunctionUrl</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addFunctionUrl</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addlayers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Layers</span><a href="#addlayers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addlayers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addLayers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ILayerVersion</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addlayers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds one or more Lambda Layers to this Lambda function.</p>
|
|
162
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span>: <span class="tsd-signature-type">ILayerVersion</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>the layers to be added.</p>
|
|
163
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.</p>
|
|
164
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addLayers</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addpermission" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Permission</span><a href="#addpermission" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addpermission-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addPermission</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">permission</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Permission</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addpermission-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a permission to the Lambda resource policy.</p>
|
|
165
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id for the permission construct</p>
|
|
166
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">permission</span>: <span class="tsd-signature-type">Permission</span></span><div class="tsd-comment tsd-typography"><p>The permission to grant to this Lambda function.</p>
|
|
167
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Permission for details.</p>
|
|
168
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addPermission</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addtorolepolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span><a href="#addtorolepolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addtorolepolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addToRolePolicy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PolicyStatement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addtorolepolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a statement to the IAM role assumed by the instance.</p>
|
|
169
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">statement</span>: <span class="tsd-signature-type">PolicyStatement</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.addToRolePolicy</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="applyremovalpolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Removal<wbr/>Policy</span><a href="#applyremovalpolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="applyremovalpolicy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">applyRemovalPolicy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">policy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RemovalPolicy</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#applyremovalpolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Apply the given removal policy to this resource</p>
|
|
480
170
|
<p>The Removal Policy controls what happens to this resource when it stops
|
|
481
|
-
being managed by CloudFormation, either because you
|
|
482
|
-
CDK application or because you
|
|
171
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
172
|
+
CDK application or because you've made a change that requires the resource
|
|
483
173
|
to be replaced.</p>
|
|
484
174
|
<p>The resource can be deleted (<code>RemovalPolicy.DESTROY</code>), or left in your AWS
|
|
485
175
|
account for data recovery and cleanup later (<code>RemovalPolicy.RETAIN</code>).</p>
|
|
486
|
-
</div>
|
|
487
|
-
|
|
488
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
489
|
-
<ul class="tsd-parameter-list">
|
|
490
|
-
<li>
|
|
491
|
-
<h5><span class="tsd-kind-parameter">policy</span>: <span class="tsd-signature-type ">RemovalPolicy</span></h5></li></ul></div>
|
|
492
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
493
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
494
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.applyRemovalPolicy</p></aside></li></ul></section>
|
|
495
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="configureAsyncInvoke" class="tsd-anchor"></a>
|
|
496
|
-
<h3 class="tsd-anchor-link"><span>configure<wbr/>Async<wbr/>Invoke</span><a href="#configureAsyncInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
497
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
498
|
-
<li class="tsd-signature tsd-anchor-link" id="configureAsyncInvoke.configureAsyncInvoke-1"><span class="tsd-kind-call-signature">configure<wbr/>Async<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#configureAsyncInvoke.configureAsyncInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
499
|
-
<li class="tsd-description">
|
|
500
|
-
<div class="tsd-parameters">
|
|
501
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
502
|
-
<ul class="tsd-parameter-list">
|
|
503
|
-
<li>
|
|
504
|
-
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">EventInvokeConfigOptions</span></h5></li></ul></div>
|
|
505
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
506
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.configureAsyncInvoke</p></aside></li></ul></section>
|
|
507
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="considerWarningOnInvokeFunctionPermissions" class="tsd-anchor"></a>
|
|
508
|
-
<h3 class="tsd-anchor-link"><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#considerWarningOnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
509
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
510
|
-
<li class="tsd-signature tsd-anchor-link" id="considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
511
|
-
<li class="tsd-description">
|
|
512
|
-
<div class="tsd-comment tsd-typography"><p>A warning will be added to functions under the following conditions:</p>
|
|
176
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">policy</span>: <span class="tsd-signature-type">RemovalPolicy</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.applyRemovalPolicy</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="configureasyncinvoke" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>configure<wbr/>Async<wbr/>Invoke</span><a href="#configureasyncinvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="configureasyncinvoke-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">configureAsyncInvoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventInvokeConfigOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#configureasyncinvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Configures options for asynchronous invocation.</p>
|
|
177
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EventInvokeConfigOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.configureAsyncInvoke</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="considerwarningoninvokefunctionpermissions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#considerwarningoninvokefunctionpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="considerwarningoninvokefunctionpermissions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">considerWarningOnInvokeFunctionPermissions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#considerwarningoninvokefunctionpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A warning will be added to functions under the following conditions:</p>
|
|
513
178
|
<ul>
|
|
514
179
|
<li>permissions that include <code>lambda:InvokeFunction</code> are added to the unqualified function.</li>
|
|
515
180
|
<li>function.currentVersion is invoked before or after the permission is created.</li>
|
|
516
181
|
</ul>
|
|
517
182
|
<p>This applies only to permissions on Lambda functions, not versions or aliases.
|
|
518
183
|
This function is overridden as a noOp for QualifiedFunctionBase.</p>
|
|
519
|
-
</div>
|
|
520
|
-
<
|
|
521
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
522
|
-
<ul class="tsd-parameter-list">
|
|
523
|
-
<li>
|
|
524
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
|
|
525
|
-
<li>
|
|
526
|
-
<h5><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
527
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
528
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
529
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.considerWarningOnInvokeFunctionPermissions</p></aside></li></ul></section>
|
|
530
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="generatePhysicalName" class="tsd-anchor"></a>
|
|
531
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>generate<wbr/>Physical<wbr/>Name</span><a href="#generatePhysicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
532
|
-
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
533
|
-
<li class="tsd-signature tsd-anchor-link" id="generatePhysicalName.generatePhysicalName-1"><span class="tsd-kind-call-signature">generate<wbr/>Physical<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generatePhysicalName.generatePhysicalName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
534
|
-
<li class="tsd-description">
|
|
535
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
536
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.generatePhysicalName</p></aside></li></ul></section>
|
|
537
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getResourceArnAttribute" class="tsd-anchor"></a>
|
|
538
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><a href="#getResourceArnAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
539
|
-
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
540
|
-
<li class="tsd-signature tsd-anchor-link" id="getResourceArnAttribute.getResourceArnAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arnAttr</span>, <span class="tsd-kind-parameter">arnComponents</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceArnAttribute.getResourceArnAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
541
|
-
<li class="tsd-description">
|
|
542
|
-
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
543
|
-
resource's "ARN" attribute (e.g. <code>bucket.bucketArn</code>).</p>
|
|
184
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li><li><span><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.considerWarningOnInvokeFunctionPermissions</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="generatephysicalname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>generate<wbr/>Physical<wbr/>Name</span><a href="#generatephysicalname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="generatephysicalname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generatePhysicalName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#generatephysicalname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.generatePhysicalName</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getresourcearnattribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><a href="#getresourcearnattribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getresourcearnattribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getResourceArnAttribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arnAttr</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">arnComponents</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArnComponents</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getresourcearnattribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
185
|
+
resource's "ARN" attribute (e.g. <code>bucket.bucketArn</code>).</p>
|
|
544
186
|
<p>Normally, this token will resolve to <code>arnAttr</code>, but if the resource is
|
|
545
187
|
referenced across environments, <code>arnComponents</code> will be used to synthesize
|
|
546
|
-
a concrete ARN with the resource
|
|
188
|
+
a concrete ARN with the resource's physical name. Make sure to reference
|
|
547
189
|
<code>this.physicalName</code> in <code>arnComponents</code>.</p>
|
|
548
|
-
</div>
|
|
549
|
-
<div class="tsd-parameters">
|
|
550
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
551
|
-
<ul class="tsd-parameter-list">
|
|
552
|
-
<li>
|
|
553
|
-
<h5><span class="tsd-kind-parameter">arnAttr</span>: <span class="tsd-signature-type">string</span></h5>
|
|
554
|
-
<div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the ARN of the resource.
|
|
190
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">arnAttr</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the ARN of the resource.
|
|
555
191
|
Commonly it will be called "Arn" (e.g. <code>resource.attrArn</code>), but sometimes
|
|
556
|
-
it
|
|
557
|
-
</div></li>
|
|
558
|
-
<li>
|
|
559
|
-
<h5><span class="tsd-kind-parameter">arnComponents</span>: <span class="tsd-signature-type ">ArnComponents</span></h5>
|
|
560
|
-
<div class="tsd-comment tsd-typography"><p>The format of the ARN of this resource. You must
|
|
192
|
+
it's the CFN resource's <code>ref</code>.</p>
|
|
193
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">arnComponents</span>: <span class="tsd-signature-type">ArnComponents</span></span><div class="tsd-comment tsd-typography"><p>The format of the ARN of this resource. You must
|
|
561
194
|
reference <code>this.physicalName</code> somewhere within the ARN in order for
|
|
562
195
|
cross-environment references to work.</p>
|
|
563
|
-
</div></li></ul></div>
|
|
564
|
-
|
|
565
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
566
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceArnAttribute</p></aside></li></ul></section>
|
|
567
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getResourceNameAttribute" class="tsd-anchor"></a>
|
|
568
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><a href="#getResourceNameAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
569
|
-
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
570
|
-
<li class="tsd-signature tsd-anchor-link" id="getResourceNameAttribute.getResourceNameAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAttr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceNameAttribute.getResourceNameAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
571
|
-
<li class="tsd-description">
|
|
572
|
-
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
573
|
-
resource's "name" attribute (e.g. <code>bucket.bucketName</code>).</p>
|
|
196
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.getResourceArnAttribute</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getresourcenameattribute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><a href="#getresourcenameattribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getresourcenameattribute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getResourceNameAttribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAttr</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getresourcenameattribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
197
|
+
resource's "name" attribute (e.g. <code>bucket.bucketName</code>).</p>
|
|
574
198
|
<p>Normally, this token will resolve to <code>nameAttr</code>, but if the resource is
|
|
575
199
|
referenced across environments, it will be resolved to <code>this.physicalName</code>,
|
|
576
200
|
which will be a concrete name.</p>
|
|
577
|
-
</div>
|
|
578
|
-
<
|
|
579
|
-
<h4 class="tsd-
|
|
580
|
-
|
|
581
|
-
<li>
|
|
582
|
-
|
|
583
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
584
|
-
|
|
585
|
-
</div></li></ul></div>
|
|
586
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
587
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
588
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceNameAttribute</p></aside></li></ul></section>
|
|
589
|
-
<section class="tsd-panel tsd-member"><a id="grantDeleteAsset" class="tsd-anchor"></a>
|
|
590
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Delete<wbr/>Asset</span><a href="#grantDeleteAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
591
|
-
<ul class="tsd-signatures">
|
|
592
|
-
<li class="tsd-signature tsd-anchor-link" id="grantDeleteAsset.grantDeleteAsset-1"><span class="tsd-kind-call-signature">grant<wbr/>Delete<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantDeleteAsset.grantDeleteAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
593
|
-
<li class="tsd-description">
|
|
594
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
595
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantInvoke" class="tsd-anchor"></a>
|
|
596
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke</span><a href="#grantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
597
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
598
|
-
<li class="tsd-signature tsd-anchor-link" id="grantInvoke.grantInvoke-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvoke.grantInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
599
|
-
<li class="tsd-description">
|
|
600
|
-
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda</p>
|
|
601
|
-
</div>
|
|
602
|
-
<div class="tsd-parameters">
|
|
603
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
604
|
-
<ul class="tsd-parameter-list">
|
|
605
|
-
<li>
|
|
606
|
-
<h5><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type ">IGrantable</span></h5></li></ul></div>
|
|
607
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4>
|
|
608
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
609
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvoke</p></aside></li></ul></section>
|
|
610
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantInvokeCompositePrincipal" class="tsd-anchor"></a>
|
|
611
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span><a href="#grantInvokeCompositePrincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
612
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
613
|
-
<li class="tsd-signature tsd-anchor-link" id="grantInvokeCompositePrincipal.grantInvokeCompositePrincipal-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">compositePrincipal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><span class="tsd-signature-symbol">[]</span><a href="#grantInvokeCompositePrincipal.grantInvokeCompositePrincipal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
614
|
-
<li class="tsd-description">
|
|
615
|
-
<div class="tsd-comment tsd-typography"><p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal</p>
|
|
616
|
-
</div>
|
|
617
|
-
<div class="tsd-parameters">
|
|
618
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
619
|
-
<ul class="tsd-parameter-list">
|
|
620
|
-
<li>
|
|
621
|
-
<h5><span class="tsd-kind-parameter">compositePrincipal</span>: <span class="tsd-signature-type ">CompositePrincipal</span></h5></li></ul></div>
|
|
622
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
623
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
624
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeCompositePrincipal</p></aside></li></ul></section>
|
|
625
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantInvokeUrl" class="tsd-anchor"></a>
|
|
626
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Url</span><a href="#grantInvokeUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
627
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
628
|
-
<li class="tsd-signature tsd-anchor-link" id="grantInvokeUrl.grantInvokeUrl-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvokeUrl.grantInvokeUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
629
|
-
<li class="tsd-description">
|
|
630
|
-
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda Function URL</p>
|
|
631
|
-
</div>
|
|
632
|
-
<div class="tsd-parameters">
|
|
633
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
634
|
-
<ul class="tsd-parameter-list">
|
|
635
|
-
<li>
|
|
636
|
-
<h5><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type ">IGrantable</span></h5></li></ul></div>
|
|
637
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4>
|
|
638
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
639
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeUrl</p></aside></li></ul></section>
|
|
640
|
-
<section class="tsd-panel tsd-member"><a id="grantReadAssets" class="tsd-anchor"></a>
|
|
641
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Read<wbr/>Assets</span><a href="#grantReadAssets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
642
|
-
<ul class="tsd-signatures">
|
|
643
|
-
<li class="tsd-signature tsd-anchor-link" id="grantReadAssets.grantReadAssets-1"><span class="tsd-kind-call-signature">grant<wbr/>Read<wbr/>Assets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantReadAssets.grantReadAssets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
644
|
-
<li class="tsd-description">
|
|
645
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
646
|
-
<section class="tsd-panel tsd-member"><a id="grantSendEmails" class="tsd-anchor"></a>
|
|
647
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Send<wbr/>Emails</span><a href="#grantSendEmails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
648
|
-
<ul class="tsd-signatures">
|
|
649
|
-
<li class="tsd-signature tsd-anchor-link" id="grantSendEmails.grantSendEmails-1"><span class="tsd-kind-call-signature">grant<wbr/>Send<wbr/>Emails</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantSendEmails.grantSendEmails-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
650
|
-
<li class="tsd-description">
|
|
651
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
652
|
-
<section class="tsd-panel tsd-member"><a id="grantTableWrite" class="tsd-anchor"></a>
|
|
653
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Table<wbr/>Write</span><a href="#grantTableWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
654
|
-
<ul class="tsd-signatures">
|
|
655
|
-
<li class="tsd-signature tsd-anchor-link" id="grantTableWrite.grantTableWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Table<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantTableWrite.grantTableWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
656
|
-
<li class="tsd-description">
|
|
657
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
658
|
-
<section class="tsd-panel tsd-member"><a id="grantUploadAssets" class="tsd-anchor"></a>
|
|
659
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Upload<wbr/>Assets</span><a href="#grantUploadAssets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
660
|
-
<ul class="tsd-signatures">
|
|
661
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUploadAssets.grantUploadAssets-1"><span class="tsd-kind-call-signature">grant<wbr/>Upload<wbr/>Assets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUploadAssets.grantUploadAssets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
662
|
-
<li class="tsd-description">
|
|
663
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
664
|
-
<section class="tsd-panel tsd-member"><a id="grantUserpoolRead" class="tsd-anchor"></a>
|
|
665
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read</span><a href="#grantUserpoolRead" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
666
|
-
<ul class="tsd-signatures">
|
|
667
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolRead.grantUserpoolRead-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolRead.grantUserpoolRead-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
668
|
-
<li class="tsd-description">
|
|
669
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
670
|
-
<section class="tsd-panel tsd-member"><a id="grantUserpoolReadWrite" class="tsd-anchor"></a>
|
|
671
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><a href="#grantUserpoolReadWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
672
|
-
<ul class="tsd-signatures">
|
|
673
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolReadWrite.grantUserpoolReadWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolReadWrite.grantUserpoolReadWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
674
|
-
<li class="tsd-description">
|
|
675
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
676
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="invalidateVersionBasedOn" class="tsd-anchor"></a>
|
|
677
|
-
<h3 class="tsd-anchor-link"><span>invalidate<wbr/>Version<wbr/>Based<wbr/>On</span><a href="#invalidateVersionBasedOn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
678
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
679
|
-
<li class="tsd-signature tsd-anchor-link" id="invalidateVersionBasedOn.invalidateVersionBasedOn-1"><span class="tsd-kind-call-signature">invalidate<wbr/>Version<wbr/>Based<wbr/>On</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#invalidateVersionBasedOn.invalidateVersionBasedOn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
680
|
-
<li class="tsd-description">
|
|
681
|
-
<div class="tsd-comment tsd-typography"><p>Mix additional information into the hash of the Version object</p>
|
|
201
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nameAttr</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the resource's name.
|
|
202
|
+
Commonly this is the resource's <code>ref</code>.</p>
|
|
203
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.getResourceNameAttribute</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="grantdeleteasset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Delete<wbr/>Asset</span><a href="#grantdeleteasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantdeleteasset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantDeleteAsset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantdeleteasset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantinvoke" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke</span><a href="#grantinvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="grantinvoke-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantInvoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGrantable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Grant</span><a href="#grantinvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda</p>
|
|
204
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantInvoke</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantinvokecompositeprincipal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span><a href="#grantinvokecompositeprincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="grantinvokecompositeprincipal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantInvokeCompositePrincipal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">compositePrincipal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CompositePrincipal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Grant</span><span class="tsd-signature-symbol">[]</span><a href="#grantinvokecompositeprincipal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal</p>
|
|
205
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">compositePrincipal</span>: <span class="tsd-signature-type">CompositePrincipal</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeCompositePrincipal</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantinvokelatestversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Latest<wbr/>Version</span><a href="#grantinvokelatestversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="grantinvokelatestversion-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantInvokeLatestVersion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGrantable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Grant</span><a href="#grantinvokelatestversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke the $LATEST version or
|
|
206
|
+
unqualified version of this Lambda</p>
|
|
207
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeLatestVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantinvokeurl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Url</span><a href="#grantinvokeurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="grantinvokeurl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantInvokeUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGrantable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Grant</span><a href="#grantinvokeurl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda Function URL</p>
|
|
208
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeUrl</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantinvokeversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Version</span><a href="#grantinvokeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="grantinvokeversion-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantInvokeVersion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGrantable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IVersion</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Grant</span><a href="#grantinvokeversion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke the given version of this Lambda</p>
|
|
209
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">IVersion</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeVersion</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="grantreadassets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Read<wbr/>Assets</span><a href="#grantreadassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantreadassets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantReadAssets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantreadassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="grantsendemails" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Send<wbr/>Emails</span><a href="#grantsendemails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantsendemails-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantSendEmails</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantsendemails-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="granttablewrite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Table<wbr/>Write</span><a href="#granttablewrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="granttablewrite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantTableWrite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#granttablewrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="grantuploadassets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Upload<wbr/>Assets</span><a href="#grantuploadassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantuploadassets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantUploadAssets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantuploadassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="grantuserpoolread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read</span><a href="#grantuserpoolread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantuserpoolread-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantUserpoolRead</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantuserpoolread-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="grantuserpoolreadwrite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><a href="#grantuserpoolreadwrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="grantuserpoolreadwrite-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">grantUserpoolReadWrite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantuserpoolreadwrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="invalidateversionbasedon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invalidate<wbr/>Version<wbr/>Based<wbr/>On</span><a href="#invalidateversionbasedon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="invalidateversionbasedon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">invalidateVersionBasedOn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#invalidateversionbasedon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mix additional information into the hash of the Version object</p>
|
|
682
210
|
<p>The Lambda Function construct does its best to automatically create a new
|
|
683
211
|
Version when anything about the Function changes (its code, its layers,
|
|
684
212
|
any of the other properties).</p>
|
|
@@ -690,250 +218,33 @@ should.</p>
|
|
|
690
218
|
any string into this method, and make sure the string changes when you know
|
|
691
219
|
a new Version needs to be created.</p>
|
|
692
220
|
<p>This method may be called more than once.</p>
|
|
693
|
-
</div>
|
|
694
|
-
|
|
695
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
696
|
-
<ul class="tsd-parameter-list">
|
|
697
|
-
<li>
|
|
698
|
-
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
699
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
700
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
701
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.invalidateVersionBasedOn</p></aside></li></ul></section>
|
|
702
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metric" class="tsd-anchor"></a>
|
|
703
|
-
<h3 class="tsd-anchor-link"><span>metric</span><a href="#metric" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
704
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
705
|
-
<li class="tsd-signature tsd-anchor-link" id="metric.metric-1"><span class="tsd-kind-call-signature">metric</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metric.metric-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
706
|
-
<li class="tsd-description">
|
|
707
|
-
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Function</p>
|
|
708
|
-
</div>
|
|
709
|
-
<div class="tsd-parameters">
|
|
710
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
711
|
-
<ul class="tsd-parameter-list">
|
|
712
|
-
<li>
|
|
713
|
-
<h5><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
714
|
-
<li>
|
|
715
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
716
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
717
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
718
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metric</p></aside></li></ul></section>
|
|
719
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricDuration" class="tsd-anchor"></a>
|
|
720
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Duration</span><a href="#metricDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
721
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
722
|
-
<li class="tsd-signature tsd-anchor-link" id="metricDuration.metricDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricDuration.metricDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
723
|
-
<li class="tsd-description">
|
|
724
|
-
<div class="tsd-comment tsd-typography"><p>How long execution of this Lambda takes</p>
|
|
221
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.invalidateVersionBasedOn</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metric" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metric</span><a href="#metric" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metric-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metric</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metric-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return the given named metric for this Function</p>
|
|
222
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metric</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricduration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metric<wbr/>Duration</span><a href="#metricduration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricduration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricDuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricduration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>How long execution of this Lambda takes</p>
|
|
725
223
|
<p>Average over 5 minutes</p>
|
|
726
|
-
</div>
|
|
727
|
-
<div class="tsd-parameters">
|
|
728
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
729
|
-
<ul class="tsd-parameter-list">
|
|
730
|
-
<li>
|
|
731
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
732
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
733
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
734
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricDuration</p></aside></li></ul></section>
|
|
735
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricErrors" class="tsd-anchor"></a>
|
|
736
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Errors</span><a href="#metricErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
737
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
738
|
-
<li class="tsd-signature tsd-anchor-link" id="metricErrors.metricErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricErrors.metricErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
739
|
-
<li class="tsd-description">
|
|
740
|
-
<div class="tsd-comment tsd-typography"><p>How many invocations of this Lambda fail</p>
|
|
224
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricDuration</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricerrors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metric<wbr/>Errors</span><a href="#metricerrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricerrors-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricErrors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricerrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>How many invocations of this Lambda fail</p>
|
|
741
225
|
<p>Sum over 5 minutes</p>
|
|
742
|
-
</div>
|
|
743
|
-
<div class="tsd-parameters">
|
|
744
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
745
|
-
<ul class="tsd-parameter-list">
|
|
746
|
-
<li>
|
|
747
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
748
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
749
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
750
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricErrors</p></aside></li></ul></section>
|
|
751
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricInvocations" class="tsd-anchor"></a>
|
|
752
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Invocations</span><a href="#metricInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
753
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
754
|
-
<li class="tsd-signature tsd-anchor-link" id="metricInvocations.metricInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricInvocations.metricInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
755
|
-
<li class="tsd-description">
|
|
756
|
-
<div class="tsd-comment tsd-typography"><p>How often this Lambda is invoked</p>
|
|
226
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricErrors</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricinvocations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metric<wbr/>Invocations</span><a href="#metricinvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricinvocations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricInvocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricinvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>How often this Lambda is invoked</p>
|
|
757
227
|
<p>Sum over 5 minutes</p>
|
|
758
|
-
</div>
|
|
759
|
-
<div class="tsd-parameters">
|
|
760
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
761
|
-
<ul class="tsd-parameter-list">
|
|
762
|
-
<li>
|
|
763
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
764
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
765
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
766
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricInvocations</p></aside></li></ul></section>
|
|
767
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricThrottles" class="tsd-anchor"></a>
|
|
768
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Throttles</span><a href="#metricThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
769
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
770
|
-
<li class="tsd-signature tsd-anchor-link" id="metricThrottles.metricThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricThrottles.metricThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
771
|
-
<li class="tsd-description">
|
|
772
|
-
<div class="tsd-comment tsd-typography"><p>How often this Lambda is throttled</p>
|
|
228
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricInvocations</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricthrottles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>metric<wbr/>Throttles</span><a href="#metricthrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricthrottles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricThrottles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricthrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>How often this Lambda is throttled</p>
|
|
773
229
|
<p>Sum over 5 minutes</p>
|
|
774
|
-
</div>
|
|
775
|
-
<div class="tsd-parameters">
|
|
776
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
777
|
-
<ul class="tsd-parameter-list">
|
|
778
|
-
<li>
|
|
779
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
780
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
781
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
782
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricThrottles</p></aside></li></ul></section>
|
|
783
|
-
<section class="tsd-panel tsd-member"><a id="setTable" class="tsd-anchor"></a>
|
|
784
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Table</span><a href="#setTable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
785
|
-
<ul class="tsd-signatures">
|
|
786
|
-
<li class="tsd-signature tsd-anchor-link" id="setTable.setTable-1"><span class="tsd-kind-call-signature">set<wbr/>Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">table</span>, <span class="tsd-kind-parameter">tableWrites</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTable.setTable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
787
|
-
<li class="tsd-description">
|
|
788
|
-
<div class="tsd-parameters">
|
|
789
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
790
|
-
<ul class="tsd-parameter-list">
|
|
791
|
-
<li>
|
|
792
|
-
<h5><span class="tsd-kind-parameter">table</span>: <span class="tsd-signature-type ">ITable</span></h5></li>
|
|
793
|
-
<li>
|
|
794
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tableWrites</span>: <span class="tsd-signature-type">boolean</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
795
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
796
|
-
<section class="tsd-panel tsd-member"><a id="setTimeout" class="tsd-anchor"></a>
|
|
797
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#setTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
798
|
-
<ul class="tsd-signatures">
|
|
799
|
-
<li class="tsd-signature tsd-anchor-link" id="setTimeout.setTimeout-1"><span class="tsd-kind-call-signature">set<wbr/>Timeout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTimeout.setTimeout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
800
|
-
<li class="tsd-description">
|
|
801
|
-
<div class="tsd-parameters">
|
|
802
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
803
|
-
<ul class="tsd-parameter-list">
|
|
804
|
-
<li>
|
|
805
|
-
<h5><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type ">Duration</span></h5></li></ul></div>
|
|
806
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
807
|
-
<section class="tsd-panel tsd-member"><a id="setUserPool" class="tsd-anchor"></a>
|
|
808
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Pool</span><a href="#setUserPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
809
|
-
<ul class="tsd-signatures">
|
|
810
|
-
<li class="tsd-signature tsd-anchor-link" id="setUserPool.setUserPool-1"><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Pool</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userPool</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setUserPool.setUserPool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
811
|
-
<li class="tsd-description">
|
|
812
|
-
<div class="tsd-parameters">
|
|
813
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
814
|
-
<ul class="tsd-parameter-list">
|
|
815
|
-
<li>
|
|
816
|
-
<h5><span class="tsd-kind-parameter">userPool</span>: <span class="tsd-signature-type ">IUserPool</span></h5></li></ul></div>
|
|
817
|
-
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
818
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>
|
|
819
|
-
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
820
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
821
|
-
<li class="tsd-signature tsd-anchor-link" id="toString.toString-1"><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
822
|
-
<li class="tsd-description">
|
|
823
|
-
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
824
|
-
</div>
|
|
825
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
826
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
827
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.toString</p></aside></li></ul></section>
|
|
828
|
-
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="warnInvokeFunctionPermissions" class="tsd-anchor"></a>
|
|
829
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#warnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
830
|
-
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
831
|
-
<li class="tsd-signature tsd-anchor-link" id="warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
832
|
-
<li class="tsd-description">
|
|
833
|
-
<div class="tsd-parameters">
|
|
834
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
835
|
-
<ul class="tsd-parameter-list">
|
|
836
|
-
<li>
|
|
837
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li></ul></div>
|
|
838
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
839
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.warnInvokeFunctionPermissions</p></aside></li></ul></section>
|
|
840
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="classifyVersionProperty" class="tsd-anchor"></a>
|
|
841
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>classify<wbr/>Version<wbr/>Property</span><a href="#classifyVersionProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
842
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
843
|
-
<li class="tsd-signature tsd-anchor-link" id="classifyVersionProperty.classifyVersionProperty-1"><span class="tsd-kind-call-signature">classify<wbr/>Version<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyName</span>, <span class="tsd-kind-parameter">locked</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#classifyVersionProperty.classifyVersionProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
844
|
-
<li class="tsd-description">
|
|
845
|
-
<div class="tsd-comment tsd-typography"><p>Record whether specific properties in the <code>AWS::Lambda::Function</code> resource should
|
|
230
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricThrottles</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="settable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Table</span><a href="#settable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="settable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setTable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">table</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ITable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">tableWrites</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#settable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">table</span>: <span class="tsd-signature-type">ITable</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">tableWrites</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="settimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#settimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="settimeout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setTimeout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Duration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#settimeout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">Duration</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="setuserpool" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Pool</span><a href="#setuserpool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setuserpool-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setUserPool</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userPool</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IUserPool</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setuserpool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userPool</span>: <span class="tsd-signature-type">IUserPool</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tostring" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="tostring-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toString</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#tostring-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
231
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.toString</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="warninvokefunctionpermissions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#warninvokefunctionpermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="warninvokefunctionpermissions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">warnInvokeFunctionPermissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#warninvokefunctionpermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.warnInvokeFunctionPermissions</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="classifyversionproperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>classify<wbr/>Version<wbr/>Property</span><a href="#classifyversionproperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="classifyversionproperty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">classifyVersionProperty</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">locked</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#classifyversionproperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Record whether specific properties in the <code>AWS::Lambda::Function</code> resource should
|
|
846
232
|
also be associated to the Version resource.
|
|
847
|
-
See
|
|
848
|
-
</div>
|
|
849
|
-
<div class="tsd-
|
|
850
|
-
|
|
851
|
-
<ul class="tsd-parameter-list">
|
|
852
|
-
<li>
|
|
853
|
-
<h5><span class="tsd-kind-parameter">propertyName</span>: <span class="tsd-signature-type">string</span></h5>
|
|
854
|
-
<div class="tsd-comment tsd-typography"><p>The property to classify</p>
|
|
855
|
-
</div></li>
|
|
856
|
-
<li>
|
|
857
|
-
<h5><span class="tsd-kind-parameter">locked</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
858
|
-
<div class="tsd-comment tsd-typography"><p>whether the property should be associated to the version or not.</p>
|
|
859
|
-
</div></li></ul></div>
|
|
860
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
861
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
862
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.classifyVersionProperty</p></aside></li></ul></section>
|
|
863
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionArn" class="tsd-anchor"></a>
|
|
864
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Arn</span><a href="#fromFunctionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
865
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
866
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionArn.fromFunctionArn-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Arn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionArn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionArn.fromFunctionArn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
867
|
-
<li class="tsd-description">
|
|
868
|
-
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its ARN.</p>
|
|
233
|
+
See 'currentVersion' section in the module README for more details.</p>
|
|
234
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property to classify</p>
|
|
235
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">locked</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>whether the property should be associated to the version or not.</p>
|
|
236
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.classifyVersionProperty</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromfunctionarn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Function<wbr/>Arn</span><a href="#fromfunctionarn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromfunctionarn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromFunctionArn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">functionArn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IFunction</span><a href="#fromfunctionarn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its ARN.</p>
|
|
869
237
|
<p>For <code>Function.addPermissions()</code> to work on this imported lambda, make sure that is
|
|
870
238
|
in the same account and region as the stack you are importing it into.</p>
|
|
871
|
-
</div>
|
|
872
|
-
<div class="tsd-parameters">
|
|
873
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
874
|
-
<ul class="tsd-parameter-list">
|
|
875
|
-
<li>
|
|
876
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
|
|
877
|
-
<li>
|
|
878
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
879
|
-
<li>
|
|
880
|
-
<h5><span class="tsd-kind-parameter">functionArn</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
881
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
882
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
883
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionArn</p></aside></li></ul></section>
|
|
884
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionAttributes" class="tsd-anchor"></a>
|
|
885
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Attributes</span><a href="#fromFunctionAttributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
886
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
887
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionAttributes.fromFunctionAttributes-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Attributes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">attrs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionAttributes.fromFunctionAttributes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
888
|
-
<li class="tsd-description">
|
|
889
|
-
<div class="tsd-comment tsd-typography"><p>Creates a Lambda function object which represents a function not defined
|
|
239
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">functionArn</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionArn</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromfunctionattributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Function<wbr/>Attributes</span><a href="#fromfunctionattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromfunctionattributes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromFunctionAttributes</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">attrs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FunctionAttributes</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IFunction</span><a href="#fromfunctionattributes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a Lambda function object which represents a function not defined
|
|
890
240
|
within this stack.</p>
|
|
891
241
|
<p>For <code>Function.addPermissions()</code> to work on this imported lambda, set the sameEnvironment property to true
|
|
892
242
|
if this imported lambda is in the same account and region as the stack you are importing it into.</p>
|
|
893
|
-
</div>
|
|
894
|
-
<div class="tsd-
|
|
895
|
-
<
|
|
896
|
-
<ul class="tsd-parameter-
|
|
897
|
-
<li>
|
|
898
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
|
|
899
|
-
<div class="tsd-comment tsd-typography"><p>The parent construct</p>
|
|
900
|
-
</div></li>
|
|
901
|
-
<li>
|
|
902
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
|
|
903
|
-
<div class="tsd-comment tsd-typography"><p>The name of the lambda construct</p>
|
|
904
|
-
</div></li>
|
|
905
|
-
<li>
|
|
906
|
-
<h5><span class="tsd-kind-parameter">attrs</span>: <span class="tsd-signature-type ">FunctionAttributes</span></h5>
|
|
907
|
-
<div class="tsd-comment tsd-typography"><p>the attributes of the function to import</p>
|
|
908
|
-
</div></li></ul></div>
|
|
909
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
910
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
911
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionAttributes</p></aside></li></ul></section>
|
|
912
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionName" class="tsd-anchor"></a>
|
|
913
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Name</span><a href="#fromFunctionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
914
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
915
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionName.fromFunctionName-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionName.fromFunctionName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
916
|
-
<li class="tsd-description">
|
|
917
|
-
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its name</p>
|
|
918
|
-
</div>
|
|
919
|
-
<div class="tsd-parameters">
|
|
920
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
921
|
-
<ul class="tsd-parameter-list">
|
|
922
|
-
<li>
|
|
923
|
-
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
|
|
924
|
-
<li>
|
|
925
|
-
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
926
|
-
<li>
|
|
927
|
-
<h5><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
928
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
929
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
930
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionName</p></aside></li></ul></section>
|
|
931
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
932
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
933
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
934
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
935
|
-
<li class="tsd-description">
|
|
936
|
-
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
243
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span><div class="tsd-comment tsd-typography"><p>The parent construct</p>
|
|
244
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the lambda construct</p>
|
|
245
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">attrs</span>: <span class="tsd-signature-type">FunctionAttributes</span></span><div class="tsd-comment tsd-typography"><p>the attributes of the function to import</p>
|
|
246
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionAttributes</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromfunctionname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Function<wbr/>Name</span><a href="#fromfunctionname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromfunctionname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromFunctionName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Construct</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">functionName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IFunction</span><a href="#fromfunctionname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its name</p>
|
|
247
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionName</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isconstruct" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>is<wbr/>Construct</span><a href="#isconstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="isconstruct-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isConstruct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span><a href="#isconstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
937
248
|
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
938
249
|
instances, even when the construct library is symlinked.</p>
|
|
939
250
|
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
@@ -946,290 +257,33 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
|
|
|
946
257
|
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
947
258
|
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
948
259
|
this type-testing method instead.</p>
|
|
949
|
-
</div>
|
|
950
|
-
|
|
951
|
-
<
|
|
952
|
-
|
|
953
|
-
<li>
|
|
954
|
-
<
|
|
955
|
-
<div class="tsd-comment tsd-typography"><
|
|
956
|
-
</
|
|
957
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
260
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
261
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
262
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.isConstruct</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isownedresource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>is<wbr/>Owned<wbr/>Resource</span><a href="#isownedresource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="isownedresource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isOwnedResource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isownedresource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the construct was created by CDK, and false otherwise</p>
|
|
263
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.isOwnedResource</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isresource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>is<wbr/>Resource</span><a href="#isresource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="isresource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isResource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">construct</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Resource</span><a href="#isresource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check whether the given construct is a Resource</p>
|
|
264
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">construct</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-type">Resource</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.isResource</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All</span><a href="#metricall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAll</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return the given named metric for this Lambda</p>
|
|
265
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAll</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallconcurrentexecutions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><a href="#metricallconcurrentexecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallconcurrentexecutions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllConcurrentExecutions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallconcurrentexecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the number of concurrent executions across all Lambdas</p>
|
|
266
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default" class="tsd-anchor"></a>Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
267
|
+
</code><button type="button">Copy</button></pre>
|
|
958
268
|
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
</div>
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
<li>
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
<
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
<li class="tsd-signature tsd-anchor-link" id="isResource.isResource-1"><span class="tsd-kind-call-signature">is<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span><a href="#isResource.isResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
980
|
-
<li class="tsd-description">
|
|
981
|
-
<div class="tsd-comment tsd-typography"><p>Check whether the given construct is a Resource</p>
|
|
982
|
-
</div>
|
|
983
|
-
<div class="tsd-parameters">
|
|
984
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
985
|
-
<ul class="tsd-parameter-list">
|
|
986
|
-
<li>
|
|
987
|
-
<h5><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type ">IConstruct</span></h5></li></ul></div>
|
|
988
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span></h4>
|
|
989
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
990
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.isResource</p></aside></li></ul></section>
|
|
991
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAll" class="tsd-anchor"></a>
|
|
992
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All</span><a href="#metricAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
993
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
994
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAll.metricAll-1"><span class="tsd-kind-call-signature">metric<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAll.metricAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
995
|
-
<li class="tsd-description">
|
|
996
|
-
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Lambda</p>
|
|
997
|
-
</div>
|
|
998
|
-
<div class="tsd-parameters">
|
|
999
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1000
|
-
<ul class="tsd-parameter-list">
|
|
1001
|
-
<li>
|
|
1002
|
-
<h5><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
1003
|
-
<li>
|
|
1004
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1005
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1006
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1007
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAll</p></aside></li></ul></section>
|
|
1008
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllConcurrentExecutions" class="tsd-anchor"></a>
|
|
1009
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1010
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1011
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllConcurrentExecutions.metricAllConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllConcurrentExecutions.metricAllConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1012
|
-
<li class="tsd-description">
|
|
1013
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the number of concurrent executions across all Lambdas</p>
|
|
1014
|
-
</div>
|
|
1015
|
-
<div class="tsd-parameters">
|
|
1016
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1017
|
-
<ul class="tsd-parameter-list">
|
|
1018
|
-
<li>
|
|
1019
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1020
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1021
|
-
<div class="tsd-comment tsd-typography">
|
|
1022
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1023
|
-
</code><button>Copy</button></pre>
|
|
1024
|
-
</div><aside class="tsd-sources">
|
|
1025
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllConcurrentExecutions</p></aside></li></ul></section>
|
|
1026
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllDuration" class="tsd-anchor"></a>
|
|
1027
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Duration</span><a href="#metricAllDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1028
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1029
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllDuration.metricAllDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllDuration.metricAllDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1030
|
-
<li class="tsd-description">
|
|
1031
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the Duration executing all Lambdas</p>
|
|
1032
|
-
</div>
|
|
1033
|
-
<div class="tsd-parameters">
|
|
1034
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1035
|
-
<ul class="tsd-parameter-list">
|
|
1036
|
-
<li>
|
|
1037
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1038
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1039
|
-
<div class="tsd-comment tsd-typography">
|
|
1040
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">average</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1041
|
-
</code><button>Copy</button></pre>
|
|
1042
|
-
</div><aside class="tsd-sources">
|
|
1043
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllDuration</p></aside></li></ul></section>
|
|
1044
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllErrors" class="tsd-anchor"></a>
|
|
1045
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Errors</span><a href="#metricAllErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1046
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1047
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllErrors.metricAllErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllErrors.metricAllErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1048
|
-
<li class="tsd-description">
|
|
1049
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the number of Errors executing all Lambdas</p>
|
|
1050
|
-
</div>
|
|
1051
|
-
<div class="tsd-parameters">
|
|
1052
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1053
|
-
<ul class="tsd-parameter-list">
|
|
1054
|
-
<li>
|
|
1055
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1056
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1057
|
-
<div class="tsd-comment tsd-typography">
|
|
1058
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1059
|
-
</code><button>Copy</button></pre>
|
|
1060
|
-
</div><aside class="tsd-sources">
|
|
1061
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllErrors</p></aside></li></ul></section>
|
|
1062
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllInvocations" class="tsd-anchor"></a>
|
|
1063
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Invocations</span><a href="#metricAllInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1064
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1065
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllInvocations.metricAllInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllInvocations.metricAllInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1066
|
-
<li class="tsd-description">
|
|
1067
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the number of invocations of all Lambdas</p>
|
|
1068
|
-
</div>
|
|
1069
|
-
<div class="tsd-parameters">
|
|
1070
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1071
|
-
<ul class="tsd-parameter-list">
|
|
1072
|
-
<li>
|
|
1073
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1074
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1075
|
-
<div class="tsd-comment tsd-typography">
|
|
1076
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1077
|
-
</code><button>Copy</button></pre>
|
|
1078
|
-
</div><aside class="tsd-sources">
|
|
1079
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllInvocations</p></aside></li></ul></section>
|
|
1080
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllThrottles" class="tsd-anchor"></a>
|
|
1081
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Throttles</span><a href="#metricAllThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1082
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1083
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllThrottles.metricAllThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllThrottles.metricAllThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1084
|
-
<li class="tsd-description">
|
|
1085
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the number of throttled invocations of all Lambdas</p>
|
|
1086
|
-
</div>
|
|
1087
|
-
<div class="tsd-parameters">
|
|
1088
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1089
|
-
<ul class="tsd-parameter-list">
|
|
1090
|
-
<li>
|
|
1091
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1092
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1093
|
-
<div class="tsd-comment tsd-typography">
|
|
1094
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1095
|
-
</code><button>Copy</button></pre>
|
|
1096
|
-
</div><aside class="tsd-sources">
|
|
1097
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllThrottles</p></aside></li></ul></section>
|
|
1098
|
-
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllUnreservedConcurrentExecutions" class="tsd-anchor"></a>
|
|
1099
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllUnreservedConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1100
|
-
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1101
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1102
|
-
<li class="tsd-description">
|
|
1103
|
-
<div class="tsd-comment tsd-typography"><p>Metric for the number of unreserved concurrent executions across all Lambdas</p>
|
|
1104
|
-
</div>
|
|
1105
|
-
<div class="tsd-parameters">
|
|
1106
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1107
|
-
<ul class="tsd-parameter-list">
|
|
1108
|
-
<li>
|
|
1109
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
|
|
1110
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1111
|
-
<div class="tsd-comment tsd-typography">
|
|
1112
|
-
<h4>Default</h4><pre><code class="language-ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
1113
|
-
</code><button>Copy</button></pre>
|
|
1114
|
-
</div><aside class="tsd-sources">
|
|
1115
|
-
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></li></ul></section></section></div>
|
|
1116
|
-
<div class="col-sidebar">
|
|
1117
|
-
<div class="page-menu">
|
|
1118
|
-
<div class="tsd-navigation settings">
|
|
1119
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1120
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
1121
|
-
<div class="tsd-accordion-details">
|
|
1122
|
-
<div class="tsd-filter-visibility">
|
|
1123
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1124
|
-
<ul id="tsd-filter-options">
|
|
1125
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
1126
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
1127
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
1128
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
1129
|
-
<div class="tsd-theme-toggle">
|
|
1130
|
-
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1131
|
-
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1132
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1133
|
-
<div class="tsd-accordion-details">
|
|
1134
|
-
<ul>
|
|
1135
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
1136
|
-
<li><a href="#architecture" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>architecture</span></a></li>
|
|
1137
|
-
<li><a href="#canCreatePermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a></li>
|
|
1138
|
-
<li><a href="#deadLetterQueue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue</span></a></li>
|
|
1139
|
-
<li><a href="#deadLetterTopic" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic</span></a></li>
|
|
1140
|
-
<li><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>env</span></a></li>
|
|
1141
|
-
<li><a href="#functionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Arn</span></a></li>
|
|
1142
|
-
<li><a href="#functionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Name</span></a></li>
|
|
1143
|
-
<li><a href="#grantPrincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>grant<wbr/>Principal</span></a></li>
|
|
1144
|
-
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a></li>
|
|
1145
|
-
<li><a href="#permissionsNode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a></li>
|
|
1146
|
-
<li><a href="#physicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>physical<wbr/>Name</span></a></li>
|
|
1147
|
-
<li><a href="#props" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a></li>
|
|
1148
|
-
<li><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>role</span></a></li>
|
|
1149
|
-
<li><a href="#runtime" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>runtime</span></a></li>
|
|
1150
|
-
<li><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stack</span></a></li>
|
|
1151
|
-
<li><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>timeout</span></a></li>
|
|
1152
|
-
<li><a href="#connections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>connections</span></a></li>
|
|
1153
|
-
<li><a href="#currentVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>current<wbr/>Version</span></a></li>
|
|
1154
|
-
<li><a href="#isBoundToVpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span></a></li>
|
|
1155
|
-
<li><a href="#latestVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>latest<wbr/>Version</span></a></li>
|
|
1156
|
-
<li><a href="#logGroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>log<wbr/>Group</span></a></li>
|
|
1157
|
-
<li><a href="#resourceArnsForGrantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a></li>
|
|
1158
|
-
<li><a href="#addAlias" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Alias</span></a></li>
|
|
1159
|
-
<li><a href="#addEnvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Environment</span></a></li>
|
|
1160
|
-
<li><a href="#addEventSource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a></li>
|
|
1161
|
-
<li><a href="#addEventSourceMapping" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a></li>
|
|
1162
|
-
<li><a href="#addFunctionUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Function<wbr/>Url</span></a></li>
|
|
1163
|
-
<li><a href="#addLayers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Layers</span></a></li>
|
|
1164
|
-
<li><a href="#addPermission" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Permission</span></a></li>
|
|
1165
|
-
<li><a href="#addToRolePolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a></li>
|
|
1166
|
-
<li><a href="#applyRemovalPolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a></li>
|
|
1167
|
-
<li><a href="#configureAsyncInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a></li>
|
|
1168
|
-
<li><a href="#considerWarningOnInvokeFunctionPermissions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a></li>
|
|
1169
|
-
<li><a href="#generatePhysicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>generate<wbr/>Physical<wbr/>Name</span></a></li>
|
|
1170
|
-
<li><a href="#getResourceArnAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span></a></li>
|
|
1171
|
-
<li><a href="#getResourceNameAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a></li>
|
|
1172
|
-
<li><a href="#grantDeleteAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Delete<wbr/>Asset</span></a></li>
|
|
1173
|
-
<li><a href="#grantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke</span></a></li>
|
|
1174
|
-
<li><a href="#grantInvokeCompositePrincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span></a></li>
|
|
1175
|
-
<li><a href="#grantInvokeUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Url</span></a></li>
|
|
1176
|
-
<li><a href="#grantReadAssets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Read<wbr/>Assets</span></a></li>
|
|
1177
|
-
<li><a href="#grantSendEmails" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a></li>
|
|
1178
|
-
<li><a href="#grantTableWrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a></li>
|
|
1179
|
-
<li><a href="#grantUploadAssets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a></li>
|
|
1180
|
-
<li><a href="#grantUserpoolRead" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a></li>
|
|
1181
|
-
<li><a href="#grantUserpoolReadWrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span></a></li>
|
|
1182
|
-
<li><a href="#invalidateVersionBasedOn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>invalidate<wbr/>Version<wbr/>Based<wbr/>On</span></a></li>
|
|
1183
|
-
<li><a href="#metric" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric</span></a></li>
|
|
1184
|
-
<li><a href="#metricDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Duration</span></a></li>
|
|
1185
|
-
<li><a href="#metricErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Errors</span></a></li>
|
|
1186
|
-
<li><a href="#metricInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Invocations</span></a></li>
|
|
1187
|
-
<li><a href="#metricThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a></li>
|
|
1188
|
-
<li><a href="#setTable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Table</span></a></li>
|
|
1189
|
-
<li><a href="#setTimeout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a></li>
|
|
1190
|
-
<li><a href="#setUserPool" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Pool</span></a></li>
|
|
1191
|
-
<li><a href="#toString" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a></li>
|
|
1192
|
-
<li><a href="#warnInvokeFunctionPermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a></li>
|
|
1193
|
-
<li><a href="#classifyVersionProperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>classify<wbr/>Version<wbr/>Property</span></a></li>
|
|
1194
|
-
<li><a href="#fromFunctionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Arn</span></a></li>
|
|
1195
|
-
<li><a href="#fromFunctionAttributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Attributes</span></a></li>
|
|
1196
|
-
<li><a href="#fromFunctionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Name</span></a></li>
|
|
1197
|
-
<li><a href="#isConstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Construct</span></a></li>
|
|
1198
|
-
<li><a href="#isOwnedResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a></li>
|
|
1199
|
-
<li><a href="#isResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Resource</span></a></li>
|
|
1200
|
-
<li><a href="#metricAll" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All</span></a></li>
|
|
1201
|
-
<li><a href="#metricAllConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span></a></li>
|
|
1202
|
-
<li><a href="#metricAllDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Duration</span></a></li>
|
|
1203
|
-
<li><a href="#metricAllErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Errors</span></a></li>
|
|
1204
|
-
<li><a href="#metricAllInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a></li>
|
|
1205
|
-
<li><a href="#metricAllThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a></li>
|
|
1206
|
-
<li><a href="#metricAllUnreservedConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a></li></ul></div></details></div>
|
|
1207
|
-
<div class="site-menu">
|
|
1208
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
1209
|
-
<ul class="tsd-small-nested-navigation">
|
|
1210
|
-
<li><a href="AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
|
|
1211
|
-
<li><a href="BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
|
|
1212
|
-
<li><a href="CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
|
|
1213
|
-
<li><a href="GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
1214
|
-
<li><a href="LambdaFunction.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
|
|
1215
|
-
<li><a href="RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
1216
|
-
<li><a href="SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
1217
|
-
<li><a href="Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
1218
|
-
<li><a href="../interfaces/AssetCdnProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
|
|
1219
|
-
<li><a href="../interfaces/BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
|
|
1220
|
-
<li><a href="../interfaces/CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
|
|
1221
|
-
<li><a href="../interfaces/GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
|
|
1222
|
-
<li><a href="../interfaces/ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
1223
|
-
<li><a href="../interfaces/IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
1224
|
-
<li><a href="../interfaces/JsResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Js<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
1225
|
-
<li><a href="../interfaces/LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
|
|
1226
|
-
<li><a href="../interfaces/LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
|
|
1227
|
-
<li><a href="../interfaces/RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
|
|
1228
|
-
<li><a href="../interfaces/SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
|
|
1229
|
-
<li><a href="../interfaces/SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
|
|
1230
|
-
<li><a href="../interfaces/VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
1231
|
-
<li><a href="../interfaces/WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
|
|
1232
|
-
<li><a href="../types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
|
|
1233
|
-
<div class="tsd-generator">
|
|
1234
|
-
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
|
|
1235
|
-
<div class="overlay"></div></body></html>
|
|
269
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllConcurrentExecutions</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallduration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Duration</span><a href="#metricallduration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallduration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllDuration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallduration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the Duration executing all Lambdas</p>
|
|
270
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-1" class="tsd-anchor"></a>Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">average</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
271
|
+
</code><button type="button">Copy</button></pre>
|
|
272
|
+
|
|
273
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllDuration</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallerrors" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Errors</span><a href="#metricallerrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallerrors-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllErrors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallerrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the number of Errors executing all Lambdas</p>
|
|
274
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-2" class="tsd-anchor"></a>Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
275
|
+
</code><button type="button">Copy</button></pre>
|
|
276
|
+
|
|
277
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllErrors</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallinvocations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Invocations</span><a href="#metricallinvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallinvocations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllInvocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallinvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the number of invocations of all Lambdas</p>
|
|
278
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-3" class="tsd-anchor"></a>Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
279
|
+
</code><button type="button">Copy</button></pre>
|
|
280
|
+
|
|
281
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllInvocations</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallthrottles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Throttles</span><a href="#metricallthrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallthrottles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllThrottles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallthrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the number of throttled invocations of all Lambdas</p>
|
|
282
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-4" class="tsd-anchor"></a>Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">sum</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
283
|
+
</code><button type="button">Copy</button></pre>
|
|
284
|
+
|
|
285
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllThrottles</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricallunreservedconcurrentexecutions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><a href="#metricallunreservedconcurrentexecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="metricallunreservedconcurrentexecutions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">metricAllUnreservedConcurrentExecutions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MetricOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Metric</span><a href="#metricallunreservedconcurrentexecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Metric for the number of unreserved concurrent executions across all Lambdas</p>
|
|
286
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">MetricOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default-5" class="tsd-anchor"></a>Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">max</span><span class="hl-1"> </span><span class="hl-4">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
287
|
+
</code><button type="button">Copy</button></pre>
|
|
288
|
+
|
|
289
|
+
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#architecture" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>architecture</span></a><a href="#cancreatepermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a><a href="#deadletterqueue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue</span></a><a href="#deadlettertopic" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic</span></a><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>env</span></a><a href="#functionarn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>function<wbr/>Arn</span></a><a href="#functionname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>function<wbr/>Name</span></a><a href="#grantprincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>grant<wbr/>Principal</span></a><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>node</span></a><a href="#permissionsnode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a><a href="#physicalname" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>physical<wbr/>Name</span></a><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a><a href="#runtime" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack</span></a><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#connections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>connections</span></a><a href="#currentversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>current<wbr/>Version</span></a><a href="#isboundtovpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span></a><a href="#latestversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>latest<wbr/>Version</span></a><a href="#loggroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>log<wbr/>Group</span></a><a href="#resourcearnsforgrantinvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addalias" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Alias</span></a><a href="#addenvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Environment</span></a><a href="#addeventsource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a><a href="#addeventsourcemapping" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a><a href="#addfunctionurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Function<wbr/>Url</span></a><a href="#addlayers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Layers</span></a><a href="#addpermission" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Permission</span></a><a href="#addtorolepolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a><a href="#applyremovalpolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a><a href="#configureasyncinvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a><a href="#considerwarningoninvokefunctionpermissions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a><a href="#generatephysicalname" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Physical<wbr/>Name</span></a><a href="#getresourcearnattribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span></a><a href="#getresourcenameattribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a><a href="#grantdeleteasset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Delete<wbr/>Asset</span></a><a href="#grantinvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke</span></a><a href="#grantinvokecompositeprincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Composite<wbr/>Principal</span></a><a href="#grantinvokelatestversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Latest<wbr/>Version</span></a><a href="#grantinvokeurl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Url</span></a><a href="#grantinvokeversion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Version</span></a><a href="#grantreadassets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Read<wbr/>Assets</span></a><a href="#grantsendemails" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a><a href="#granttablewrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a><a href="#grantuploadassets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a><a href="#grantuserpoolread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a><a href="#grantuserpoolreadwrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span></a><a href="#invalidateversionbasedon" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invalidate<wbr/>Version<wbr/>Based<wbr/>On</span></a><a href="#metric" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric</span></a><a href="#metricduration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Duration</span></a><a href="#metricerrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Errors</span></a><a href="#metricinvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Invocations</span></a><a href="#metricthrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a><a href="#settable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Table</span></a><a href="#settimeout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a><a href="#setuserpool" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Pool</span></a><a href="#tostring" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a><a href="#warninvokefunctionpermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a><a href="#classifyversionproperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>classify<wbr/>Version<wbr/>Property</span></a><a href="#fromfunctionarn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Arn</span></a><a href="#fromfunctionattributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Attributes</span></a><a href="#fromfunctionname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Name</span></a><a href="#isconstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Construct</span></a><a href="#isownedresource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a><a href="#isresource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Resource</span></a><a href="#metricall" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All</span></a><a href="#metricallconcurrentexecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span></a><a href="#metricallduration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Duration</span></a><a href="#metricallerrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Errors</span></a><a href="#metricallinvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a><a href="#metricallthrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a><a href="#metricallunreservedconcurrentexecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|