cdk-serverless 3.3.2 → 3.4.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/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
- package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
- package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
- package/docs/constructs/assets/hierarchy.js +1 -1
- package/docs/constructs/assets/highlight.css +1 -1
- package/docs/constructs/assets/main.js +1 -1
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +18 -3
- package/docs/constructs/classes/AssetCdn.html +161 -20
- package/docs/constructs/classes/BaseApi.html +153 -13
- package/docs/constructs/classes/CognitoAuthentication.html +188 -22
- package/docs/constructs/classes/GraphQlApi.html +349 -23
- package/docs/constructs/classes/LambdaFunction.html +1074 -106
- package/docs/constructs/classes/McpAuth.html +152 -16
- package/docs/constructs/classes/McpCognitoAuth.html +152 -16
- package/docs/constructs/classes/RestApi.html +344 -37
- package/docs/constructs/classes/SingleTableDatastore.html +173 -19
- package/docs/constructs/classes/Workflow.html +170 -21
- package/docs/constructs/hierarchy.html +47 -1
- package/docs/constructs/index.html +75 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
- package/docs/constructs/interfaces/BaseApiProps.html +141 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
- package/docs/constructs/interfaces/GraphQlApiProps.html +185 -22
- package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
- package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
- package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
- package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
- package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
- package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
- package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
- package/docs/constructs/interfaces/McpAuthProps.html +123 -18
- package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
- package/docs/constructs/interfaces/RestApiProps.html +237 -37
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
- package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
- package/docs/constructs/interfaces/WorkflowProps.html +63 -2
- package/docs/constructs/modules.html +44 -1
- package/docs/constructs/types/LambdaOptions.html +31 -1
- package/docs/experiments/appsync-unit-resolver-error-probe.md +201 -0
- package/docs/lambda/assets/hierarchy.js +1 -1
- package/docs/lambda/assets/highlight.css +1 -1
- package/docs/lambda/assets/main.js +1 -1
- package/docs/lambda/assets/navigation.js +1 -1
- package/docs/lambda/assets/search.js +1 -1
- package/docs/lambda/assets/style.css +18 -3
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
- package/docs/lambda/classes/errors.BadRequestError.html +147 -11
- package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
- package/docs/lambda/classes/errors.HttpError.html +154 -12
- package/docs/lambda/classes/errors.NotFoundError.html +147 -11
- package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
- package/docs/lambda/classes/errors.appsync.AppSyncError.html +193 -0
- package/docs/lambda/classes/errors.appsync.ConflictError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ForbiddenError.html +184 -0
- package/docs/lambda/classes/errors.appsync.NotFoundError.html +184 -0
- package/docs/lambda/classes/errors.appsync.ValidationError.html +184 -0
- package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
- package/docs/lambda/functions/api.createHttpHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
- package/docs/lambda/hierarchy.html +59 -1
- package/docs/lambda/index.html +75 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
- package/docs/lambda/interfaces/api.Operation.html +61 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
- package/docs/lambda/modules/api.html +45 -1
- package/docs/lambda/modules/auth.html +37 -1
- package/docs/lambda/modules/errors.appsync.html +38 -0
- package/docs/lambda/modules/errors.html +41 -1
- package/docs/lambda/modules.html +36 -1
- package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
- package/docs/lambda/types/api.AppSyncHandler.html +51 -2
- package/docs/lambda/types/api.HttpHandler.html +52 -2
- package/docs/projen/assets/highlight.css +5 -12
- package/docs/projen/assets/main.js +1 -1
- package/docs/projen/assets/style.css +18 -3
- package/docs/projen/classes/Datastore.html +254 -18
- package/docs/projen/classes/GraphQlApi.html +238 -18
- package/docs/projen/classes/RestApi.html +325 -40
- package/docs/projen/classes/ServerlessProject.html +1021 -159
- package/docs/projen/classes/Workflow.html +288 -31
- package/docs/projen/hierarchy.html +29 -1
- package/docs/projen/index.html +75 -2
- package/docs/projen/interfaces/DatastoreOptions.html +54 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
- package/docs/projen/interfaces/RestApiOptions.html +54 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
- package/docs/projen/interfaces/WorkflowOptions.html +54 -2
- package/docs/projen/modules.html +44 -1
- package/docs/projen/variables/PACKAGE_NAME.html +31 -1
- package/lib/constructs/graphql.d.ts +17 -0
- package/lib/constructs/graphql.js +78 -2
- package/lib/lambda/appsync-errors.d.ts +67 -0
- package/lib/lambda/appsync-errors.js +91 -0
- package/lib/lambda/errors.d.ts +1 -0
- package/lib/lambda/errors.js +36 -2
- package/lib/lambda/handler.js +78 -1
- package/llm.md +31 -0
- package/package.json +26 -24
|
@@ -1,12 +1,45 @@
|
|
|
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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">LambdaFunction</a></li></ul>
|
|
12
|
+
<h1>Class LambdaFunction</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<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.
|
|
2
15
|
This construct facilitates setting up a Lambda function with various custom options, environment variables, and permissions required to interact with AWS services
|
|
3
16
|
such as DynamoDB, Cognito, and S3. It supports setting up Lambda functions with pre-defined bundles, custom handlers, and integrations with AWS services.
|
|
4
17
|
The construct also provides methods to dynamically update the configuration and permissions of the Lambda function after it has been created.</p>
|
|
5
|
-
</div
|
|
18
|
+
</div>
|
|
19
|
+
<div class="tsd-comment tsd-typography">
|
|
20
|
+
<div class="tsd-tag-example">
|
|
21
|
+
<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">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-9">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
22
|
</code><button type="button">Copy</button></pre>
|
|
7
23
|
|
|
8
|
-
</div></div></section
|
|
9
|
-
|
|
24
|
+
</div></div></section>
|
|
25
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="129">
|
|
26
|
+
<h4>Hierarchy</h4>
|
|
27
|
+
<ul class="tsd-hierarchy">
|
|
28
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">NodejsFunction</span>
|
|
29
|
+
<ul class="tsd-hierarchy">
|
|
30
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LambdaFunction</span></li></ul></li></ul></section>
|
|
31
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
32
|
+
<section class="tsd-panel tsd-index-panel">
|
|
33
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
34
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
35
|
+
<div class="tsd-accordion-details">
|
|
36
|
+
<section class="tsd-index-section">
|
|
37
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
38
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
39
|
+
</div></section>
|
|
40
|
+
<section class="tsd-index-section">
|
|
41
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
|
+
<div class="tsd-index-list"><a href="#architecture" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>architecture</span></a>
|
|
10
43
|
<a href="#cancreatepermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a>
|
|
11
44
|
<a href="#deadletterqueue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue?</span></a>
|
|
12
45
|
<a href="#deadlettertopic" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic?</span></a>
|
|
@@ -18,7 +51,10 @@ The construct also provides methods to dynamically update the configuration and
|
|
|
18
51
|
<a href="#tenancyconfig" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tenancy<wbr/>Config?</span></a>
|
|
19
52
|
<a href="#timeout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout?</span></a>
|
|
20
53
|
<a href="#property_injection_id" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>PROPERTY_<wbr/>INJECTION_<wbr/>ID</span></a>
|
|
21
|
-
</div></section
|
|
54
|
+
</div></section>
|
|
55
|
+
<section class="tsd-index-section">
|
|
56
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="accessors">Accessors<a href="#accessors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<div class="tsd-index-list"><a href="#connections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>connections</span></a>
|
|
22
58
|
<a href="#currentversion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>current<wbr/>Version</span></a>
|
|
23
59
|
<a href="#env" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>env</span></a>
|
|
24
60
|
<a href="#functionarn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>function<wbr/>Arn</span></a>
|
|
@@ -30,7 +66,10 @@ The construct also provides methods to dynamically update the configuration and
|
|
|
30
66
|
<a href="#physicalname" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>physical<wbr/>Name</span></a>
|
|
31
67
|
<a href="#resourcearnsforgrantinvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a>
|
|
32
68
|
<a href="#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>stack</span></a>
|
|
33
|
-
</div></section
|
|
69
|
+
</div></section>
|
|
70
|
+
<section class="tsd-index-section">
|
|
71
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
72
|
+
<div class="tsd-index-list"><a href="#addalias" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Alias</span></a>
|
|
34
73
|
<a href="#addenvironment" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Environment</span></a>
|
|
35
74
|
<a href="#addeventsource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a>
|
|
36
75
|
<a href="#addeventsourcemapping" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a>
|
|
@@ -38,6 +77,7 @@ The construct also provides methods to dynamically update the configuration and
|
|
|
38
77
|
<a href="#addlayers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Layers</span></a>
|
|
39
78
|
<a href="#addpermission" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Permission</span></a>
|
|
40
79
|
<a href="#addtorolepolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a>
|
|
80
|
+
<a href="#applycrossstackreferencestrength" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Cross<wbr/>Stack<wbr/>Reference<wbr/>Strength</span></a>
|
|
41
81
|
<a href="#applyremovalpolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a>
|
|
42
82
|
<a href="#configureasyncinvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a>
|
|
43
83
|
<a href="#considerwarningoninvokefunctionpermissions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a>
|
|
@@ -82,56 +122,231 @@ The construct also provides methods to dynamically update the configuration and
|
|
|
82
122
|
<a href="#metricallinvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a>
|
|
83
123
|
<a href="#metricallthrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a>
|
|
84
124
|
<a href="#metricallunreservedconcurrentexecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a>
|
|
85
|
-
</div></section></div></details></section></section
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
125
|
+
</div></section></div></details></section></section>
|
|
126
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
127
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
128
|
+
<section>
|
|
129
|
+
<section class="tsd-panel tsd-member">
|
|
130
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
131
|
+
<ul class="tsd-signatures">
|
|
132
|
+
<li class="">
|
|
133
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorlambdafunction"><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="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
134
|
+
<div class="tsd-description">
|
|
135
|
+
<div class="tsd-comment tsd-typography"><p>Creates an instance of LambdaFunction.</p>
|
|
136
|
+
</div>
|
|
137
|
+
<div class="tsd-parameters">
|
|
138
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
139
|
+
<ul class="tsd-parameter-list">
|
|
140
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span>
|
|
141
|
+
<div class="tsd-comment tsd-typography"><p>The scope in which this construct is defined.</p>
|
|
142
|
+
</div></li>
|
|
143
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
|
|
144
|
+
<div class="tsd-comment tsd-typography"><p>The scoped construct ID.</p>
|
|
145
|
+
</div></li>
|
|
146
|
+
<li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></span>
|
|
147
|
+
<div class="tsd-comment tsd-typography"><p>The properties of the LambdaFunction construct.</p>
|
|
148
|
+
</div></li></ul></div>
|
|
149
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4><aside class="tsd-sources">
|
|
150
|
+
<p>Overrides lambdaNodejs.NodejsFunction.constructor</p></aside></div></li></ul></section></section></details>
|
|
151
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
152
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
153
|
+
<section>
|
|
154
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
155
|
+
<h3 class="tsd-anchor-link" id="architecture"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
156
|
+
<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>
|
|
157
|
+
<div class="tsd-comment tsd-typography"><p>The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).</p>
|
|
158
|
+
</div><aside class="tsd-sources">
|
|
159
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.architecture</p></aside></section>
|
|
160
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
161
|
+
<h3 class="tsd-anchor-link" id="cancreatepermissions"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
162
|
+
<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>
|
|
163
|
+
<div class="tsd-comment tsd-typography"><p>Whether the addPermission() call adds any permissions</p>
|
|
91
164
|
<p>True for new Lambdas, false for version $LATEST and imported Lambdas
|
|
92
165
|
from different accounts.</p>
|
|
93
|
-
</div><aside class="tsd-sources"
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
</div><aside class="tsd-sources"
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
166
|
+
</div><aside class="tsd-sources">
|
|
167
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.canCreatePermissions</p></aside></section>
|
|
168
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
169
|
+
<h3 class="tsd-anchor-link" id="deadletterqueue"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
170
|
+
<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>
|
|
171
|
+
<div class="tsd-comment tsd-typography"><p>The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).</p>
|
|
172
|
+
</div><aside class="tsd-sources">
|
|
173
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterQueue</p></aside></section>
|
|
174
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
175
|
+
<h3 class="tsd-anchor-link" id="deadlettertopic"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
176
|
+
<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>
|
|
177
|
+
<div class="tsd-comment tsd-typography"><p>The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).</p>
|
|
178
|
+
</div><aside class="tsd-sources">
|
|
179
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterTopic</p></aside></section>
|
|
180
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
181
|
+
<h3 class="tsd-anchor-link" id="grantprincipal"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
182
|
+
<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>
|
|
183
|
+
<div class="tsd-comment tsd-typography"><p>The principal this Lambda Function is running as</p>
|
|
184
|
+
</div><aside class="tsd-sources">
|
|
185
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantPrincipal</p></aside></section>
|
|
186
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
187
|
+
<h3 class="tsd-anchor-link" id="node"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
188
|
+
<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>
|
|
189
|
+
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
190
|
+
</div><aside class="tsd-sources">
|
|
191
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.node</p></aside></section>
|
|
192
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
193
|
+
<h3 class="tsd-anchor-link" id="permissionsnode"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
194
|
+
<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>
|
|
195
|
+
<div class="tsd-comment tsd-typography"><p>The construct node where permissions are attached.</p>
|
|
196
|
+
</div><aside class="tsd-sources">
|
|
197
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.permissionsNode</p></aside></section>
|
|
198
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
199
|
+
<h3 class="tsd-anchor-link" id="role"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
200
|
+
<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>
|
|
201
|
+
<div class="tsd-comment tsd-typography"><p>Execution role associated with this function</p>
|
|
202
|
+
</div><aside class="tsd-sources">
|
|
203
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.role</p></aside></section>
|
|
204
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
205
|
+
<h3 class="tsd-anchor-link" id="runtime"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
206
|
+
<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>
|
|
207
|
+
<div class="tsd-comment tsd-typography"><p>The runtime configured for this lambda.</p>
|
|
208
|
+
</div><aside class="tsd-sources">
|
|
209
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.runtime</p></aside></section>
|
|
210
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
211
|
+
<h3 class="tsd-anchor-link" id="tenancyconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tenancy<wbr/>Config</span><a href="#tenancyconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
212
|
+
<div class="tsd-signature"><span class="tsd-kind-property">tenancyConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TenancyConfig</span></div>
|
|
213
|
+
<div class="tsd-comment tsd-typography"><p>The tenancy configuration for this function.</p>
|
|
214
|
+
</div><aside class="tsd-sources">
|
|
215
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.tenancyConfig</p></aside></section>
|
|
216
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
217
|
+
<h3 class="tsd-anchor-link" id="timeout"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
218
|
+
<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>
|
|
219
|
+
<div class="tsd-comment tsd-typography"><p>The timeout configured for this lambda.</p>
|
|
220
|
+
</div><aside class="tsd-sources">
|
|
221
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.timeout</p></aside></section>
|
|
222
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
223
|
+
<h3 class="tsd-anchor-link" id="property_injection_id"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>PROPERTY_<wbr/>INJECTION_<wbr/>ID</span><a href="#property_injection_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
224
|
+
<div class="tsd-signature"><span class="tsd-kind-property">PROPERTY_INJECTION_ID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
225
|
+
<div class="tsd-comment tsd-typography"><p>Uniquely identifies this class.</p>
|
|
226
|
+
</div><aside class="tsd-sources">
|
|
227
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.PROPERTY_INJECTION_ID</p></aside></section></section></details>
|
|
228
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
229
|
+
<h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
230
|
+
<section>
|
|
231
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
232
|
+
<h3 class="tsd-anchor-link" id="connections"><span>connections</span><a href="#connections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
233
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
234
|
+
<li>
|
|
235
|
+
<div class="tsd-signature" id="connectionsconnections"><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></div>
|
|
236
|
+
<div class="tsd-description">
|
|
237
|
+
<div class="tsd-comment tsd-typography"><p>Access the Connections object</p>
|
|
104
238
|
<p>Will fail if not a VPC-enabled Lambda Function</p>
|
|
105
|
-
</div
|
|
239
|
+
</div>
|
|
240
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Connections</span></h4><aside class="tsd-sources">
|
|
241
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.connections</p></aside></div></li></ul></section>
|
|
242
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
243
|
+
<h3 class="tsd-anchor-link" id="currentversion"><span>current<wbr/>Version</span><a href="#currentversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
244
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
245
|
+
<li>
|
|
246
|
+
<div class="tsd-signature" id="currentversioncurrentversion"><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></div>
|
|
247
|
+
<div class="tsd-description">
|
|
248
|
+
<div class="tsd-comment tsd-typography"><p>Returns a <code>lambda.Version</code> which represents the current version of this
|
|
106
249
|
Lambda function. A new version will be created every time the function's
|
|
107
250
|
configuration changes.</p>
|
|
108
251
|
<p>You can specify options for this version using the <code>currentVersionOptions</code>
|
|
109
252
|
prop when initializing the <code>lambda.Function</code>.</p>
|
|
110
|
-
</div
|
|
253
|
+
</div>
|
|
254
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Version</span></h4><aside class="tsd-sources">
|
|
255
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.currentVersion</p></aside></div></li></ul></section>
|
|
256
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
257
|
+
<h3 class="tsd-anchor-link" id="env"><span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
258
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
259
|
+
<li>
|
|
260
|
+
<div class="tsd-signature" id="envenv"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">env</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ResourceEnvironment</span></div>
|
|
261
|
+
<div class="tsd-description">
|
|
262
|
+
<div class="tsd-comment tsd-typography"><p>The environment this resource belongs to.</p>
|
|
111
263
|
<p>For resources that are created and managed in a Stack (those created by
|
|
112
264
|
creating new class instances like <code>new Role()</code>, <code>new Bucket()</code>, etc.), this
|
|
113
265
|
is always the same as the environment of the stack they belong to.</p>
|
|
114
266
|
<p>For referenced resources (those obtained from referencing methods like
|
|
115
267
|
<code>Role.fromRoleArn()</code>, <code>Bucket.fromBucketName()</code>, etc.), they might be
|
|
116
268
|
different than the stack they were imported into.</p>
|
|
117
|
-
</div
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
<
|
|
122
|
-
|
|
269
|
+
</div>
|
|
270
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ResourceEnvironment</span></h4><aside class="tsd-sources">
|
|
271
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.env</p></aside></div></li></ul></section>
|
|
272
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
273
|
+
<h3 class="tsd-anchor-link" id="functionarn"><span>function<wbr/>Arn</span><a href="#functionarn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
274
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
275
|
+
<li>
|
|
276
|
+
<div class="tsd-signature" id="functionarnfunctionarn"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">functionArn</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
277
|
+
<div class="tsd-description">
|
|
278
|
+
<div class="tsd-comment tsd-typography"><p>ARN of this function</p>
|
|
279
|
+
</div>
|
|
280
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
281
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.functionArn</p></aside></div></li></ul></section>
|
|
282
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
283
|
+
<h3 class="tsd-anchor-link" id="functionname"><span>function<wbr/>Name</span><a href="#functionname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
284
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
285
|
+
<li>
|
|
286
|
+
<div class="tsd-signature" id="functionnamefunctionname"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">functionName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
287
|
+
<div class="tsd-description">
|
|
288
|
+
<div class="tsd-comment tsd-typography"><p>Name of this function</p>
|
|
289
|
+
</div>
|
|
290
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
291
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.functionName</p></aside></div></li></ul></section>
|
|
292
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
293
|
+
<h3 class="tsd-anchor-link" id="functionref"><span>function<wbr/>Ref</span><a href="#functionref" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
294
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
295
|
+
<li>
|
|
296
|
+
<div class="tsd-signature" id="functionreffunctionref"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">functionRef</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FunctionReference</span></div>
|
|
297
|
+
<div class="tsd-description">
|
|
298
|
+
<div class="tsd-comment tsd-typography"><p>A reference to a Function resource.</p>
|
|
299
|
+
</div>
|
|
300
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FunctionReference</span></h4><aside class="tsd-sources">
|
|
301
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.functionRef</p></aside></div></li></ul></section>
|
|
302
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
303
|
+
<h3 class="tsd-anchor-link" id="isboundtovpc"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
304
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
305
|
+
<li>
|
|
306
|
+
<div class="tsd-signature" id="isboundtovpcisboundtovpc"><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></div>
|
|
307
|
+
<div class="tsd-description">
|
|
308
|
+
<div class="tsd-comment tsd-typography"><p>Whether or not this Lambda function was bound to a VPC</p>
|
|
309
|
+
<p>If this is <code>false</code>, trying to access the <code>connections</code> object will fail.</p>
|
|
310
|
+
</div>
|
|
311
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
312
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.isBoundToVpc</p></aside></div></li></ul></section>
|
|
313
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
314
|
+
<h3 class="tsd-anchor-link" id="latestversion"><span>latest<wbr/>Version</span><a href="#latestversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
315
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
316
|
+
<li>
|
|
317
|
+
<div class="tsd-signature" id="latestversionlatestversion"><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></div>
|
|
318
|
+
<div class="tsd-description">
|
|
319
|
+
<div class="tsd-comment tsd-typography"><p>The <code>$LATEST</code> version of this function.</p>
|
|
123
320
|
<p>Note that this is reference to a non-specific AWS Lambda version, which
|
|
124
321
|
means the function this version refers to can return different results in
|
|
125
322
|
different invocations.</p>
|
|
126
323
|
<p>To obtain a reference to an explicit version which references the current
|
|
127
324
|
function configuration, use <code>lambdaFunction.currentVersion</code> instead.</p>
|
|
128
|
-
</div
|
|
325
|
+
</div>
|
|
326
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IVersion</span></h4><aside class="tsd-sources">
|
|
327
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.latestVersion</p></aside></div></li></ul></section>
|
|
328
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
329
|
+
<h3 class="tsd-anchor-link" id="loggroup"><span>log<wbr/>Group</span><a href="#loggroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
330
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
331
|
+
<li>
|
|
332
|
+
<div class="tsd-signature" id="loggrouploggroup"><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></div>
|
|
333
|
+
<div class="tsd-description">
|
|
334
|
+
<div class="tsd-comment tsd-typography"><p>The LogGroup where the Lambda function's logs are made available.</p>
|
|
129
335
|
<p>If either <code>logRetention</code> is set or this property is called, a CloudFormation custom resource is added to the stack that
|
|
130
336
|
pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
|
|
131
337
|
period (never expire, by default).</p>
|
|
132
338
|
<p>Further, if the log group already exists and the <code>logRetention</code> is not set, the custom resource will reset the log retention
|
|
133
339
|
to never expire even if it was configured with a different value.</p>
|
|
134
|
-
</div
|
|
340
|
+
</div>
|
|
341
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ILogGroup</span></h4><aside class="tsd-sources">
|
|
342
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.logGroup</p></aside></div></li></ul></section>
|
|
343
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
344
|
+
<h3 class="tsd-anchor-link" id="physicalname"><code class="tsd-tag">Protected</code><span>physical<wbr/>Name</span><a href="#physicalname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
345
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
346
|
+
<li>
|
|
347
|
+
<div class="tsd-signature" id="physicalnamephysicalname"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">physicalName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
348
|
+
<div class="tsd-description">
|
|
349
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string-encoded token that resolves to the physical name that
|
|
135
350
|
should be passed to the CloudFormation resource.</p>
|
|
136
351
|
<p>This value will resolve to one of the following:</p>
|
|
137
352
|
<ul>
|
|
@@ -140,85 +355,454 @@ should be passed to the CloudFormation resource.</p>
|
|
|
140
355
|
<li>a concrete name generated automatically during synthesis, in
|
|
141
356
|
cross-environment scenarios.</li>
|
|
142
357
|
</ul>
|
|
143
|
-
</div
|
|
144
|
-
|
|
145
|
-
|
|
358
|
+
</div>
|
|
359
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
360
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.physicalName</p></aside></div></li></ul></section>
|
|
361
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
362
|
+
<h3 class="tsd-anchor-link" id="resourcearnsforgrantinvoke"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
363
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
364
|
+
<li>
|
|
365
|
+
<div class="tsd-signature" id="resourcearnsforgrantinvokeresourcearnsforgrantinvoke"><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></div>
|
|
366
|
+
<div class="tsd-description">
|
|
367
|
+
<div class="tsd-comment tsd-typography"><p>The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()</p>
|
|
368
|
+
</div>
|
|
369
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
370
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.resourceArnsForGrantInvoke</p></aside></div></li></ul></section>
|
|
371
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
372
|
+
<h3 class="tsd-anchor-link" id="stack"><span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
373
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
374
|
+
<li>
|
|
375
|
+
<div class="tsd-signature" id="stackstack"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">stack</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Stack</span></div>
|
|
376
|
+
<div class="tsd-description">
|
|
377
|
+
<div class="tsd-comment tsd-typography"><p>The stack in which this resource is defined.</p>
|
|
378
|
+
</div>
|
|
379
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Stack</span></h4><aside class="tsd-sources">
|
|
380
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.stack</p></aside></div></li></ul></section></section></details>
|
|
381
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
382
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
383
|
+
<section>
|
|
384
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
385
|
+
<h3 class="tsd-anchor-link" id="addalias"><span>add<wbr/>Alias</span><a href="#addalias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
386
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
387
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
388
|
+
<div class="tsd-signature tsd-anchor-link" id="addalias-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
389
|
+
<div class="tsd-description">
|
|
390
|
+
<div class="tsd-comment tsd-typography"><p>Defines an alias for this function.</p>
|
|
146
391
|
<p>The alias will automatically be updated to point to the latest version of
|
|
147
392
|
the function as it is being updated during a deployment.</p>
|
|
148
393
|
<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-8">lambda</span><span class="hl-1">.</span><span class="hl-8">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>
|
|
149
394
|
</code><button type="button">Copy</button></pre>
|
|
150
395
|
|
|
151
|
-
</div
|
|
152
|
-
|
|
153
|
-
|
|
396
|
+
</div>
|
|
397
|
+
<div class="tsd-parameters">
|
|
398
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
399
|
+
<ul class="tsd-parameter-list">
|
|
400
|
+
<li><span><span class="tsd-kind-parameter">aliasName</span>: <span class="tsd-signature-type">string</span></span>
|
|
401
|
+
<div class="tsd-comment tsd-typography"><p>The name of the alias</p>
|
|
402
|
+
</div></li>
|
|
403
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">AliasOptions</span></span>
|
|
404
|
+
<div class="tsd-comment tsd-typography"><p>Alias options</p>
|
|
405
|
+
</div></li></ul></div>
|
|
406
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Alias</span></h4><aside class="tsd-sources">
|
|
407
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addAlias</p></aside></div></li></ul></section>
|
|
408
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
409
|
+
<h3 class="tsd-anchor-link" id="addenvironment"><span>add<wbr/>Environment</span><a href="#addenvironment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
410
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
411
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
412
|
+
<div class="tsd-signature tsd-anchor-link" id="addenvironment-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
413
|
+
<div class="tsd-description">
|
|
414
|
+
<div class="tsd-comment tsd-typography"><p>Adds an environment variable to this Lambda function.
|
|
154
415
|
If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
155
|
-
</div
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
416
|
+
</div>
|
|
417
|
+
<div class="tsd-parameters">
|
|
418
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
419
|
+
<ul class="tsd-parameter-list">
|
|
420
|
+
<li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span>
|
|
421
|
+
<div class="tsd-comment tsd-typography"><p>The environment variable key.</p>
|
|
422
|
+
</div></li>
|
|
423
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span>
|
|
424
|
+
<div class="tsd-comment tsd-typography"><p>The environment variable's value.</p>
|
|
425
|
+
</div></li>
|
|
426
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EnvironmentOptions</span></span>
|
|
427
|
+
<div class="tsd-comment tsd-typography"><p>Environment variable options.</p>
|
|
428
|
+
</div></li></ul></div>
|
|
429
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
|
|
430
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addEnvironment</p></aside></div></li></ul></section>
|
|
431
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
432
|
+
<h3 class="tsd-anchor-link" id="addeventsource"><span>add<wbr/>Event<wbr/>Source</span><a href="#addeventsource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
433
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
434
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
435
|
+
<div class="tsd-signature tsd-anchor-link" id="addeventsource-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
436
|
+
<div class="tsd-description">
|
|
437
|
+
<div class="tsd-comment tsd-typography"><p>Adds an event source to this function.</p>
|
|
159
438
|
<p>Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.</p>
|
|
160
439
|
<p>The following example adds an SQS Queue as an event source:</p>
|
|
161
440
|
<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>
|
|
162
441
|
</code><button>Copy</button></pre>
|
|
163
442
|
|
|
164
|
-
</div
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
443
|
+
</div>
|
|
444
|
+
<div class="tsd-parameters">
|
|
445
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
446
|
+
<ul class="tsd-parameter-list">
|
|
447
|
+
<li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">IEventSource</span></span></li></ul></div>
|
|
448
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
449
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSource</p></aside></div></li></ul></section>
|
|
450
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
451
|
+
<h3 class="tsd-anchor-link" id="addeventsourcemapping"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
452
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
453
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
454
|
+
<div class="tsd-signature tsd-anchor-link" id="addeventsourcemapping-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
455
|
+
<div class="tsd-description">
|
|
456
|
+
<div class="tsd-comment tsd-typography"><p>Adds an event source that maps to this AWS Lambda function.</p>
|
|
457
|
+
</div>
|
|
458
|
+
<div class="tsd-parameters">
|
|
459
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
460
|
+
<ul class="tsd-parameter-list">
|
|
461
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
|
|
462
|
+
<div class="tsd-comment tsd-typography"><p>construct ID</p>
|
|
463
|
+
</div></li>
|
|
464
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EventSourceMappingOptions</span></span>
|
|
465
|
+
<div class="tsd-comment tsd-typography"><p>mapping options</p>
|
|
466
|
+
</div></li></ul></div>
|
|
467
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EventSourceMapping</span></h4><aside class="tsd-sources">
|
|
468
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSourceMapping</p></aside></div></li></ul></section>
|
|
469
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
470
|
+
<h3 class="tsd-anchor-link" id="addfunctionurl"><span>add<wbr/>Function<wbr/>Url</span><a href="#addfunctionurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
471
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
472
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
473
|
+
<div class="tsd-signature tsd-anchor-link" id="addfunctionurl-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
474
|
+
<div class="tsd-description">
|
|
475
|
+
<div class="tsd-comment tsd-typography"><p>Adds a url to this lambda function.</p>
|
|
476
|
+
</div>
|
|
477
|
+
<div class="tsd-parameters">
|
|
478
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
479
|
+
<ul class="tsd-parameter-list">
|
|
480
|
+
<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>
|
|
481
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FunctionUrl</span></h4><aside class="tsd-sources">
|
|
482
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addFunctionUrl</p></aside></div></li></ul></section>
|
|
483
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
484
|
+
<h3 class="tsd-anchor-link" id="addlayers"><span>add<wbr/>Layers</span><a href="#addlayers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
485
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
486
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
487
|
+
<div class="tsd-signature tsd-anchor-link" id="addlayers-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
488
|
+
<div class="tsd-description">
|
|
489
|
+
<div class="tsd-comment tsd-typography"><p>Adds one or more Lambda Layers to this Lambda function.</p>
|
|
490
|
+
</div>
|
|
491
|
+
<div class="tsd-parameters">
|
|
492
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
493
|
+
<ul class="tsd-parameter-list">
|
|
494
|
+
<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>
|
|
495
|
+
<div class="tsd-comment tsd-typography"><p>the layers to be added.</p>
|
|
496
|
+
</div></li></ul></div>
|
|
497
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
498
|
+
<div class="tsd-comment tsd-typography">
|
|
499
|
+
<div class="tsd-tag-throws">
|
|
500
|
+
<h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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>
|
|
501
|
+
</div></div><aside class="tsd-sources">
|
|
502
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addLayers</p></aside></div></li></ul></section>
|
|
503
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
504
|
+
<h3 class="tsd-anchor-link" id="addpermission"><span>add<wbr/>Permission</span><a href="#addpermission" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
505
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
506
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
507
|
+
<div class="tsd-signature tsd-anchor-link" id="addpermission-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
508
|
+
<div class="tsd-description">
|
|
509
|
+
<div class="tsd-comment tsd-typography"><p>Adds a permission to the Lambda resource policy.</p>
|
|
510
|
+
</div>
|
|
511
|
+
<div class="tsd-parameters">
|
|
512
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
513
|
+
<ul class="tsd-parameter-list">
|
|
514
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
|
|
515
|
+
<div class="tsd-comment tsd-typography"><p>The id for the permission construct</p>
|
|
516
|
+
</div></li>
|
|
517
|
+
<li><span><span class="tsd-kind-parameter">permission</span>: <span class="tsd-signature-type">Permission</span></span>
|
|
518
|
+
<div class="tsd-comment tsd-typography"><p>The permission to grant to this Lambda function.</p>
|
|
519
|
+
</div></li></ul></div>
|
|
520
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
521
|
+
<div class="tsd-comment tsd-typography">
|
|
522
|
+
<div class="tsd-tag-see">
|
|
523
|
+
<h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Permission for details.</p>
|
|
524
|
+
</div></div><aside class="tsd-sources">
|
|
525
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addPermission</p></aside></div></li></ul></section>
|
|
526
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
527
|
+
<h3 class="tsd-anchor-link" id="addtorolepolicy"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
528
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
529
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
530
|
+
<div class="tsd-signature tsd-anchor-link" id="addtorolepolicy-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
531
|
+
<div class="tsd-description">
|
|
532
|
+
<div class="tsd-comment tsd-typography"><p>Adds a statement to the IAM role assumed by the instance.</p>
|
|
533
|
+
</div>
|
|
534
|
+
<div class="tsd-parameters">
|
|
535
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
536
|
+
<ul class="tsd-parameter-list">
|
|
537
|
+
<li><span><span class="tsd-kind-parameter">statement</span>: <span class="tsd-signature-type">PolicyStatement</span></span></li></ul></div>
|
|
538
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
539
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.addToRolePolicy</p></aside></div></li></ul></section>
|
|
540
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
541
|
+
<h3 class="tsd-anchor-link" id="applycrossstackreferencestrength"><span>apply<wbr/>Cross<wbr/>Stack<wbr/>Reference<wbr/>Strength</span><a href="#applycrossstackreferencestrength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
542
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
543
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
544
|
+
<div class="tsd-signature tsd-anchor-link" id="applycrossstackreferencestrength-1"><span class="tsd-kind-call-signature">applyCrossStackReferenceStrength</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">strength</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReferenceStrength</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#applycrossstackreferencestrength-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
545
|
+
<div class="tsd-description">
|
|
546
|
+
<div class="tsd-comment tsd-typography"><p>Override the cross-stack reference strength for this resource.</p>
|
|
547
|
+
<p>When set, any cross-stack reference to this resource will use the specified
|
|
548
|
+
mechanism instead of the global default determined by the
|
|
549
|
+
<code>@aws-cdk/core:defaultCrossStackReferences</code> context key. This is useful for
|
|
550
|
+
selectively weakening specific references to avoid the "deadly embrace" problem
|
|
551
|
+
without changing the app-wide default.</p>
|
|
552
|
+
</div>
|
|
553
|
+
<div class="tsd-parameters">
|
|
554
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
555
|
+
<ul class="tsd-parameter-list">
|
|
556
|
+
<li><span><span class="tsd-kind-parameter">strength</span>: <span class="tsd-signature-type">ReferenceStrength</span></span>
|
|
557
|
+
<div class="tsd-comment tsd-typography"><p>The reference strength to use for this resource.</p>
|
|
558
|
+
</div></li></ul></div>
|
|
559
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
560
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.applyCrossStackReferenceStrength</p></aside></div></li></ul></section>
|
|
561
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
562
|
+
<h3 class="tsd-anchor-link" id="applyremovalpolicy"><span>apply<wbr/>Removal<wbr/>Policy</span><a href="#applyremovalpolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
563
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
564
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
565
|
+
<div class="tsd-signature tsd-anchor-link" id="applyremovalpolicy-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
566
|
+
<div class="tsd-description">
|
|
567
|
+
<div class="tsd-comment tsd-typography"><p>Apply the given removal policy to this resource</p>
|
|
177
568
|
<p>The Removal Policy controls what happens to this resource when it stops
|
|
178
569
|
being managed by CloudFormation, either because you've removed it from the
|
|
179
570
|
CDK application or because you've made a change that requires the resource
|
|
180
571
|
to be replaced.</p>
|
|
181
572
|
<p>The resource can be deleted (<code>RemovalPolicy.DESTROY</code>), or left in your AWS
|
|
182
573
|
account for data recovery and cleanup later (<code>RemovalPolicy.RETAIN</code>).</p>
|
|
183
|
-
</div
|
|
184
|
-
|
|
574
|
+
</div>
|
|
575
|
+
<div class="tsd-parameters">
|
|
576
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
577
|
+
<ul class="tsd-parameter-list">
|
|
578
|
+
<li><span><span class="tsd-kind-parameter">policy</span>: <span class="tsd-signature-type">RemovalPolicy</span></span></li></ul></div>
|
|
579
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
580
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.applyRemovalPolicy</p></aside></div></li></ul></section>
|
|
581
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
582
|
+
<h3 class="tsd-anchor-link" id="configureasyncinvoke"><span>configure<wbr/>Async<wbr/>Invoke</span><a href="#configureasyncinvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
583
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
584
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
585
|
+
<div class="tsd-signature tsd-anchor-link" id="configureasyncinvoke-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
586
|
+
<div class="tsd-description">
|
|
587
|
+
<div class="tsd-comment tsd-typography"><p>Configures options for asynchronous invocation.</p>
|
|
588
|
+
</div>
|
|
589
|
+
<div class="tsd-parameters">
|
|
590
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
591
|
+
<ul class="tsd-parameter-list">
|
|
592
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">EventInvokeConfigOptions</span></span></li></ul></div>
|
|
593
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
594
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.configureAsyncInvoke</p></aside></div></li></ul></section>
|
|
595
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
596
|
+
<h3 class="tsd-anchor-link" id="considerwarningoninvokefunctionpermissions"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
597
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
598
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
599
|
+
<div class="tsd-signature tsd-anchor-link" id="considerwarningoninvokefunctionpermissions-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
600
|
+
<div class="tsd-description">
|
|
601
|
+
<div class="tsd-comment tsd-typography"><p>A warning will be added to functions under the following conditions:</p>
|
|
185
602
|
<ul>
|
|
186
603
|
<li>permissions that include <code>lambda:InvokeFunction</code> are added to the unqualified function.</li>
|
|
187
604
|
<li>function.currentVersion is invoked before or after the permission is created.</li>
|
|
188
605
|
</ul>
|
|
189
606
|
<p>This applies only to permissions on Lambda functions, not versions or aliases.
|
|
190
607
|
This function is overridden as a noOp for QualifiedFunctionBase.</p>
|
|
191
|
-
</div
|
|
608
|
+
</div>
|
|
609
|
+
<div class="tsd-parameters">
|
|
610
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
611
|
+
<ul class="tsd-parameter-list">
|
|
612
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li>
|
|
613
|
+
<li><span><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
614
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
615
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.considerWarningOnInvokeFunctionPermissions</p></aside></div></li></ul></section>
|
|
616
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
617
|
+
<h3 class="tsd-anchor-link" id="generatephysicalname"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
618
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
619
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
620
|
+
<div class="tsd-signature tsd-anchor-link" id="generatephysicalname-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
621
|
+
<div class="tsd-description">
|
|
622
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
623
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.generatePhysicalName</p></aside></div></li></ul></section>
|
|
624
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
625
|
+
<h3 class="tsd-anchor-link" id="getresourcearnattribute"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
626
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
627
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
628
|
+
<div class="tsd-signature tsd-anchor-link" id="getresourcearnattribute-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
629
|
+
<div class="tsd-description">
|
|
630
|
+
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
192
631
|
resource's "ARN" attribute (e.g. <code>bucket.bucketArn</code>).</p>
|
|
193
632
|
<p>Normally, this token will resolve to <code>arnAttr</code>, but if the resource is
|
|
194
633
|
referenced across environments, <code>arnComponents</code> will be used to synthesize
|
|
195
634
|
a concrete ARN with the resource's physical name. Make sure to reference
|
|
196
635
|
<code>this.physicalName</code> in <code>arnComponents</code>.</p>
|
|
197
|
-
</div
|
|
636
|
+
</div>
|
|
637
|
+
<div class="tsd-parameters">
|
|
638
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
639
|
+
<ul class="tsd-parameter-list">
|
|
640
|
+
<li><span><span class="tsd-kind-parameter">arnAttr</span>: <span class="tsd-signature-type">string</span></span>
|
|
641
|
+
<div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the ARN of the resource.
|
|
198
642
|
Commonly it will be called "Arn" (e.g. <code>resource.attrArn</code>), but sometimes
|
|
199
643
|
it's the CFN resource's <code>ref</code>.</p>
|
|
200
|
-
</div></li
|
|
644
|
+
</div></li>
|
|
645
|
+
<li><span><span class="tsd-kind-parameter">arnComponents</span>: <span class="tsd-signature-type">ArnComponents</span></span>
|
|
646
|
+
<div class="tsd-comment tsd-typography"><p>The format of the ARN of this resource. You must
|
|
201
647
|
reference <code>this.physicalName</code> somewhere within the ARN in order for
|
|
202
648
|
cross-environment references to work.</p>
|
|
203
|
-
</div></li></ul></div
|
|
649
|
+
</div></li></ul></div>
|
|
650
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
651
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceArnAttribute</p></aside></div></li></ul></section>
|
|
652
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
653
|
+
<h3 class="tsd-anchor-link" id="getresourcenameattribute"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
654
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
655
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
656
|
+
<div class="tsd-signature tsd-anchor-link" id="getresourcenameattribute-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
657
|
+
<div class="tsd-description">
|
|
658
|
+
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
204
659
|
resource's "name" attribute (e.g. <code>bucket.bucketName</code>).</p>
|
|
205
660
|
<p>Normally, this token will resolve to <code>nameAttr</code>, but if the resource is
|
|
206
661
|
referenced across environments, it will be resolved to <code>this.physicalName</code>,
|
|
207
662
|
which will be a concrete name.</p>
|
|
208
|
-
</div
|
|
663
|
+
</div>
|
|
664
|
+
<div class="tsd-parameters">
|
|
665
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
666
|
+
<ul class="tsd-parameter-list">
|
|
667
|
+
<li><span><span class="tsd-kind-parameter">nameAttr</span>: <span class="tsd-signature-type">string</span></span>
|
|
668
|
+
<div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the resource's name.
|
|
209
669
|
Commonly this is the resource's <code>ref</code>.</p>
|
|
210
|
-
</div></li></ul></div
|
|
670
|
+
</div></li></ul></div>
|
|
671
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
672
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceNameAttribute</p></aside></div></li></ul></section>
|
|
673
|
+
<section class="tsd-panel tsd-member">
|
|
674
|
+
<h3 class="tsd-anchor-link" id="grantdeleteasset"><span>grant<wbr/>Delete<wbr/>Asset</span><a href="#grantdeleteasset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
675
|
+
<ul class="tsd-signatures">
|
|
676
|
+
<li class="">
|
|
677
|
+
<div class="tsd-signature tsd-anchor-link" id="grantdeleteasset-1"><span class="tsd-kind-call-signature">grantDeleteAsset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
678
|
+
<div class="tsd-description">
|
|
679
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
680
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
681
|
+
<h3 class="tsd-anchor-link" id="grantinvoke"><span>grant<wbr/>Invoke</span><a href="#grantinvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
682
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
683
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
684
|
+
<div class="tsd-signature tsd-anchor-link" id="grantinvoke-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
685
|
+
<div class="tsd-description">
|
|
686
|
+
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda</p>
|
|
211
687
|
<p>[disable-awslint:no-grants]</p>
|
|
212
|
-
</div
|
|
688
|
+
</div>
|
|
689
|
+
<div class="tsd-parameters">
|
|
690
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
691
|
+
<ul class="tsd-parameter-list">
|
|
692
|
+
<li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div>
|
|
693
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><aside class="tsd-sources">
|
|
694
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvoke</p></aside></div></li></ul></section>
|
|
695
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
696
|
+
<h3 class="tsd-anchor-link" id="grantinvokecompositeprincipal"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
697
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
698
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
699
|
+
<div class="tsd-signature tsd-anchor-link" id="grantinvokecompositeprincipal-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
700
|
+
<div class="tsd-description">
|
|
701
|
+
<div class="tsd-comment tsd-typography"><p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal</p>
|
|
213
702
|
<p>[disable-awslint:no-grants]</p>
|
|
214
|
-
</div
|
|
703
|
+
</div>
|
|
704
|
+
<div class="tsd-parameters">
|
|
705
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
706
|
+
<ul class="tsd-parameter-list">
|
|
707
|
+
<li><span><span class="tsd-kind-parameter">compositePrincipal</span>: <span class="tsd-signature-type">CompositePrincipal</span></span></li></ul></div>
|
|
708
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
709
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeCompositePrincipal</p></aside></div></li></ul></section>
|
|
710
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
711
|
+
<h3 class="tsd-anchor-link" id="grantinvokelatestversion"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
712
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
713
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
714
|
+
<div class="tsd-signature tsd-anchor-link" id="grantinvokelatestversion-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
715
|
+
<div class="tsd-description">
|
|
716
|
+
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke the $LATEST version or
|
|
215
717
|
unqualified version of this Lambda</p>
|
|
216
718
|
<p>[disable-awslint:no-grants]</p>
|
|
217
|
-
</div
|
|
719
|
+
</div>
|
|
720
|
+
<div class="tsd-parameters">
|
|
721
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
722
|
+
<ul class="tsd-parameter-list">
|
|
723
|
+
<li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div>
|
|
724
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><aside class="tsd-sources">
|
|
725
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeLatestVersion</p></aside></div></li></ul></section>
|
|
726
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
727
|
+
<h3 class="tsd-anchor-link" id="grantinvokeurl"><span>grant<wbr/>Invoke<wbr/>Url</span><a href="#grantinvokeurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
728
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
729
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
730
|
+
<div class="tsd-signature tsd-anchor-link" id="grantinvokeurl-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
731
|
+
<div class="tsd-description">
|
|
732
|
+
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda Function URL</p>
|
|
218
733
|
<p>[disable-awslint:no-grants]</p>
|
|
219
|
-
</div
|
|
734
|
+
</div>
|
|
735
|
+
<div class="tsd-parameters">
|
|
736
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
737
|
+
<ul class="tsd-parameter-list">
|
|
738
|
+
<li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li></ul></div>
|
|
739
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><aside class="tsd-sources">
|
|
740
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeUrl</p></aside></div></li></ul></section>
|
|
741
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
742
|
+
<h3 class="tsd-anchor-link" id="grantinvokeversion"><span>grant<wbr/>Invoke<wbr/>Version</span><a href="#grantinvokeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
743
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
744
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
745
|
+
<div class="tsd-signature tsd-anchor-link" id="grantinvokeversion-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
746
|
+
<div class="tsd-description">
|
|
747
|
+
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke the given version of this Lambda</p>
|
|
220
748
|
<p>[disable-awslint:no-grants]</p>
|
|
221
|
-
</div
|
|
749
|
+
</div>
|
|
750
|
+
<div class="tsd-parameters">
|
|
751
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
752
|
+
<ul class="tsd-parameter-list">
|
|
753
|
+
<li><span><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type">IGrantable</span></span></li>
|
|
754
|
+
<li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">IVersion</span></span></li></ul></div>
|
|
755
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Grant</span></h4><aside class="tsd-sources">
|
|
756
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeVersion</p></aside></div></li></ul></section>
|
|
757
|
+
<section class="tsd-panel tsd-member">
|
|
758
|
+
<h3 class="tsd-anchor-link" id="grantreadassets"><span>grant<wbr/>Read<wbr/>Assets</span><a href="#grantreadassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
759
|
+
<ul class="tsd-signatures">
|
|
760
|
+
<li class="">
|
|
761
|
+
<div class="tsd-signature tsd-anchor-link" id="grantreadassets-1"><span class="tsd-kind-call-signature">grantReadAssets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
762
|
+
<div class="tsd-description">
|
|
763
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
764
|
+
<section class="tsd-panel tsd-member">
|
|
765
|
+
<h3 class="tsd-anchor-link" id="grantsendemails"><span>grant<wbr/>Send<wbr/>Emails</span><a href="#grantsendemails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
766
|
+
<ul class="tsd-signatures">
|
|
767
|
+
<li class="">
|
|
768
|
+
<div class="tsd-signature tsd-anchor-link" id="grantsendemails-1"><span class="tsd-kind-call-signature">grantSendEmails</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
769
|
+
<div class="tsd-description">
|
|
770
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
771
|
+
<section class="tsd-panel tsd-member">
|
|
772
|
+
<h3 class="tsd-anchor-link" id="granttablewrite"><span>grant<wbr/>Table<wbr/>Write</span><a href="#granttablewrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
773
|
+
<ul class="tsd-signatures">
|
|
774
|
+
<li class="">
|
|
775
|
+
<div class="tsd-signature tsd-anchor-link" id="granttablewrite-1"><span class="tsd-kind-call-signature">grantTableWrite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
776
|
+
<div class="tsd-description">
|
|
777
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
778
|
+
<section class="tsd-panel tsd-member">
|
|
779
|
+
<h3 class="tsd-anchor-link" id="grantuploadassets"><span>grant<wbr/>Upload<wbr/>Assets</span><a href="#grantuploadassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
780
|
+
<ul class="tsd-signatures">
|
|
781
|
+
<li class="">
|
|
782
|
+
<div class="tsd-signature tsd-anchor-link" id="grantuploadassets-1"><span class="tsd-kind-call-signature">grantUploadAssets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
783
|
+
<div class="tsd-description">
|
|
784
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
785
|
+
<section class="tsd-panel tsd-member">
|
|
786
|
+
<h3 class="tsd-anchor-link" id="grantuserpoolread"><span>grant<wbr/>Userpool<wbr/>Read</span><a href="#grantuserpoolread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
787
|
+
<ul class="tsd-signatures">
|
|
788
|
+
<li class="">
|
|
789
|
+
<div class="tsd-signature tsd-anchor-link" id="grantuserpoolread-1"><span class="tsd-kind-call-signature">grantUserpoolRead</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
790
|
+
<div class="tsd-description">
|
|
791
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
792
|
+
<section class="tsd-panel tsd-member">
|
|
793
|
+
<h3 class="tsd-anchor-link" id="grantuserpoolreadwrite"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
794
|
+
<ul class="tsd-signatures">
|
|
795
|
+
<li class="">
|
|
796
|
+
<div class="tsd-signature tsd-anchor-link" id="grantuserpoolreadwrite-1"><span class="tsd-kind-call-signature">grantUserpoolReadWrite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
797
|
+
<div class="tsd-description">
|
|
798
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
799
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
800
|
+
<h3 class="tsd-anchor-link" id="invalidateversionbasedon"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
801
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
802
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
803
|
+
<div class="tsd-signature tsd-anchor-link" id="invalidateversionbasedon-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
804
|
+
<div class="tsd-description">
|
|
805
|
+
<div class="tsd-comment tsd-typography"><p>Mix additional information into the hash of the Version object</p>
|
|
222
806
|
<p>The Lambda Function construct does its best to automatically create a new
|
|
223
807
|
Version when anything about the Function changes (its code, its layers,
|
|
224
808
|
any of the other properties).</p>
|
|
@@ -230,40 +814,252 @@ should.</p>
|
|
|
230
814
|
any string into this method, and make sure the string changes when you know
|
|
231
815
|
a new Version needs to be created.</p>
|
|
232
816
|
<p>This method may be called more than once.</p>
|
|
233
|
-
</div
|
|
234
|
-
|
|
817
|
+
</div>
|
|
818
|
+
<div class="tsd-parameters">
|
|
819
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
820
|
+
<ul class="tsd-parameter-list">
|
|
821
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
822
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
823
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.invalidateVersionBasedOn</p></aside></div></li></ul></section>
|
|
824
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
825
|
+
<h3 class="tsd-anchor-link" id="metric"><span>metric</span><a href="#metric" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
826
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
827
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
828
|
+
<div class="tsd-signature tsd-anchor-link" id="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-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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
829
|
+
<div class="tsd-description">
|
|
830
|
+
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Function</p>
|
|
831
|
+
</div>
|
|
832
|
+
<div class="tsd-parameters">
|
|
833
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
834
|
+
<ul class="tsd-parameter-list">
|
|
835
|
+
<li><span><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
836
|
+
<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>
|
|
837
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
838
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metric</p></aside></div></li></ul></section>
|
|
839
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
840
|
+
<h3 class="tsd-anchor-link" id="metricduration"><span>metric<wbr/>Duration</span><a href="#metricduration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
841
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
842
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
843
|
+
<div class="tsd-signature tsd-anchor-link" id="metricduration-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
844
|
+
<div class="tsd-description">
|
|
845
|
+
<div class="tsd-comment tsd-typography"><p>How long execution of this Lambda takes</p>
|
|
235
846
|
<p>Average over 5 minutes</p>
|
|
236
|
-
</div
|
|
847
|
+
</div>
|
|
848
|
+
<div class="tsd-parameters">
|
|
849
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
850
|
+
<ul class="tsd-parameter-list">
|
|
851
|
+
<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>
|
|
852
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
853
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricDuration</p></aside></div></li></ul></section>
|
|
854
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
855
|
+
<h3 class="tsd-anchor-link" id="metricerrors"><span>metric<wbr/>Errors</span><a href="#metricerrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
856
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
857
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
858
|
+
<div class="tsd-signature tsd-anchor-link" id="metricerrors-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
859
|
+
<div class="tsd-description">
|
|
860
|
+
<div class="tsd-comment tsd-typography"><p>How many invocations of this Lambda fail</p>
|
|
237
861
|
<p>Sum over 5 minutes</p>
|
|
238
|
-
</div
|
|
862
|
+
</div>
|
|
863
|
+
<div class="tsd-parameters">
|
|
864
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
865
|
+
<ul class="tsd-parameter-list">
|
|
866
|
+
<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>
|
|
867
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
868
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricErrors</p></aside></div></li></ul></section>
|
|
869
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
870
|
+
<h3 class="tsd-anchor-link" id="metricinvocations"><span>metric<wbr/>Invocations</span><a href="#metricinvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
871
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
872
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
873
|
+
<div class="tsd-signature tsd-anchor-link" id="metricinvocations-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
874
|
+
<div class="tsd-description">
|
|
875
|
+
<div class="tsd-comment tsd-typography"><p>How often this Lambda is invoked</p>
|
|
239
876
|
<p>Sum over 5 minutes</p>
|
|
240
|
-
</div
|
|
877
|
+
</div>
|
|
878
|
+
<div class="tsd-parameters">
|
|
879
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
880
|
+
<ul class="tsd-parameter-list">
|
|
881
|
+
<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>
|
|
882
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
883
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricInvocations</p></aside></div></li></ul></section>
|
|
884
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
885
|
+
<h3 class="tsd-anchor-link" id="metricthrottles"><span>metric<wbr/>Throttles</span><a href="#metricthrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
886
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
887
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
888
|
+
<div class="tsd-signature tsd-anchor-link" id="metricthrottles-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
889
|
+
<div class="tsd-description">
|
|
890
|
+
<div class="tsd-comment tsd-typography"><p>How often this Lambda is throttled</p>
|
|
241
891
|
<p>Sum over 5 minutes</p>
|
|
242
|
-
</div
|
|
243
|
-
|
|
892
|
+
</div>
|
|
893
|
+
<div class="tsd-parameters">
|
|
894
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
895
|
+
<ul class="tsd-parameter-list">
|
|
896
|
+
<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>
|
|
897
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
898
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricThrottles</p></aside></div></li></ul></section>
|
|
899
|
+
<section class="tsd-panel tsd-member">
|
|
900
|
+
<h3 class="tsd-anchor-link" id="settable"><span>set<wbr/>Table</span><a href="#settable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
901
|
+
<ul class="tsd-signatures">
|
|
902
|
+
<li class="">
|
|
903
|
+
<div class="tsd-signature tsd-anchor-link" id="settable-1"><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="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
904
|
+
<div class="tsd-description">
|
|
905
|
+
<div class="tsd-parameters">
|
|
906
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
907
|
+
<ul class="tsd-parameter-list">
|
|
908
|
+
<li><span><span class="tsd-kind-parameter">table</span>: <span class="tsd-signature-type">ITable</span></span></li>
|
|
909
|
+
<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>
|
|
910
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
911
|
+
<section class="tsd-panel tsd-member">
|
|
912
|
+
<h3 class="tsd-anchor-link" id="settimeout"><span>set<wbr/>Timeout</span><a href="#settimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
913
|
+
<ul class="tsd-signatures">
|
|
914
|
+
<li class="">
|
|
915
|
+
<div class="tsd-signature tsd-anchor-link" id="settimeout-1"><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="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
916
|
+
<div class="tsd-description">
|
|
917
|
+
<div class="tsd-parameters">
|
|
918
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
919
|
+
<ul class="tsd-parameter-list">
|
|
920
|
+
<li><span><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">Duration</span></span></li></ul></div>
|
|
921
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
922
|
+
<section class="tsd-panel tsd-member">
|
|
923
|
+
<h3 class="tsd-anchor-link" id="setuserpool"><span>set<wbr/>User<wbr/>Pool</span><a href="#setuserpool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
924
|
+
<ul class="tsd-signatures">
|
|
925
|
+
<li class="">
|
|
926
|
+
<div class="tsd-signature tsd-anchor-link" id="setuserpool-1"><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="" 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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
927
|
+
<div class="tsd-description">
|
|
928
|
+
<div class="tsd-parameters">
|
|
929
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
930
|
+
<ul class="tsd-parameter-list">
|
|
931
|
+
<li><span><span class="tsd-kind-parameter">userPool</span>: <span class="tsd-signature-type">IUserPool</span></span></li></ul></div>
|
|
932
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></div></li></ul></section>
|
|
933
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
934
|
+
<h3 class="tsd-anchor-link" id="tostring"><span>to<wbr/>String</span><a href="#tostring" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
935
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
936
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
937
|
+
<div class="tsd-signature tsd-anchor-link" id="tostring-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
938
|
+
<div class="tsd-description">
|
|
939
|
+
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
940
|
+
</div>
|
|
941
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
942
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.toString</p></aside></div></li></ul></section>
|
|
943
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
944
|
+
<h3 class="tsd-anchor-link" id="warninvokefunctionpermissions"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
945
|
+
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
946
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
947
|
+
<div class="tsd-signature tsd-anchor-link" id="warninvokefunctionpermissions-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
948
|
+
<div class="tsd-description">
|
|
949
|
+
<div class="tsd-parameters">
|
|
950
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
951
|
+
<ul class="tsd-parameter-list">
|
|
952
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li></ul></div>
|
|
953
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
954
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.warnInvokeFunctionPermissions</p></aside></div></li></ul></section>
|
|
955
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
956
|
+
<h3 class="tsd-anchor-link" id="with"><span>with</span><a href="#with" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
957
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
958
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
959
|
+
<div class="tsd-signature tsd-anchor-link" id="with-1"><span class="tsd-kind-call-signature">with</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IConstruct</span><a href="#with-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
960
|
+
<div class="tsd-description">
|
|
961
|
+
<div class="tsd-comment tsd-typography"><p>Applies one or more mixins to this construct.</p>
|
|
244
962
|
<p>Mixins are applied in order. The list of constructs is captured at the
|
|
245
963
|
start of the call, so constructs added by a mixin will not be visited.
|
|
246
964
|
Use multiple <code>with()</code> calls if subsequent mixins should apply to added
|
|
247
965
|
constructs.</p>
|
|
248
|
-
</div
|
|
249
|
-
|
|
250
|
-
<
|
|
966
|
+
</div>
|
|
967
|
+
<div class="tsd-parameters">
|
|
968
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
969
|
+
<ul class="tsd-parameter-list">
|
|
970
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">mixins</span>: <span class="tsd-signature-type">IMixin</span><span class="tsd-signature-symbol">[]</span></span>
|
|
971
|
+
<div class="tsd-comment tsd-typography"><p>The mixins to apply</p>
|
|
972
|
+
</div></li></ul></div>
|
|
973
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IConstruct</span></h4><p>This construct for chaining</p>
|
|
974
|
+
<aside class="tsd-sources">
|
|
975
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.with</p></aside></div></li></ul></section>
|
|
976
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
977
|
+
<h3 class="tsd-anchor-link" id="classifyversionproperty"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
978
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
979
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
980
|
+
<div class="tsd-signature tsd-anchor-link" id="classifyversionproperty-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
981
|
+
<div class="tsd-description">
|
|
982
|
+
<div class="tsd-comment tsd-typography"><p>Record whether specific properties in the <code>AWS::Lambda::Function</code> resource should
|
|
251
983
|
also be associated to the Version resource.
|
|
252
984
|
See 'currentVersion' section in the module README for more details.</p>
|
|
253
|
-
</div
|
|
254
|
-
|
|
255
|
-
|
|
985
|
+
</div>
|
|
986
|
+
<div class="tsd-parameters">
|
|
987
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
988
|
+
<ul class="tsd-parameter-list">
|
|
989
|
+
<li><span><span class="tsd-kind-parameter">propertyName</span>: <span class="tsd-signature-type">string</span></span>
|
|
990
|
+
<div class="tsd-comment tsd-typography"><p>The property to classify</p>
|
|
991
|
+
</div></li>
|
|
992
|
+
<li><span><span class="tsd-kind-parameter">locked</span>: <span class="tsd-signature-type">boolean</span></span>
|
|
993
|
+
<div class="tsd-comment tsd-typography"><p>whether the property should be associated to the version or not.</p>
|
|
994
|
+
</div></li></ul></div>
|
|
995
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
996
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.classifyVersionProperty</p></aside></div></li></ul></section>
|
|
997
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
998
|
+
<h3 class="tsd-anchor-link" id="fromfunctionarn"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
999
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1000
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1001
|
+
<div class="tsd-signature tsd-anchor-link" id="fromfunctionarn-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1002
|
+
<div class="tsd-description">
|
|
1003
|
+
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its ARN.</p>
|
|
256
1004
|
<p>For <code>Function.addPermissions()</code> to work on this imported lambda, make sure that is
|
|
257
1005
|
in the same account and region as the stack you are importing it into.</p>
|
|
258
|
-
</div
|
|
1006
|
+
</div>
|
|
1007
|
+
<div class="tsd-parameters">
|
|
1008
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1009
|
+
<ul class="tsd-parameter-list">
|
|
1010
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li>
|
|
1011
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
1012
|
+
<li><span><span class="tsd-kind-parameter">functionArn</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
1013
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><aside class="tsd-sources">
|
|
1014
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionArn</p></aside></div></li></ul></section>
|
|
1015
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1016
|
+
<h3 class="tsd-anchor-link" id="fromfunctionattributes"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1017
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1018
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1019
|
+
<div class="tsd-signature tsd-anchor-link" id="fromfunctionattributes-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1020
|
+
<div class="tsd-description">
|
|
1021
|
+
<div class="tsd-comment tsd-typography"><p>Creates a Lambda function object which represents a function not defined
|
|
259
1022
|
within this stack.</p>
|
|
260
1023
|
<p>For <code>Function.addPermissions()</code> to work on this imported lambda, set the sameEnvironment property to true
|
|
261
1024
|
if this imported lambda is in the same account and region as the stack you are importing it into.</p>
|
|
262
|
-
</div
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
1025
|
+
</div>
|
|
1026
|
+
<div class="tsd-parameters">
|
|
1027
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1028
|
+
<ul class="tsd-parameter-list">
|
|
1029
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span>
|
|
1030
|
+
<div class="tsd-comment tsd-typography"><p>The parent construct</p>
|
|
1031
|
+
</div></li>
|
|
1032
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
|
|
1033
|
+
<div class="tsd-comment tsd-typography"><p>The name of the lambda construct</p>
|
|
1034
|
+
</div></li>
|
|
1035
|
+
<li><span><span class="tsd-kind-parameter">attrs</span>: <span class="tsd-signature-type">FunctionAttributes</span></span>
|
|
1036
|
+
<div class="tsd-comment tsd-typography"><p>the attributes of the function to import</p>
|
|
1037
|
+
</div></li></ul></div>
|
|
1038
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><aside class="tsd-sources">
|
|
1039
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionAttributes</p></aside></div></li></ul></section>
|
|
1040
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1041
|
+
<h3 class="tsd-anchor-link" id="fromfunctionname"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1042
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1043
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1044
|
+
<div class="tsd-signature tsd-anchor-link" id="fromfunctionname-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1045
|
+
<div class="tsd-description">
|
|
1046
|
+
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its name</p>
|
|
1047
|
+
</div>
|
|
1048
|
+
<div class="tsd-parameters">
|
|
1049
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1050
|
+
<ul class="tsd-parameter-list">
|
|
1051
|
+
<li><span><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type">Construct</span></span></li>
|
|
1052
|
+
<li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
1053
|
+
<li><span><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
1054
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFunction</span></h4><aside class="tsd-sources">
|
|
1055
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionName</p></aside></div></li></ul></section>
|
|
1056
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1057
|
+
<h3 class="tsd-anchor-link" id="isconstruct"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1058
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1059
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1060
|
+
<div class="tsd-signature tsd-anchor-link" id="isconstruct-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1061
|
+
<div class="tsd-description">
|
|
1062
|
+
<div class="tsd-comment tsd-typography"><p>Checks if <code>x</code> is a construct.</p>
|
|
267
1063
|
<p>Use this method instead of <code>instanceof</code> to properly detect <code>Construct</code>
|
|
268
1064
|
instances, even when the construct library is symlinked.</p>
|
|
269
1065
|
<p>Explanation: in JavaScript, multiple copies of the <code>constructs</code> library on
|
|
@@ -276,33 +1072,205 @@ use a monorepo tool: in those cases, multiple copies of the <code>constructs</co
|
|
|
276
1072
|
library can be accidentally installed, and <code>instanceof</code> will behave
|
|
277
1073
|
unpredictably. It is safest to avoid using <code>instanceof</code>, and using
|
|
278
1074
|
this type-testing method instead.</p>
|
|
279
|
-
</div
|
|
280
|
-
|
|
281
|
-
<
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
</div
|
|
1075
|
+
</div>
|
|
1076
|
+
<div class="tsd-parameters">
|
|
1077
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1078
|
+
<ul class="tsd-parameter-list">
|
|
1079
|
+
<li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></span>
|
|
1080
|
+
<div class="tsd-comment tsd-typography"><p>Any object</p>
|
|
1081
|
+
</div></li></ul></div>
|
|
1082
|
+
<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>
|
|
1083
|
+
<aside class="tsd-sources">
|
|
1084
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.isConstruct</p></aside></div></li></ul></section>
|
|
1085
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1086
|
+
<h3 class="tsd-anchor-link" id="isownedresource"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1087
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1088
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1089
|
+
<div class="tsd-signature tsd-anchor-link" id="isownedresource-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1090
|
+
<div class="tsd-description">
|
|
1091
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the construct was created by CDK, and false otherwise</p>
|
|
1092
|
+
</div>
|
|
1093
|
+
<div class="tsd-parameters">
|
|
1094
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1095
|
+
<ul class="tsd-parameter-list">
|
|
1096
|
+
<li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div>
|
|
1097
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
1098
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.isOwnedResource</p></aside></div></li></ul></section>
|
|
1099
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1100
|
+
<h3 class="tsd-anchor-link" id="isresource"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1101
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1102
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1103
|
+
<div class="tsd-signature tsd-anchor-link" id="isresource-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1104
|
+
<div class="tsd-description">
|
|
1105
|
+
<div class="tsd-comment tsd-typography"><p>Check whether the given construct is a Resource</p>
|
|
1106
|
+
</div>
|
|
1107
|
+
<div class="tsd-parameters">
|
|
1108
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1109
|
+
<ul class="tsd-parameter-list">
|
|
1110
|
+
<li><span><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type">IConstruct</span></span></li></ul></div>
|
|
1111
|
+
<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><aside class="tsd-sources">
|
|
1112
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.isResource</p></aside></div></li></ul></section>
|
|
1113
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1114
|
+
<h3 class="tsd-anchor-link" id="metricall"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1115
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1116
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1117
|
+
<div class="tsd-signature tsd-anchor-link" id="metricall-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1118
|
+
<div class="tsd-description">
|
|
1119
|
+
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Lambda</p>
|
|
1120
|
+
</div>
|
|
1121
|
+
<div class="tsd-parameters">
|
|
1122
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1123
|
+
<ul class="tsd-parameter-list">
|
|
1124
|
+
<li><span><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></span></li>
|
|
1125
|
+
<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>
|
|
1126
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4><aside class="tsd-sources">
|
|
1127
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAll</p></aside></div></li></ul></section>
|
|
1128
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1129
|
+
<h3 class="tsd-anchor-link" id="metricallconcurrentexecutions"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1130
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1131
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1132
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallconcurrentexecutions-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1133
|
+
<div class="tsd-description">
|
|
1134
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the number of concurrent executions across all Lambdas</p>
|
|
1135
|
+
</div>
|
|
1136
|
+
<div class="tsd-parameters">
|
|
1137
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1138
|
+
<ul class="tsd-parameter-list">
|
|
1139
|
+
<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>
|
|
1140
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1141
|
+
<div class="tsd-comment tsd-typography">
|
|
1142
|
+
<div class="tsd-tag-default">
|
|
1143
|
+
<h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
286
1144
|
</code><button type="button">Copy</button></pre>
|
|
287
1145
|
|
|
288
|
-
</div></div><aside class="tsd-sources"
|
|
289
|
-
|
|
1146
|
+
</div></div><aside class="tsd-sources">
|
|
1147
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllConcurrentExecutions</p></aside></div></li></ul></section>
|
|
1148
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1149
|
+
<h3 class="tsd-anchor-link" id="metricallduration"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1150
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1151
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1152
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallduration-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1153
|
+
<div class="tsd-description">
|
|
1154
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the Duration executing all Lambdas</p>
|
|
1155
|
+
</div>
|
|
1156
|
+
<div class="tsd-parameters">
|
|
1157
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1158
|
+
<ul class="tsd-parameter-list">
|
|
1159
|
+
<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>
|
|
1160
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1161
|
+
<div class="tsd-comment tsd-typography">
|
|
1162
|
+
<div class="tsd-tag-default">
|
|
1163
|
+
<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
290
1164
|
</code><button type="button">Copy</button></pre>
|
|
291
1165
|
|
|
292
|
-
</div></div><aside class="tsd-sources"
|
|
293
|
-
|
|
1166
|
+
</div></div><aside class="tsd-sources">
|
|
1167
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllDuration</p></aside></div></li></ul></section>
|
|
1168
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1169
|
+
<h3 class="tsd-anchor-link" id="metricallerrors"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1170
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1171
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1172
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallerrors-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1173
|
+
<div class="tsd-description">
|
|
1174
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the number of Errors executing all Lambdas</p>
|
|
1175
|
+
</div>
|
|
1176
|
+
<div class="tsd-parameters">
|
|
1177
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1178
|
+
<ul class="tsd-parameter-list">
|
|
1179
|
+
<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>
|
|
1180
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1181
|
+
<div class="tsd-comment tsd-typography">
|
|
1182
|
+
<div class="tsd-tag-default">
|
|
1183
|
+
<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
294
1184
|
</code><button type="button">Copy</button></pre>
|
|
295
1185
|
|
|
296
|
-
</div></div><aside class="tsd-sources"
|
|
297
|
-
|
|
1186
|
+
</div></div><aside class="tsd-sources">
|
|
1187
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllErrors</p></aside></div></li></ul></section>
|
|
1188
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1189
|
+
<h3 class="tsd-anchor-link" id="metricallinvocations"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1190
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1191
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1192
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallinvocations-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1193
|
+
<div class="tsd-description">
|
|
1194
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the number of invocations of all Lambdas</p>
|
|
1195
|
+
</div>
|
|
1196
|
+
<div class="tsd-parameters">
|
|
1197
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1198
|
+
<ul class="tsd-parameter-list">
|
|
1199
|
+
<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>
|
|
1200
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1201
|
+
<div class="tsd-comment tsd-typography">
|
|
1202
|
+
<div class="tsd-tag-default">
|
|
1203
|
+
<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
298
1204
|
</code><button type="button">Copy</button></pre>
|
|
299
1205
|
|
|
300
|
-
</div></div><aside class="tsd-sources"
|
|
301
|
-
|
|
1206
|
+
</div></div><aside class="tsd-sources">
|
|
1207
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllInvocations</p></aside></div></li></ul></section>
|
|
1208
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1209
|
+
<h3 class="tsd-anchor-link" id="metricallthrottles"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1210
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1211
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1212
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallthrottles-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1213
|
+
<div class="tsd-description">
|
|
1214
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the number of throttled invocations of all Lambdas</p>
|
|
1215
|
+
</div>
|
|
1216
|
+
<div class="tsd-parameters">
|
|
1217
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1218
|
+
<ul class="tsd-parameter-list">
|
|
1219
|
+
<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>
|
|
1220
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1221
|
+
<div class="tsd-comment tsd-typography">
|
|
1222
|
+
<div class="tsd-tag-default">
|
|
1223
|
+
<h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
302
1224
|
</code><button type="button">Copy</button></pre>
|
|
303
1225
|
|
|
304
|
-
</div></div><aside class="tsd-sources"
|
|
305
|
-
|
|
1226
|
+
</div></div><aside class="tsd-sources">
|
|
1227
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllThrottles</p></aside></div></li></ul></section>
|
|
1228
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
1229
|
+
<h3 class="tsd-anchor-link" id="metricallunreservedconcurrentexecutions"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
1230
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
1231
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
1232
|
+
<div class="tsd-signature tsd-anchor-link" id="metricallunreservedconcurrentexecutions-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
1233
|
+
<div class="tsd-description">
|
|
1234
|
+
<div class="tsd-comment tsd-typography"><p>Metric for the number of unreserved concurrent executions across all Lambdas</p>
|
|
1235
|
+
</div>
|
|
1236
|
+
<div class="tsd-parameters">
|
|
1237
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1238
|
+
<ul class="tsd-parameter-list">
|
|
1239
|
+
<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>
|
|
1240
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Metric</span></h4>
|
|
1241
|
+
<div class="tsd-comment tsd-typography">
|
|
1242
|
+
<div class="tsd-tag-default">
|
|
1243
|
+
<h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-9">5</span><span class="hl-1"> </span><span class="hl-4">minutes</span>
|
|
306
1244
|
</code><button type="button">Copy</button></pre>
|
|
307
1245
|
|
|
308
|
-
</div></div><aside class="tsd-sources"><p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><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" aria-hidden="true"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic</span></a><a href="#grantprincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a><a href="#tenancyconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tenancy<wbr/>Config</span></a><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout</span></a><a href="#property_injection_id" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>PROPERTY_<wbr/>INJECTION_<wbr/>ID</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" aria-hidden="true"><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" aria-label="Accessor"><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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>current<wbr/>Version</span></a><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>function<wbr/>Name</span></a><a href="#functionref" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>function<wbr/>Ref</span></a><a href="#isboundtovpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><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" aria-label="Accessor"><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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>log<wbr/>Group</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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>physical<wbr/>Name</span></a><a href="#resourcearnsforgrantinvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>stack</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" aria-hidden="true"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a><a href="#grantdeleteasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Version</span></a><a href="#grantreadassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Read<wbr/>Assets</span></a><a href="#grantsendemails"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a><a href="#granttablewrite"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a><a href="#grantuploadassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a><a href="#grantuserpoolread"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a><a href="#grantuserpoolreadwrite"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a><a href="#settable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Table</span></a><a href="#settimeout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a><a href="#setuserpool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a><a href="#with" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a><a href="#classifyversionproperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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>
|
|
1246
|
+
</div></div><aside class="tsd-sources">
|
|
1247
|
+
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></div></li></ul></section></section></details></div>
|
|
1248
|
+
<div class="col-sidebar">
|
|
1249
|
+
<div class="page-menu">
|
|
1250
|
+
<div class="tsd-navigation settings">
|
|
1251
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1252
|
+
<h3>Settings</h3></summary>
|
|
1253
|
+
<div class="tsd-accordion-details">
|
|
1254
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
1255
|
+
<ul id="tsd-filter-options">
|
|
1256
|
+
<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>
|
|
1257
|
+
<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>
|
|
1258
|
+
<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>
|
|
1259
|
+
<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>
|
|
1260
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
1261
|
+
<h3>On This Page</h3></summary>
|
|
1262
|
+
<div class="tsd-accordion-details">
|
|
1263
|
+
<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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
1264
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
1265
|
+
<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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
1266
|
+
<div><a href="#architecture" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic</span></a><a href="#grantprincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a><a href="#tenancyconfig" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tenancy<wbr/>Config</span></a><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout</span></a><a href="#property_injection_id" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>PROPERTY_<wbr/>INJECTION_<wbr/>ID</span></a></div></details>
|
|
1267
|
+
<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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary>
|
|
1268
|
+
<div><a href="#connections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>current<wbr/>Version</span></a><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>function<wbr/>Name</span></a><a href="#functionref" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>function<wbr/>Ref</span></a><a href="#isboundtovpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><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" aria-label="Accessor"><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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>log<wbr/>Group</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" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>physical<wbr/>Name</span></a><a href="#resourcearnsforgrantinvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>stack</span></a></div></details>
|
|
1269
|
+
<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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
1270
|
+
<div><a href="#addalias" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a><a href="#applycrossstackreferencestrength" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Cross<wbr/>Stack<wbr/>Reference<wbr/>Strength</span></a><a href="#applyremovalpolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a><a href="#grantdeleteasset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Version</span></a><a href="#grantreadassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Read<wbr/>Assets</span></a><a href="#grantsendemails"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a><a href="#granttablewrite"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a><a href="#grantuploadassets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a><a href="#grantuserpoolread"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a><a href="#grantuserpoolreadwrite"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a><a href="#settable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Table</span></a><a href="#settimeout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a><a href="#setuserpool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a><a href="#with" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with</span></a><a href="#classifyversionproperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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>
|
|
1271
|
+
<div class="site-menu">
|
|
1272
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
1273
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
1274
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
1275
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
1276
|
+
<div class="overlay"></div></body></html>
|