cdk-serverless 2.1.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +1 -0
- package/docs/constructs/assets/highlight.css +14 -14
- package/docs/constructs/assets/main.js +3 -3
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +6 -4
- package/docs/constructs/classes/AssetCdn.html +62 -55
- package/docs/constructs/classes/BaseApi.html +54 -46
- package/docs/constructs/classes/CognitoAuthentication.html +64 -56
- package/docs/constructs/classes/GraphQlApi.html +384 -0
- package/docs/constructs/classes/LambdaFunction.html +433 -367
- package/docs/constructs/classes/RestApi.html +110 -97
- package/docs/constructs/classes/SingleTableDatastore.html +56 -49
- package/docs/constructs/classes/Workflow.html +62 -55
- package/docs/constructs/index.html +26 -23
- package/docs/constructs/interfaces/AssetCdnProps.html +35 -30
- package/docs/constructs/interfaces/BaseApiProps.html +73 -61
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +61 -48
- package/docs/constructs/interfaces/GraphQlApiProps.html +205 -0
- package/docs/constructs/interfaces/ICognitoAuthentication.html +30 -26
- package/docs/constructs/interfaces/IJwtAuthentication.html +40 -34
- package/docs/constructs/interfaces/LambdaFunctionProps.html +97 -80
- package/docs/constructs/interfaces/LambdaTracingOptions.html +31 -27
- package/docs/constructs/interfaces/RestApiProps.html +108 -92
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +44 -38
- package/docs/constructs/interfaces/SingleTableDesign.html +46 -39
- package/docs/constructs/interfaces/VtlResolverOptions.html +102 -0
- package/docs/constructs/interfaces/WorkflowProps.html +40 -37
- package/docs/constructs/modules.html +46 -40
- package/docs/constructs/types/LambdaOptions.html +24 -21
- package/docs/lambda/assets/highlight.css +11 -4
- package/docs/lambda/assets/main.js +3 -3
- package/docs/lambda/assets/style.css +6 -4
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +113 -120
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +108 -116
- package/docs/lambda/classes/auth.JwtAuthorizer.html +108 -116
- package/docs/lambda/classes/errors.BadRequestError.html +43 -67
- package/docs/lambda/classes/errors.ForbiddenError.html +43 -67
- package/docs/lambda/classes/errors.HttpError.html +43 -67
- package/docs/lambda/classes/errors.NotFoundError.html +43 -67
- package/docs/lambda/classes/errors.UnauthenticatedError.html +43 -67
- package/docs/lambda/functions/api.createAppSyncHandler.html +23 -39
- package/docs/lambda/functions/api.createHttpHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +21 -38
- package/docs/lambda/index.html +7 -41
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +33 -50
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +36 -53
- package/docs/lambda/interfaces/api.HttpResponseContext.html +30 -47
- package/docs/lambda/interfaces/api.Operation.html +24 -41
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +27 -44
- package/docs/lambda/modules/api.html +31 -49
- package/docs/lambda/modules/auth.html +19 -43
- package/docs/lambda/modules/errors.html +15 -41
- package/docs/lambda/modules.html +8 -42
- package/docs/lambda/types/api.APIGatewayv1Handler.html +20 -37
- package/docs/lambda/types/api.AppSyncHandler.html +20 -37
- package/docs/lambda/types/api.HttpHandler.html +20 -37
- package/docs/projen/assets/highlight.css +25 -18
- package/docs/projen/assets/main.js +3 -3
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +6 -4
- package/docs/projen/classes/Datastore.html +54 -49
- package/docs/projen/classes/GraphQlApi.html +155 -0
- package/docs/projen/classes/RestApi.html +54 -49
- package/docs/projen/classes/ServerlessProject.html +590 -461
- package/docs/projen/classes/Workflow.html +54 -49
- package/docs/projen/index.html +15 -13
- package/docs/projen/interfaces/DatastoreOptions.html +20 -18
- package/docs/projen/interfaces/GraphQlApiOptions.html +77 -0
- package/docs/projen/interfaces/RestApiOptions.html +20 -18
- package/docs/projen/interfaces/ServerlessProjectOptions.html +979 -808
- package/docs/projen/interfaces/WorkflowOptions.html +20 -18
- package/docs/projen/modules.html +24 -20
- package/docs/projen/variables/PACKAGE_NAME.html +13 -11
- package/lib/constructs/graphql.d.ts +52 -0
- package/lib/constructs/graphql.js +310 -0
- package/lib/constructs/index.d.ts +1 -0
- package/lib/constructs/index.js +2 -1
- package/lib/projen/core.js +1 -2
- package/lib/projen/datastore.js +3 -4
- package/lib/projen/graphql.d.ts +10 -0
- package/lib/projen/graphql.js +90 -0
- package/lib/projen/index.d.ts +1 -0
- package/lib/projen/index.js +2 -2
- package/lib/projen/rest-api.js +3 -1
- package/package.json +8 -8
|
@@ -28,91 +28,91 @@
|
|
|
28
28
|
<div class="tsd-accordion-details">
|
|
29
29
|
<section class="tsd-index-section">
|
|
30
30
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
31
|
-
<div class="tsd-index-list"><a href="LambdaFunction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
31
|
+
<div class="tsd-index-list"><a href="LambdaFunction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
|
|
32
32
|
</div></section>
|
|
33
33
|
<section class="tsd-index-section">
|
|
34
34
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
35
|
-
<div class="tsd-index-list"><a href="LambdaFunction.html#architecture" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
36
|
-
<a href="LambdaFunction.html#canCreatePermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
37
|
-
<a href="LambdaFunction.html#deadLetterQueue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
38
|
-
<a href="LambdaFunction.html#deadLetterTopic" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
39
|
-
<a href="LambdaFunction.html#env" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
40
|
-
<a href="LambdaFunction.html#functionArn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="LambdaFunction.html#functionName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="LambdaFunction.html#grantPrincipal" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="LambdaFunction.html#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
44
|
-
<a href="LambdaFunction.html#permissionsNode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
45
|
-
<a href="LambdaFunction.html#physicalName" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
46
|
-
<a href="LambdaFunction.html#props" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon"
|
|
47
|
-
<a href="LambdaFunction.html#role" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
48
|
-
<a href="LambdaFunction.html#runtime" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
49
|
-
<a href="LambdaFunction.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
50
|
-
<a href="LambdaFunction.html#timeout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
35
|
+
<div class="tsd-index-list"><a href="LambdaFunction.html#architecture" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>architecture</span></a>
|
|
36
|
+
<a href="LambdaFunction.html#canCreatePermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a>
|
|
37
|
+
<a href="LambdaFunction.html#deadLetterQueue" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue?</span></a>
|
|
38
|
+
<a href="LambdaFunction.html#deadLetterTopic" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic?</span></a>
|
|
39
|
+
<a href="LambdaFunction.html#env" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>env</span></a>
|
|
40
|
+
<a href="LambdaFunction.html#functionArn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Arn</span></a>
|
|
41
|
+
<a href="LambdaFunction.html#functionName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Name</span></a>
|
|
42
|
+
<a href="LambdaFunction.html#grantPrincipal" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>grant<wbr/>Principal</span></a>
|
|
43
|
+
<a href="LambdaFunction.html#node" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a>
|
|
44
|
+
<a href="LambdaFunction.html#permissionsNode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a>
|
|
45
|
+
<a href="LambdaFunction.html#physicalName" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>physical<wbr/>Name</span></a>
|
|
46
|
+
<a href="LambdaFunction.html#props" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a>
|
|
47
|
+
<a href="LambdaFunction.html#role" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>role?</span></a>
|
|
48
|
+
<a href="LambdaFunction.html#runtime" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>runtime</span></a>
|
|
49
|
+
<a href="LambdaFunction.html#stack" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stack</span></a>
|
|
50
|
+
<a href="LambdaFunction.html#timeout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>timeout?</span></a>
|
|
51
51
|
</div></section>
|
|
52
52
|
<section class="tsd-index-section">
|
|
53
53
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
54
|
-
<div class="tsd-index-list"><a href="LambdaFunction.html#connections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
55
|
-
<a href="LambdaFunction.html#currentVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
56
|
-
<a href="LambdaFunction.html#isBoundToVpc" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
57
|
-
<a href="LambdaFunction.html#latestVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
58
|
-
<a href="LambdaFunction.html#logGroup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
59
|
-
<a href="LambdaFunction.html#resourceArnsForGrantInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
54
|
+
<div class="tsd-index-list"><a href="LambdaFunction.html#connections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>connections</span></a>
|
|
55
|
+
<a href="LambdaFunction.html#currentVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>current<wbr/>Version</span></a>
|
|
56
|
+
<a href="LambdaFunction.html#isBoundToVpc" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span></a>
|
|
57
|
+
<a href="LambdaFunction.html#latestVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>latest<wbr/>Version</span></a>
|
|
58
|
+
<a href="LambdaFunction.html#logGroup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>log<wbr/>Group</span></a>
|
|
59
|
+
<a href="LambdaFunction.html#resourceArnsForGrantInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a>
|
|
60
60
|
</div></section>
|
|
61
61
|
<section class="tsd-index-section">
|
|
62
62
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
63
|
-
<div class="tsd-index-list"><a href="LambdaFunction.html#addAlias" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
64
|
-
<a href="LambdaFunction.html#addEnvironment" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
65
|
-
<a href="LambdaFunction.html#addEventSource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
66
|
-
<a href="LambdaFunction.html#addEventSourceMapping" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
67
|
-
<a href="LambdaFunction.html#addFunctionUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
68
|
-
<a href="LambdaFunction.html#addLayers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
69
|
-
<a href="LambdaFunction.html#addPermission" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
70
|
-
<a href="LambdaFunction.html#addToRolePolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
71
|
-
<a href="LambdaFunction.html#applyRemovalPolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
72
|
-
<a href="LambdaFunction.html#configureAsyncInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
73
|
-
<a href="LambdaFunction.html#considerWarningOnInvokeFunctionPermissions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
74
|
-
<a href="LambdaFunction.html#generatePhysicalName" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
75
|
-
<a href="LambdaFunction.html#getResourceArnAttribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
76
|
-
<a href="LambdaFunction.html#getResourceNameAttribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
77
|
-
<a href="LambdaFunction.html#grantDeleteAsset" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
78
|
-
<a href="LambdaFunction.html#grantInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
79
|
-
<a href="LambdaFunction.html#grantInvokeUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
80
|
-
<a href="LambdaFunction.html#grantSendEmails" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
81
|
-
<a href="LambdaFunction.html#grantTableWrite" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
82
|
-
<a href="LambdaFunction.html#grantUploadAssets" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
83
|
-
<a href="LambdaFunction.html#grantUserpoolRead" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
84
|
-
<a href="LambdaFunction.html#grantUserpoolReadWrite" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
85
|
-
<a href="LambdaFunction.html#metric" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
86
|
-
<a href="LambdaFunction.html#metricDuration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
87
|
-
<a href="LambdaFunction.html#metricErrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
88
|
-
<a href="LambdaFunction.html#metricInvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
89
|
-
<a href="LambdaFunction.html#metricThrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
90
|
-
<a href="LambdaFunction.html#setTable" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
91
|
-
<a href="LambdaFunction.html#setTimeout" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
92
|
-
<a href="LambdaFunction.html#setUserPool" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
93
|
-
<a href="LambdaFunction.html#toString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
94
|
-
<a href="LambdaFunction.html#warnInvokeFunctionPermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
95
|
-
<a href="LambdaFunction.html#classifyVersionProperty" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
96
|
-
<a href="LambdaFunction.html#fromFunctionArn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
97
|
-
<a href="LambdaFunction.html#fromFunctionAttributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
98
|
-
<a href="LambdaFunction.html#fromFunctionName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
99
|
-
<a href="LambdaFunction.html#isConstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
100
|
-
<a href="LambdaFunction.html#isOwnedResource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
101
|
-
<a href="LambdaFunction.html#isResource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
102
|
-
<a href="LambdaFunction.html#metricAll" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
103
|
-
<a href="LambdaFunction.html#metricAllConcurrentExecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
104
|
-
<a href="LambdaFunction.html#metricAllDuration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
105
|
-
<a href="LambdaFunction.html#metricAllErrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
106
|
-
<a href="LambdaFunction.html#metricAllInvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
107
|
-
<a href="LambdaFunction.html#metricAllThrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
108
|
-
<a href="LambdaFunction.html#metricAllUnreservedConcurrentExecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
63
|
+
<div class="tsd-index-list"><a href="LambdaFunction.html#addAlias" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>add<wbr/>Alias</span></a>
|
|
64
|
+
<a href="LambdaFunction.html#addEnvironment" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Environment</span></a>
|
|
65
|
+
<a href="LambdaFunction.html#addEventSource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a>
|
|
66
|
+
<a href="LambdaFunction.html#addEventSourceMapping" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a>
|
|
67
|
+
<a href="LambdaFunction.html#addFunctionUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Function<wbr/>Url</span></a>
|
|
68
|
+
<a href="LambdaFunction.html#addLayers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Layers</span></a>
|
|
69
|
+
<a href="LambdaFunction.html#addPermission" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Permission</span></a>
|
|
70
|
+
<a href="LambdaFunction.html#addToRolePolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a>
|
|
71
|
+
<a href="LambdaFunction.html#applyRemovalPolicy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a>
|
|
72
|
+
<a href="LambdaFunction.html#configureAsyncInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a>
|
|
73
|
+
<a href="LambdaFunction.html#considerWarningOnInvokeFunctionPermissions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a>
|
|
74
|
+
<a href="LambdaFunction.html#generatePhysicalName" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>generate<wbr/>Physical<wbr/>Name</span></a>
|
|
75
|
+
<a href="LambdaFunction.html#getResourceArnAttribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span></a>
|
|
76
|
+
<a href="LambdaFunction.html#getResourceNameAttribute" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a>
|
|
77
|
+
<a href="LambdaFunction.html#grantDeleteAsset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Delete<wbr/>Asset</span></a>
|
|
78
|
+
<a href="LambdaFunction.html#grantInvoke" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke</span></a>
|
|
79
|
+
<a href="LambdaFunction.html#grantInvokeUrl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Url</span></a>
|
|
80
|
+
<a href="LambdaFunction.html#grantSendEmails" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a>
|
|
81
|
+
<a href="LambdaFunction.html#grantTableWrite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a>
|
|
82
|
+
<a href="LambdaFunction.html#grantUploadAssets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a>
|
|
83
|
+
<a href="LambdaFunction.html#grantUserpoolRead" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a>
|
|
84
|
+
<a href="LambdaFunction.html#grantUserpoolReadWrite" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span></a>
|
|
85
|
+
<a href="LambdaFunction.html#metric" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric</span></a>
|
|
86
|
+
<a href="LambdaFunction.html#metricDuration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Duration</span></a>
|
|
87
|
+
<a href="LambdaFunction.html#metricErrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Errors</span></a>
|
|
88
|
+
<a href="LambdaFunction.html#metricInvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Invocations</span></a>
|
|
89
|
+
<a href="LambdaFunction.html#metricThrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a>
|
|
90
|
+
<a href="LambdaFunction.html#setTable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Table</span></a>
|
|
91
|
+
<a href="LambdaFunction.html#setTimeout" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a>
|
|
92
|
+
<a href="LambdaFunction.html#setUserPool" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Pool</span></a>
|
|
93
|
+
<a href="LambdaFunction.html#toString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a>
|
|
94
|
+
<a href="LambdaFunction.html#warnInvokeFunctionPermissions" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a>
|
|
95
|
+
<a href="LambdaFunction.html#classifyVersionProperty" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>classify<wbr/>Version<wbr/>Property</span></a>
|
|
96
|
+
<a href="LambdaFunction.html#fromFunctionArn" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Arn</span></a>
|
|
97
|
+
<a href="LambdaFunction.html#fromFunctionAttributes" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Attributes</span></a>
|
|
98
|
+
<a href="LambdaFunction.html#fromFunctionName" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Name</span></a>
|
|
99
|
+
<a href="LambdaFunction.html#isConstruct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
|
100
|
+
<a href="LambdaFunction.html#isOwnedResource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a>
|
|
101
|
+
<a href="LambdaFunction.html#isResource" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Resource</span></a>
|
|
102
|
+
<a href="LambdaFunction.html#metricAll" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All</span></a>
|
|
103
|
+
<a href="LambdaFunction.html#metricAllConcurrentExecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span></a>
|
|
104
|
+
<a href="LambdaFunction.html#metricAllDuration" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Duration</span></a>
|
|
105
|
+
<a href="LambdaFunction.html#metricAllErrors" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Errors</span></a>
|
|
106
|
+
<a href="LambdaFunction.html#metricAllInvocations" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a>
|
|
107
|
+
<a href="LambdaFunction.html#metricAllThrottles" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a>
|
|
108
|
+
<a href="LambdaFunction.html#metricAllUnreservedConcurrentExecutions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a>
|
|
109
109
|
</div></section></div></details></section></section>
|
|
110
110
|
<section class="tsd-panel-group tsd-member-group">
|
|
111
111
|
<h2>Constructors</h2>
|
|
112
112
|
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
113
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
113
|
+
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
114
114
|
<ul class="tsd-signatures">
|
|
115
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_LambdaFunction"><span class="tsd-kind-constructor-signature">new <wbr/>Lambda<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#constructor.new_LambdaFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
115
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_LambdaFunction"><span class="tsd-kind-constructor-signature">new <wbr/>Lambda<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#constructor.new_LambdaFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
116
116
|
<li class="tsd-description">
|
|
117
117
|
<div class="tsd-parameters">
|
|
118
118
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -128,63 +128,70 @@
|
|
|
128
128
|
<section class="tsd-panel-group tsd-member-group">
|
|
129
129
|
<h2>Properties</h2>
|
|
130
130
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="architecture" class="tsd-anchor"></a>
|
|
131
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>architecture</span><a href="#architecture" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
131
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>architecture</span><a href="#architecture" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
132
132
|
<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>
|
|
133
133
|
<div class="tsd-comment tsd-typography"><p>The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).</p>
|
|
134
|
-
</div
|
|
134
|
+
</div>
|
|
135
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
135
136
|
<p>Inherited from lambdaNodejs.NodejsFunction.architecture</p></aside></section>
|
|
136
137
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="canCreatePermissions" class="tsd-anchor"></a>
|
|
137
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>can<wbr/>Create<wbr/>Permissions</span><a href="#canCreatePermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
138
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>can<wbr/>Create<wbr/>Permissions</span><a href="#canCreatePermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
138
139
|
<div class="tsd-signature"><span class="tsd-kind-property">can<wbr/>Create<wbr/>Permissions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources">
|
|
139
140
|
<p>Inherited from lambdaNodejs.NodejsFunction.canCreatePermissions</p></aside></section>
|
|
140
141
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadLetterQueue" class="tsd-anchor"></a>
|
|
141
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Queue</span><a href="#deadLetterQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
142
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Queue</span><a href="#deadLetterQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
142
143
|
<div class="tsd-signature"><span class="tsd-kind-property">dead<wbr/>Letter<wbr/>Queue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IQueue</span></div>
|
|
143
144
|
<div class="tsd-comment tsd-typography"><p>The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).</p>
|
|
144
|
-
</div
|
|
145
|
+
</div>
|
|
146
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
145
147
|
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterQueue</p></aside></section>
|
|
146
148
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="deadLetterTopic" class="tsd-anchor"></a>
|
|
147
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Topic</span><a href="#deadLetterTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
149
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dead<wbr/>Letter<wbr/>Topic</span><a href="#deadLetterTopic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
148
150
|
<div class="tsd-signature"><span class="tsd-kind-property">dead<wbr/>Letter<wbr/>Topic</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ITopic</span></div>
|
|
149
151
|
<div class="tsd-comment tsd-typography"><p>The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).</p>
|
|
150
|
-
</div
|
|
152
|
+
</div>
|
|
153
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
151
154
|
<p>Inherited from lambdaNodejs.NodejsFunction.deadLetterTopic</p></aside></section>
|
|
152
155
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="env" class="tsd-anchor"></a>
|
|
153
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
156
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
154
157
|
<div class="tsd-signature"><span class="tsd-kind-property">env</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ResourceEnvironment</span></div><aside class="tsd-sources">
|
|
155
158
|
<p>Inherited from lambdaNodejs.NodejsFunction.env</p></aside></section>
|
|
156
159
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionArn" class="tsd-anchor"></a>
|
|
157
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Arn</span><a href="#functionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
160
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Arn</span><a href="#functionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
158
161
|
<div class="tsd-signature"><span class="tsd-kind-property">function<wbr/>Arn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
159
162
|
<div class="tsd-comment tsd-typography"><p>ARN of this function</p>
|
|
160
|
-
</div
|
|
163
|
+
</div>
|
|
164
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
161
165
|
<p>Inherited from lambdaNodejs.NodejsFunction.functionArn</p></aside></section>
|
|
162
166
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="functionName" class="tsd-anchor"></a>
|
|
163
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Name</span><a href="#functionName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
167
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>function<wbr/>Name</span><a href="#functionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
164
168
|
<div class="tsd-signature"><span class="tsd-kind-property">function<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
165
169
|
<div class="tsd-comment tsd-typography"><p>Name of this function</p>
|
|
166
|
-
</div
|
|
170
|
+
</div>
|
|
171
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
167
172
|
<p>Inherited from lambdaNodejs.NodejsFunction.functionName</p></aside></section>
|
|
168
173
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantPrincipal" class="tsd-anchor"></a>
|
|
169
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>grant<wbr/>Principal</span><a href="#grantPrincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
174
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>grant<wbr/>Principal</span><a href="#grantPrincipal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
170
175
|
<div class="tsd-signature"><span class="tsd-kind-property">grant<wbr/>Principal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">IPrincipal</span></div>
|
|
171
176
|
<div class="tsd-comment tsd-typography"><p>The principal this Lambda Function is running as</p>
|
|
172
|
-
</div
|
|
177
|
+
</div>
|
|
178
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
173
179
|
<p>Inherited from lambdaNodejs.NodejsFunction.grantPrincipal</p></aside></section>
|
|
174
180
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a>
|
|
175
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
181
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
176
182
|
<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>
|
|
177
183
|
<div class="tsd-comment tsd-typography"><p>The tree node.</p>
|
|
178
|
-
|
|
179
|
-
<
|
|
184
|
+
</div>
|
|
185
|
+
<div class="tsd-comment tsd-typography">
|
|
186
|
+
<h4>Stability</h4><p>stable</p>
|
|
180
187
|
</div><aside class="tsd-sources">
|
|
181
188
|
<p>Inherited from lambdaNodejs.NodejsFunction.node</p></aside></section>
|
|
182
189
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="permissionsNode" class="tsd-anchor"></a>
|
|
183
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>permissions<wbr/>Node</span><a href="#permissionsNode" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
190
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>permissions<wbr/>Node</span><a href="#permissionsNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
184
191
|
<div class="tsd-signature"><span class="tsd-kind-property">permissions<wbr/>Node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Node</span></div><aside class="tsd-sources">
|
|
185
192
|
<p>Inherited from lambdaNodejs.NodejsFunction.permissionsNode</p></aside></section>
|
|
186
193
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="physicalName" class="tsd-anchor"></a>
|
|
187
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>physical<wbr/>Name</span><a href="#physicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
194
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>physical<wbr/>Name</span><a href="#physicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
188
195
|
<div class="tsd-signature"><span class="tsd-kind-property">physical<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
189
196
|
<div class="tsd-comment tsd-typography"><p>Returns a string-encoded token that resolves to the physical name that
|
|
190
197
|
should be passed to the CloudFormation resource.</p>
|
|
@@ -195,47 +202,52 @@ should be passed to the CloudFormation resource.</p>
|
|
|
195
202
|
<li>a concrete name generated automatically during synthesis, in
|
|
196
203
|
cross-environment scenarios.</li>
|
|
197
204
|
</ul>
|
|
198
|
-
</div
|
|
205
|
+
</div>
|
|
206
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
199
207
|
<p>Inherited from lambdaNodejs.NodejsFunction.physicalName</p></aside></section>
|
|
200
208
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="props" class="tsd-anchor"></a>
|
|
201
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
209
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
202
210
|
<div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionProps.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionProps</a></div></section>
|
|
203
211
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="role" class="tsd-anchor"></a>
|
|
204
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
212
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>role</span><a href="#role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
205
213
|
<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>
|
|
206
214
|
<div class="tsd-comment tsd-typography"><p>Execution role associated with this function</p>
|
|
207
|
-
</div
|
|
215
|
+
</div>
|
|
216
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
208
217
|
<p>Inherited from lambdaNodejs.NodejsFunction.role</p></aside></section>
|
|
209
218
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runtime" class="tsd-anchor"></a>
|
|
210
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
219
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
211
220
|
<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>
|
|
212
221
|
<div class="tsd-comment tsd-typography"><p>The runtime configured for this lambda.</p>
|
|
213
|
-
</div
|
|
222
|
+
</div>
|
|
223
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
214
224
|
<p>Inherited from lambdaNodejs.NodejsFunction.runtime</p></aside></section>
|
|
215
225
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
|
|
216
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
226
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
217
227
|
<div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Stack</span></div><aside class="tsd-sources">
|
|
218
228
|
<p>Inherited from lambdaNodejs.NodejsFunction.stack</p></aside></section>
|
|
219
229
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="timeout" class="tsd-anchor"></a>
|
|
220
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
230
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
221
231
|
<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>
|
|
222
232
|
<div class="tsd-comment tsd-typography"><p>The timeout configured for this lambda.</p>
|
|
223
|
-
</div
|
|
233
|
+
</div>
|
|
234
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
224
235
|
<p>Inherited from lambdaNodejs.NodejsFunction.timeout</p></aside></section></section>
|
|
225
236
|
<section class="tsd-panel-group tsd-member-group">
|
|
226
237
|
<h2>Accessors</h2>
|
|
227
238
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="connections" class="tsd-anchor"></a>
|
|
228
|
-
<h3 class="tsd-anchor-link"><span>connections</span><a href="#connections" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
239
|
+
<h3 class="tsd-anchor-link"><span>connections</span><a href="#connections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
229
240
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
230
241
|
<li class="tsd-signature" id="connections.connections-1"><span class="tsd-signature-symbol">get</span> connections<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Connections</span></li>
|
|
231
242
|
<li class="tsd-description">
|
|
232
243
|
<div class="tsd-comment tsd-typography"><p>Access the Connections object</p>
|
|
233
244
|
<p>Will fail if not a VPC-enabled Lambda Function</p>
|
|
234
245
|
</div>
|
|
235
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Connections</span></h4
|
|
246
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Connections</span></h4>
|
|
247
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
236
248
|
<p>Inherited from lambdaNodejs.NodejsFunction.connections</p></aside></li></ul></section>
|
|
237
249
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="currentVersion" class="tsd-anchor"></a>
|
|
238
|
-
<h3 class="tsd-anchor-link"><span>current<wbr/>Version</span><a href="#currentVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
250
|
+
<h3 class="tsd-anchor-link"><span>current<wbr/>Version</span><a href="#currentVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
239
251
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
240
252
|
<li class="tsd-signature" id="currentVersion.currentVersion-1"><span class="tsd-signature-symbol">get</span> currentVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Version</span></li>
|
|
241
253
|
<li class="tsd-description">
|
|
@@ -245,27 +257,29 @@ configuration changes.</p>
|
|
|
245
257
|
<p>You can specify options for this version using the <code>currentVersionOptions</code>
|
|
246
258
|
prop when initializing the <code>lambda.Function</code>.</p>
|
|
247
259
|
</div>
|
|
248
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Version</span></h4
|
|
260
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Version</span></h4>
|
|
261
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
249
262
|
<p>Inherited from lambdaNodejs.NodejsFunction.currentVersion</p></aside></li></ul></section>
|
|
250
263
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isBoundToVpc" class="tsd-anchor"></a>
|
|
251
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span><a href="#isBoundToVpc" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
264
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span><a href="#isBoundToVpc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
252
265
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
253
266
|
<li class="tsd-signature" id="isBoundToVpc.isBoundToVpc-1"><span class="tsd-signature-symbol">get</span> isBoundToVpc<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
254
267
|
<li class="tsd-description">
|
|
255
268
|
<div class="tsd-comment tsd-typography"><p>Whether or not this Lambda function was bound to a VPC</p>
|
|
256
269
|
<p>If this is is <code>false</code>, trying to access the <code>connections</code> object will fail.</p>
|
|
257
270
|
</div>
|
|
258
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
271
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
272
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
259
273
|
<p>Inherited from lambdaNodejs.NodejsFunction.isBoundToVpc</p></aside></li></ul></section>
|
|
260
274
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="latestVersion" class="tsd-anchor"></a>
|
|
261
|
-
<h3 class="tsd-anchor-link"><span>latest<wbr/>Version</span><a href="#latestVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
275
|
+
<h3 class="tsd-anchor-link"><span>latest<wbr/>Version</span><a href="#latestVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
262
276
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
263
277
|
<li class="tsd-signature" id="latestVersion.latestVersion-1"><span class="tsd-signature-symbol">get</span> latestVersion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IVersion</span></li>
|
|
264
278
|
<li class="tsd-description">
|
|
265
279
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IVersion</span></h4><aside class="tsd-sources">
|
|
266
280
|
<p>Inherited from lambdaNodejs.NodejsFunction.latestVersion</p></aside></li></ul></section>
|
|
267
281
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="logGroup" class="tsd-anchor"></a>
|
|
268
|
-
<h3 class="tsd-anchor-link"><span>log<wbr/>Group</span><a href="#logGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
282
|
+
<h3 class="tsd-anchor-link"><span>log<wbr/>Group</span><a href="#logGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
269
283
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
270
284
|
<li class="tsd-signature" id="logGroup.logGroup-1"><span class="tsd-signature-symbol">get</span> logGroup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">ILogGroup</span></li>
|
|
271
285
|
<li class="tsd-description">
|
|
@@ -276,10 +290,11 @@ period (never expire, by default).</p>
|
|
|
276
290
|
<p>Further, if the log group already exists and the <code>logRetention</code> is not set, the custom resource will reset the log retention
|
|
277
291
|
to never expire even if it was configured with a different value.</p>
|
|
278
292
|
</div>
|
|
279
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">ILogGroup</span></h4
|
|
293
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">ILogGroup</span></h4>
|
|
294
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
280
295
|
<p>Inherited from lambdaNodejs.NodejsFunction.logGroup</p></aside></li></ul></section>
|
|
281
296
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="resourceArnsForGrantInvoke" class="tsd-anchor"></a>
|
|
282
|
-
<h3 class="tsd-anchor-link"><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span><a href="#resourceArnsForGrantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
297
|
+
<h3 class="tsd-anchor-link"><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span><a href="#resourceArnsForGrantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
283
298
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
284
299
|
<li class="tsd-signature" id="resourceArnsForGrantInvoke.resourceArnsForGrantInvoke-1"><span class="tsd-signature-symbol">get</span> resourceArnsForGrantInvoke<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li>
|
|
285
300
|
<li class="tsd-description">
|
|
@@ -288,14 +303,14 @@ to never expire even if it was configured with a different value.</p>
|
|
|
288
303
|
<section class="tsd-panel-group tsd-member-group">
|
|
289
304
|
<h2>Methods</h2>
|
|
290
305
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addAlias" class="tsd-anchor"></a>
|
|
291
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Alias</span><a href="#addAlias" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
306
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Alias</span><a href="#addAlias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
292
307
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
293
|
-
<li class="tsd-signature tsd-anchor-link" id="addAlias.addAlias-1"><span class="tsd-kind-call-signature">add<wbr/>Alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliasName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Alias</span><a href="#addAlias.addAlias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
308
|
+
<li class="tsd-signature tsd-anchor-link" id="addAlias.addAlias-1"><span class="tsd-kind-call-signature">add<wbr/>Alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliasName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Alias</span><a href="#addAlias.addAlias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
294
309
|
<li class="tsd-description">
|
|
295
310
|
<div class="tsd-comment tsd-typography"><p>Defines an alias for this function.</p>
|
|
296
311
|
<p>The alias will automatically be updated to point to the latest version of
|
|
297
312
|
the function as it is being updated during a deployment.</p>
|
|
298
|
-
<pre><code class="language-ts"><span class="hl-
|
|
313
|
+
<pre><code class="language-ts"><span class="hl-3">declare</span><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">fn</span><span class="hl-1">: </span><span class="hl-5">lambda</span><span class="hl-1">.</span><span class="hl-5">Function</span><span class="hl-1">;</span><br/><br/><span class="hl-6">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-7">// Is equivalent to</span><br/><br/><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-6">lambda</span><span class="hl-1">.</span><span class="hl-0">Alias</span><span class="hl-1">(</span><span class="hl-3">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-6">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-6">version:</span><span class="hl-1"> </span><span class="hl-6">fn</span><span class="hl-1">.</span><span class="hl-6">currentVersion</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
299
314
|
</code><button>Copy</button></pre>
|
|
300
315
|
</div>
|
|
301
316
|
<div class="tsd-parameters">
|
|
@@ -304,17 +319,20 @@ the function as it is being updated during a deployment.</p>
|
|
|
304
319
|
<li>
|
|
305
320
|
<h5><span class="tsd-kind-parameter">aliasName</span>: <span class="tsd-signature-type">string</span></h5>
|
|
306
321
|
<div class="tsd-comment tsd-typography"><p>The name of the alias</p>
|
|
307
|
-
</div
|
|
322
|
+
</div>
|
|
323
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
308
324
|
<li>
|
|
309
325
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AliasOptions</span></h5>
|
|
310
326
|
<div class="tsd-comment tsd-typography"><p>Alias options</p>
|
|
311
|
-
</div
|
|
312
|
-
<
|
|
327
|
+
</div>
|
|
328
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
329
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Alias</span></h4>
|
|
330
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
313
331
|
<p>Inherited from lambdaNodejs.NodejsFunction.addAlias</p></aside></li></ul></section>
|
|
314
332
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEnvironment" class="tsd-anchor"></a>
|
|
315
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Environment</span><a href="#addEnvironment" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
333
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Environment</span><a href="#addEnvironment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
316
334
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
317
|
-
<li class="tsd-signature tsd-anchor-link" id="addEnvironment.addEnvironment-1"><span class="tsd-kind-call-signature">add<wbr/>Environment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#addEnvironment.addEnvironment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
335
|
+
<li class="tsd-signature tsd-anchor-link" id="addEnvironment.addEnvironment-1"><span class="tsd-kind-call-signature">add<wbr/>Environment</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#addEnvironment.addEnvironment-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
318
336
|
<li class="tsd-description">
|
|
319
337
|
<div class="tsd-comment tsd-typography"><p>Adds an environment variable to this Lambda function.
|
|
320
338
|
If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
@@ -325,21 +343,25 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
325
343
|
<li>
|
|
326
344
|
<h5><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></h5>
|
|
327
345
|
<div class="tsd-comment tsd-typography"><p>The environment variable key.</p>
|
|
328
|
-
</div
|
|
346
|
+
</div>
|
|
347
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
329
348
|
<li>
|
|
330
349
|
<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></h5>
|
|
331
350
|
<div class="tsd-comment tsd-typography"><p>The environment variable's value.</p>
|
|
332
|
-
</div
|
|
351
|
+
</div>
|
|
352
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
333
353
|
<li>
|
|
334
354
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">EnvironmentOptions</span></h5>
|
|
335
355
|
<div class="tsd-comment tsd-typography"><p>Environment variable options.</p>
|
|
336
|
-
</div
|
|
337
|
-
<
|
|
356
|
+
</div>
|
|
357
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
358
|
+
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4>
|
|
359
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
338
360
|
<p>Inherited from lambdaNodejs.NodejsFunction.addEnvironment</p></aside></li></ul></section>
|
|
339
361
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEventSource" class="tsd-anchor"></a>
|
|
340
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source</span><a href="#addEventSource" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
362
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source</span><a href="#addEventSource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
341
363
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
342
|
-
<li class="tsd-signature tsd-anchor-link" id="addEventSource.addEventSource-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addEventSource.addEventSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
364
|
+
<li class="tsd-signature tsd-anchor-link" id="addEventSource.addEventSource-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addEventSource.addEventSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
343
365
|
<li class="tsd-description">
|
|
344
366
|
<div class="tsd-parameters">
|
|
345
367
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -349,9 +371,9 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
349
371
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
350
372
|
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSource</p></aside></li></ul></section>
|
|
351
373
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addEventSourceMapping" class="tsd-anchor"></a>
|
|
352
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><a href="#addEventSourceMapping" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
374
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><a href="#addEventSourceMapping" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
353
375
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
354
|
-
<li class="tsd-signature tsd-anchor-link" id="addEventSourceMapping.addEventSourceMapping-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">EventSourceMapping</span><a href="#addEventSourceMapping.addEventSourceMapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
376
|
+
<li class="tsd-signature tsd-anchor-link" id="addEventSourceMapping.addEventSourceMapping-1"><span class="tsd-kind-call-signature">add<wbr/>Event<wbr/>Source<wbr/>Mapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">EventSourceMapping</span><a href="#addEventSourceMapping.addEventSourceMapping-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
355
377
|
<li class="tsd-description">
|
|
356
378
|
<div class="tsd-parameters">
|
|
357
379
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -363,9 +385,9 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
363
385
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">EventSourceMapping</span></h4><aside class="tsd-sources">
|
|
364
386
|
<p>Inherited from lambdaNodejs.NodejsFunction.addEventSourceMapping</p></aside></li></ul></section>
|
|
365
387
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addFunctionUrl" class="tsd-anchor"></a>
|
|
366
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Function<wbr/>Url</span><a href="#addFunctionUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
388
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Function<wbr/>Url</span><a href="#addFunctionUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
367
389
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
368
|
-
<li class="tsd-signature tsd-anchor-link" id="addFunctionUrl.addFunctionUrl-1"><span class="tsd-kind-call-signature">add<wbr/>Function<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FunctionUrl</span><a href="#addFunctionUrl.addFunctionUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
390
|
+
<li class="tsd-signature tsd-anchor-link" id="addFunctionUrl.addFunctionUrl-1"><span class="tsd-kind-call-signature">add<wbr/>Function<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FunctionUrl</span><a href="#addFunctionUrl.addFunctionUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
369
391
|
<li class="tsd-description">
|
|
370
392
|
<div class="tsd-parameters">
|
|
371
393
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -375,13 +397,11 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
375
397
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FunctionUrl</span></h4><aside class="tsd-sources">
|
|
376
398
|
<p>Inherited from lambdaNodejs.NodejsFunction.addFunctionUrl</p></aside></li></ul></section>
|
|
377
399
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addLayers" class="tsd-anchor"></a>
|
|
378
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Layers</span><a href="#addLayers" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
400
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Layers</span><a href="#addLayers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
379
401
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
380
|
-
<li class="tsd-signature tsd-anchor-link" id="addLayers.addLayers-1"><span class="tsd-kind-call-signature">add<wbr/>Layers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addLayers.addLayers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
402
|
+
<li class="tsd-signature tsd-anchor-link" id="addLayers.addLayers-1"><span class="tsd-kind-call-signature">add<wbr/>Layers</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addLayers.addLayers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
381
403
|
<li class="tsd-description">
|
|
382
404
|
<div class="tsd-comment tsd-typography"><p>Adds one or more Lambda Layers to this Lambda function.</p>
|
|
383
|
-
|
|
384
|
-
<h3>Throws</h3><p>if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.</p>
|
|
385
405
|
</div>
|
|
386
406
|
<div class="tsd-parameters">
|
|
387
407
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -389,17 +409,19 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
389
409
|
<li>
|
|
390
410
|
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">layers</span>: <span class="tsd-signature-type ">ILayerVersion</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
391
411
|
<div class="tsd-comment tsd-typography"><p>the layers to be added.</p>
|
|
392
|
-
</div
|
|
393
|
-
<
|
|
412
|
+
</div>
|
|
413
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
414
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
415
|
+
<div class="tsd-comment tsd-typography">
|
|
416
|
+
<h4>Throws</h4><p>if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.</p>
|
|
417
|
+
</div><aside class="tsd-sources">
|
|
394
418
|
<p>Inherited from lambdaNodejs.NodejsFunction.addLayers</p></aside></li></ul></section>
|
|
395
419
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addPermission" class="tsd-anchor"></a>
|
|
396
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Permission</span><a href="#addPermission" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
420
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Permission</span><a href="#addPermission" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
397
421
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
398
|
-
<li class="tsd-signature tsd-anchor-link" id="addPermission.addPermission-1"><span class="tsd-kind-call-signature">add<wbr/>Permission</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">permission</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPermission.addPermission-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
422
|
+
<li class="tsd-signature tsd-anchor-link" id="addPermission.addPermission-1"><span class="tsd-kind-call-signature">add<wbr/>Permission</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">permission</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addPermission.addPermission-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
399
423
|
<li class="tsd-description">
|
|
400
424
|
<div class="tsd-comment tsd-typography"><p>Adds a permission to the Lambda resource policy.</p>
|
|
401
|
-
|
|
402
|
-
<h3>See</h3><p>Permission for details.</p>
|
|
403
425
|
</div>
|
|
404
426
|
<div class="tsd-parameters">
|
|
405
427
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -407,17 +429,22 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
407
429
|
<li>
|
|
408
430
|
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
|
|
409
431
|
<div class="tsd-comment tsd-typography"><p>The id for the permission construct</p>
|
|
410
|
-
</div
|
|
432
|
+
</div>
|
|
433
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
411
434
|
<li>
|
|
412
435
|
<h5><span class="tsd-kind-parameter">permission</span>: <span class="tsd-signature-type ">Permission</span></h5>
|
|
413
436
|
<div class="tsd-comment tsd-typography"><p>The permission to grant to this Lambda function.</p>
|
|
414
|
-
</div
|
|
415
|
-
<
|
|
437
|
+
</div>
|
|
438
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
439
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
440
|
+
<div class="tsd-comment tsd-typography">
|
|
441
|
+
<h4>See</h4><p>Permission for details.</p>
|
|
442
|
+
</div><aside class="tsd-sources">
|
|
416
443
|
<p>Inherited from lambdaNodejs.NodejsFunction.addPermission</p></aside></li></ul></section>
|
|
417
444
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addToRolePolicy" class="tsd-anchor"></a>
|
|
418
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span><a href="#addToRolePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
445
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span><a href="#addToRolePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
419
446
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
420
|
-
<li class="tsd-signature tsd-anchor-link" id="addToRolePolicy.addToRolePolicy-1"><span class="tsd-kind-call-signature">add<wbr/>To<wbr/>Role<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addToRolePolicy.addToRolePolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
447
|
+
<li class="tsd-signature tsd-anchor-link" id="addToRolePolicy.addToRolePolicy-1"><span class="tsd-kind-call-signature">add<wbr/>To<wbr/>Role<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addToRolePolicy.addToRolePolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
421
448
|
<li class="tsd-description">
|
|
422
449
|
<div class="tsd-comment tsd-typography"><p>Adds a statement to the IAM role assumed by the instance.</p>
|
|
423
450
|
</div>
|
|
@@ -426,12 +453,13 @@ If this is a ref to a Lambda function, this operation results in a no-op.</p>
|
|
|
426
453
|
<ul class="tsd-parameter-list">
|
|
427
454
|
<li>
|
|
428
455
|
<h5><span class="tsd-kind-parameter">statement</span>: <span class="tsd-signature-type ">PolicyStatement</span></h5></li></ul></div>
|
|
429
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
456
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
457
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
430
458
|
<p>Inherited from lambdaNodejs.NodejsFunction.addToRolePolicy</p></aside></li></ul></section>
|
|
431
459
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="applyRemovalPolicy" class="tsd-anchor"></a>
|
|
432
|
-
<h3 class="tsd-anchor-link"><span>apply<wbr/>Removal<wbr/>Policy</span><a href="#applyRemovalPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
460
|
+
<h3 class="tsd-anchor-link"><span>apply<wbr/>Removal<wbr/>Policy</span><a href="#applyRemovalPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
433
461
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
434
|
-
<li class="tsd-signature tsd-anchor-link" id="applyRemovalPolicy.applyRemovalPolicy-1"><span class="tsd-kind-call-signature">apply<wbr/>Removal<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">policy</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyRemovalPolicy.applyRemovalPolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
462
|
+
<li class="tsd-signature tsd-anchor-link" id="applyRemovalPolicy.applyRemovalPolicy-1"><span class="tsd-kind-call-signature">apply<wbr/>Removal<wbr/>Policy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">policy</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyRemovalPolicy.applyRemovalPolicy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
435
463
|
<li class="tsd-description">
|
|
436
464
|
<div class="tsd-comment tsd-typography"><p>Apply the given removal policy to this resource</p>
|
|
437
465
|
<p>The Removal Policy controls what happens to this resource when it stops
|
|
@@ -446,12 +474,13 @@ account for data recovery and cleanup later (<code>RemovalPolicy.RETAIN</code>).
|
|
|
446
474
|
<ul class="tsd-parameter-list">
|
|
447
475
|
<li>
|
|
448
476
|
<h5><span class="tsd-kind-parameter">policy</span>: <span class="tsd-signature-type ">RemovalPolicy</span></h5></li></ul></div>
|
|
449
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
477
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
478
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
450
479
|
<p>Inherited from lambdaNodejs.NodejsFunction.applyRemovalPolicy</p></aside></li></ul></section>
|
|
451
480
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="configureAsyncInvoke" class="tsd-anchor"></a>
|
|
452
|
-
<h3 class="tsd-anchor-link"><span>configure<wbr/>Async<wbr/>Invoke</span><a href="#configureAsyncInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
481
|
+
<h3 class="tsd-anchor-link"><span>configure<wbr/>Async<wbr/>Invoke</span><a href="#configureAsyncInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
453
482
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
454
|
-
<li class="tsd-signature tsd-anchor-link" id="configureAsyncInvoke.configureAsyncInvoke-1"><span class="tsd-kind-call-signature">configure<wbr/>Async<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#configureAsyncInvoke.configureAsyncInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
483
|
+
<li class="tsd-signature tsd-anchor-link" id="configureAsyncInvoke.configureAsyncInvoke-1"><span class="tsd-kind-call-signature">configure<wbr/>Async<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#configureAsyncInvoke.configureAsyncInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
455
484
|
<li class="tsd-description">
|
|
456
485
|
<div class="tsd-parameters">
|
|
457
486
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -461,9 +490,9 @@ account for data recovery and cleanup later (<code>RemovalPolicy.RETAIN</code>).
|
|
|
461
490
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
462
491
|
<p>Inherited from lambdaNodejs.NodejsFunction.configureAsyncInvoke</p></aside></li></ul></section>
|
|
463
492
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="considerWarningOnInvokeFunctionPermissions" class="tsd-anchor"></a>
|
|
464
|
-
<h3 class="tsd-anchor-link"><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#considerWarningOnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
493
|
+
<h3 class="tsd-anchor-link"><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#considerWarningOnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
465
494
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
466
|
-
<li class="tsd-signature tsd-anchor-link" id="considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
495
|
+
<li class="tsd-signature tsd-anchor-link" id="considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#considerWarningOnInvokeFunctionPermissions.considerWarningOnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
467
496
|
<li class="tsd-description">
|
|
468
497
|
<div class="tsd-comment tsd-typography"><p>A warning will be added to functions under the following conditions:</p>
|
|
469
498
|
<ul>
|
|
@@ -480,19 +509,20 @@ This function is overridden as a noOp for QualifiedFunctionBase.</p>
|
|
|
480
509
|
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5></li>
|
|
481
510
|
<li>
|
|
482
511
|
<h5><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
483
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
512
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
513
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
484
514
|
<p>Inherited from lambdaNodejs.NodejsFunction.considerWarningOnInvokeFunctionPermissions</p></aside></li></ul></section>
|
|
485
515
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="generatePhysicalName" class="tsd-anchor"></a>
|
|
486
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>generate<wbr/>Physical<wbr/>Name</span><a href="#generatePhysicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
516
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>generate<wbr/>Physical<wbr/>Name</span><a href="#generatePhysicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
487
517
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
488
|
-
<li class="tsd-signature tsd-anchor-link" id="generatePhysicalName.generatePhysicalName-1"><span class="tsd-kind-call-signature">generate<wbr/>Physical<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generatePhysicalName.generatePhysicalName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
518
|
+
<li class="tsd-signature tsd-anchor-link" id="generatePhysicalName.generatePhysicalName-1"><span class="tsd-kind-call-signature">generate<wbr/>Physical<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#generatePhysicalName.generatePhysicalName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
489
519
|
<li class="tsd-description">
|
|
490
520
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
491
521
|
<p>Inherited from lambdaNodejs.NodejsFunction.generatePhysicalName</p></aside></li></ul></section>
|
|
492
522
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getResourceArnAttribute" class="tsd-anchor"></a>
|
|
493
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><a href="#getResourceArnAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
523
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><a href="#getResourceArnAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
494
524
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
495
|
-
<li class="tsd-signature tsd-anchor-link" id="getResourceArnAttribute.getResourceArnAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arnAttr</span>, <span class="tsd-kind-parameter">arnComponents</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceArnAttribute.getResourceArnAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
525
|
+
<li class="tsd-signature tsd-anchor-link" id="getResourceArnAttribute.getResourceArnAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arnAttr</span>, <span class="tsd-kind-parameter">arnComponents</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceArnAttribute.getResourceArnAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
496
526
|
<li class="tsd-description">
|
|
497
527
|
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
498
528
|
resource's "ARN" attribute (e.g. <code>bucket.bucketArn</code>).</p>
|
|
@@ -509,19 +539,22 @@ a concrete ARN with the resource's physical name. Make sure to reference
|
|
|
509
539
|
<div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the ARN of the resource.
|
|
510
540
|
Commonly it will be called "Arn" (e.g. <code>resource.attrArn</code>), but sometimes
|
|
511
541
|
it's the CFN resource's <code>ref</code>.</p>
|
|
512
|
-
</div
|
|
542
|
+
</div>
|
|
543
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
513
544
|
<li>
|
|
514
545
|
<h5><span class="tsd-kind-parameter">arnComponents</span>: <span class="tsd-signature-type ">ArnComponents</span></h5>
|
|
515
546
|
<div class="tsd-comment tsd-typography"><p>The format of the ARN of this resource. You must
|
|
516
547
|
reference <code>this.physicalName</code> somewhere within the ARN in order for
|
|
517
548
|
cross-environment references to work.</p>
|
|
518
|
-
</div
|
|
519
|
-
<
|
|
549
|
+
</div>
|
|
550
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
551
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
552
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
520
553
|
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceArnAttribute</p></aside></li></ul></section>
|
|
521
554
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="getResourceNameAttribute" class="tsd-anchor"></a>
|
|
522
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><a href="#getResourceNameAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
555
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><a href="#getResourceNameAttribute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
523
556
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
524
|
-
<li class="tsd-signature tsd-anchor-link" id="getResourceNameAttribute.getResourceNameAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAttr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceNameAttribute.getResourceNameAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
557
|
+
<li class="tsd-signature tsd-anchor-link" id="getResourceNameAttribute.getResourceNameAttribute-1"><span class="tsd-kind-call-signature">get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAttr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getResourceNameAttribute.getResourceNameAttribute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
525
558
|
<li class="tsd-description">
|
|
526
559
|
<div class="tsd-comment tsd-typography"><p>Returns an environment-sensitive token that should be used for the
|
|
527
560
|
resource's "name" attribute (e.g. <code>bucket.bucketName</code>).</p>
|
|
@@ -536,19 +569,21 @@ which will be a concrete name.</p>
|
|
|
536
569
|
<h5><span class="tsd-kind-parameter">nameAttr</span>: <span class="tsd-signature-type">string</span></h5>
|
|
537
570
|
<div class="tsd-comment tsd-typography"><p>The CFN attribute which resolves to the resource's name.
|
|
538
571
|
Commonly this is the resource's <code>ref</code>.</p>
|
|
539
|
-
</div
|
|
540
|
-
<
|
|
572
|
+
</div>
|
|
573
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
574
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
575
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
541
576
|
<p>Inherited from lambdaNodejs.NodejsFunction.getResourceNameAttribute</p></aside></li></ul></section>
|
|
542
577
|
<section class="tsd-panel tsd-member"><a id="grantDeleteAsset" class="tsd-anchor"></a>
|
|
543
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Delete<wbr/>Asset</span><a href="#grantDeleteAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
578
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Delete<wbr/>Asset</span><a href="#grantDeleteAsset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
544
579
|
<ul class="tsd-signatures">
|
|
545
|
-
<li class="tsd-signature tsd-anchor-link" id="grantDeleteAsset.grantDeleteAsset-1"><span class="tsd-kind-call-signature">grant<wbr/>Delete<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantDeleteAsset.grantDeleteAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
580
|
+
<li class="tsd-signature tsd-anchor-link" id="grantDeleteAsset.grantDeleteAsset-1"><span class="tsd-kind-call-signature">grant<wbr/>Delete<wbr/>Asset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantDeleteAsset.grantDeleteAsset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
546
581
|
<li class="tsd-description">
|
|
547
582
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
548
583
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantInvoke" class="tsd-anchor"></a>
|
|
549
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke</span><a href="#grantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
584
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke</span><a href="#grantInvoke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
550
585
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
551
|
-
<li class="tsd-signature tsd-anchor-link" id="grantInvoke.grantInvoke-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvoke.grantInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
586
|
+
<li class="tsd-signature tsd-anchor-link" id="grantInvoke.grantInvoke-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvoke.grantInvoke-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
552
587
|
<li class="tsd-description">
|
|
553
588
|
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda</p>
|
|
554
589
|
</div>
|
|
@@ -557,12 +592,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
557
592
|
<ul class="tsd-parameter-list">
|
|
558
593
|
<li>
|
|
559
594
|
<h5><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type ">IGrantable</span></h5></li></ul></div>
|
|
560
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4
|
|
595
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4>
|
|
596
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
561
597
|
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvoke</p></aside></li></ul></section>
|
|
562
598
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="grantInvokeUrl" class="tsd-anchor"></a>
|
|
563
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Url</span><a href="#grantInvokeUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
599
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Invoke<wbr/>Url</span><a href="#grantInvokeUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
564
600
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
565
|
-
<li class="tsd-signature tsd-anchor-link" id="grantInvokeUrl.grantInvokeUrl-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvokeUrl.grantInvokeUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
601
|
+
<li class="tsd-signature tsd-anchor-link" id="grantInvokeUrl.grantInvokeUrl-1"><span class="tsd-kind-call-signature">grant<wbr/>Invoke<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">grantee</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Grant</span><a href="#grantInvokeUrl.grantInvokeUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
566
602
|
<li class="tsd-description">
|
|
567
603
|
<div class="tsd-comment tsd-typography"><p>Grant the given identity permissions to invoke this Lambda Function URL</p>
|
|
568
604
|
</div>
|
|
@@ -571,42 +607,43 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
571
607
|
<ul class="tsd-parameter-list">
|
|
572
608
|
<li>
|
|
573
609
|
<h5><span class="tsd-kind-parameter">grantee</span>: <span class="tsd-signature-type ">IGrantable</span></h5></li></ul></div>
|
|
574
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4
|
|
610
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Grant</span></h4>
|
|
611
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
575
612
|
<p>Inherited from lambdaNodejs.NodejsFunction.grantInvokeUrl</p></aside></li></ul></section>
|
|
576
613
|
<section class="tsd-panel tsd-member"><a id="grantSendEmails" class="tsd-anchor"></a>
|
|
577
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Send<wbr/>Emails</span><a href="#grantSendEmails" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
614
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Send<wbr/>Emails</span><a href="#grantSendEmails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
578
615
|
<ul class="tsd-signatures">
|
|
579
|
-
<li class="tsd-signature tsd-anchor-link" id="grantSendEmails.grantSendEmails-1"><span class="tsd-kind-call-signature">grant<wbr/>Send<wbr/>Emails</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantSendEmails.grantSendEmails-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
616
|
+
<li class="tsd-signature tsd-anchor-link" id="grantSendEmails.grantSendEmails-1"><span class="tsd-kind-call-signature">grant<wbr/>Send<wbr/>Emails</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantSendEmails.grantSendEmails-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
580
617
|
<li class="tsd-description">
|
|
581
618
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
582
619
|
<section class="tsd-panel tsd-member"><a id="grantTableWrite" class="tsd-anchor"></a>
|
|
583
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Table<wbr/>Write</span><a href="#grantTableWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
620
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Table<wbr/>Write</span><a href="#grantTableWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
584
621
|
<ul class="tsd-signatures">
|
|
585
|
-
<li class="tsd-signature tsd-anchor-link" id="grantTableWrite.grantTableWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Table<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantTableWrite.grantTableWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
622
|
+
<li class="tsd-signature tsd-anchor-link" id="grantTableWrite.grantTableWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Table<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantTableWrite.grantTableWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
586
623
|
<li class="tsd-description">
|
|
587
624
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
588
625
|
<section class="tsd-panel tsd-member"><a id="grantUploadAssets" class="tsd-anchor"></a>
|
|
589
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Upload<wbr/>Assets</span><a href="#grantUploadAssets" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
626
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Upload<wbr/>Assets</span><a href="#grantUploadAssets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
590
627
|
<ul class="tsd-signatures">
|
|
591
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUploadAssets.grantUploadAssets-1"><span class="tsd-kind-call-signature">grant<wbr/>Upload<wbr/>Assets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUploadAssets.grantUploadAssets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
628
|
+
<li class="tsd-signature tsd-anchor-link" id="grantUploadAssets.grantUploadAssets-1"><span class="tsd-kind-call-signature">grant<wbr/>Upload<wbr/>Assets</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUploadAssets.grantUploadAssets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
592
629
|
<li class="tsd-description">
|
|
593
630
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
594
631
|
<section class="tsd-panel tsd-member"><a id="grantUserpoolRead" class="tsd-anchor"></a>
|
|
595
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read</span><a href="#grantUserpoolRead" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
632
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read</span><a href="#grantUserpoolRead" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
596
633
|
<ul class="tsd-signatures">
|
|
597
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolRead.grantUserpoolRead-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolRead.grantUserpoolRead-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
634
|
+
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolRead.grantUserpoolRead-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolRead.grantUserpoolRead-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
598
635
|
<li class="tsd-description">
|
|
599
636
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
600
637
|
<section class="tsd-panel tsd-member"><a id="grantUserpoolReadWrite" class="tsd-anchor"></a>
|
|
601
|
-
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><a href="#grantUserpoolReadWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
638
|
+
<h3 class="tsd-anchor-link"><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><a href="#grantUserpoolReadWrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
602
639
|
<ul class="tsd-signatures">
|
|
603
|
-
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolReadWrite.grantUserpoolReadWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolReadWrite.grantUserpoolReadWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
640
|
+
<li class="tsd-signature tsd-anchor-link" id="grantUserpoolReadWrite.grantUserpoolReadWrite-1"><span class="tsd-kind-call-signature">grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#grantUserpoolReadWrite.grantUserpoolReadWrite-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
604
641
|
<li class="tsd-description">
|
|
605
642
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
606
643
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metric" class="tsd-anchor"></a>
|
|
607
|
-
<h3 class="tsd-anchor-link"><span>metric</span><a href="#metric" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
644
|
+
<h3 class="tsd-anchor-link"><span>metric</span><a href="#metric" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
608
645
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
609
|
-
<li class="tsd-signature tsd-anchor-link" id="metric.metric-1"><span class="tsd-kind-call-signature">metric</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metric.metric-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
646
|
+
<li class="tsd-signature tsd-anchor-link" id="metric.metric-1"><span class="tsd-kind-call-signature">metric</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metric.metric-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
610
647
|
<li class="tsd-description">
|
|
611
648
|
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Function</p>
|
|
612
649
|
</div>
|
|
@@ -617,12 +654,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
617
654
|
<h5><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
618
655
|
<li>
|
|
619
656
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
620
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
657
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
658
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
621
659
|
<p>Inherited from lambdaNodejs.NodejsFunction.metric</p></aside></li></ul></section>
|
|
622
660
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricDuration" class="tsd-anchor"></a>
|
|
623
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Duration</span><a href="#metricDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
661
|
+
<h3 class="tsd-anchor-link"><span>metric<wbr/>Duration</span><a href="#metricDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
624
662
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
625
|
-
<li class="tsd-signature tsd-anchor-link" id="metricDuration.metricDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricDuration.metricDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
663
|
+
<li class="tsd-signature tsd-anchor-link" id="metricDuration.metricDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricDuration.metricDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
626
664
|
<li class="tsd-description">
|
|
627
665
|
<div class="tsd-comment tsd-typography"><p>How long execution of this Lambda takes</p>
|
|
628
666
|
<p>Average over 5 minutes</p>
|
|
@@ -632,12 +670,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
632
670
|
<ul class="tsd-parameter-list">
|
|
633
671
|
<li>
|
|
634
672
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
635
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
673
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
674
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
636
675
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricDuration</p></aside></li></ul></section>
|
|
637
676
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricErrors" class="tsd-anchor"></a>
|
|
638
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Errors</span><a href="#metricErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
677
|
+
<h3 class="tsd-anchor-link"><span>metric<wbr/>Errors</span><a href="#metricErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
639
678
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
640
|
-
<li class="tsd-signature tsd-anchor-link" id="metricErrors.metricErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricErrors.metricErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
679
|
+
<li class="tsd-signature tsd-anchor-link" id="metricErrors.metricErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricErrors.metricErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
641
680
|
<li class="tsd-description">
|
|
642
681
|
<div class="tsd-comment tsd-typography"><p>How many invocations of this Lambda fail</p>
|
|
643
682
|
<p>Sum over 5 minutes</p>
|
|
@@ -647,12 +686,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
647
686
|
<ul class="tsd-parameter-list">
|
|
648
687
|
<li>
|
|
649
688
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
650
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
689
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
690
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
651
691
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricErrors</p></aside></li></ul></section>
|
|
652
692
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricInvocations" class="tsd-anchor"></a>
|
|
653
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Invocations</span><a href="#metricInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
693
|
+
<h3 class="tsd-anchor-link"><span>metric<wbr/>Invocations</span><a href="#metricInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
654
694
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
655
|
-
<li class="tsd-signature tsd-anchor-link" id="metricInvocations.metricInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricInvocations.metricInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
695
|
+
<li class="tsd-signature tsd-anchor-link" id="metricInvocations.metricInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricInvocations.metricInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
656
696
|
<li class="tsd-description">
|
|
657
697
|
<div class="tsd-comment tsd-typography"><p>How often this Lambda is invoked</p>
|
|
658
698
|
<p>Sum over 5 minutes</p>
|
|
@@ -662,12 +702,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
662
702
|
<ul class="tsd-parameter-list">
|
|
663
703
|
<li>
|
|
664
704
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
665
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
705
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
706
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
666
707
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricInvocations</p></aside></li></ul></section>
|
|
667
708
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricThrottles" class="tsd-anchor"></a>
|
|
668
|
-
<h3 class="tsd-anchor-link"><span>metric<wbr/>Throttles</span><a href="#metricThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
709
|
+
<h3 class="tsd-anchor-link"><span>metric<wbr/>Throttles</span><a href="#metricThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
669
710
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
670
|
-
<li class="tsd-signature tsd-anchor-link" id="metricThrottles.metricThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricThrottles.metricThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
711
|
+
<li class="tsd-signature tsd-anchor-link" id="metricThrottles.metricThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricThrottles.metricThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
671
712
|
<li class="tsd-description">
|
|
672
713
|
<div class="tsd-comment tsd-typography"><p>How often this Lambda is throttled</p>
|
|
673
714
|
<p>Sum over 5 minutes</p>
|
|
@@ -677,12 +718,13 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
677
718
|
<ul class="tsd-parameter-list">
|
|
678
719
|
<li>
|
|
679
720
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
680
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
721
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
722
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
681
723
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricThrottles</p></aside></li></ul></section>
|
|
682
724
|
<section class="tsd-panel tsd-member"><a id="setTable" class="tsd-anchor"></a>
|
|
683
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Table</span><a href="#setTable" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
725
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Table</span><a href="#setTable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
684
726
|
<ul class="tsd-signatures">
|
|
685
|
-
<li class="tsd-signature tsd-anchor-link" id="setTable.setTable-1"><span class="tsd-kind-call-signature">set<wbr/>Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">table</span>, <span class="tsd-kind-parameter">tableWrites</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTable.setTable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
727
|
+
<li class="tsd-signature tsd-anchor-link" id="setTable.setTable-1"><span class="tsd-kind-call-signature">set<wbr/>Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">table</span>, <span class="tsd-kind-parameter">tableWrites</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTable.setTable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
686
728
|
<li class="tsd-description">
|
|
687
729
|
<div class="tsd-parameters">
|
|
688
730
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -693,9 +735,9 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
693
735
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tableWrites</span>: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
694
736
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
695
737
|
<section class="tsd-panel tsd-member"><a id="setTimeout" class="tsd-anchor"></a>
|
|
696
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#setTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
738
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Timeout</span><a href="#setTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
697
739
|
<ul class="tsd-signatures">
|
|
698
|
-
<li class="tsd-signature tsd-anchor-link" id="setTimeout.setTimeout-1"><span class="tsd-kind-call-signature">set<wbr/>Timeout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTimeout.setTimeout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
740
|
+
<li class="tsd-signature tsd-anchor-link" id="setTimeout.setTimeout-1"><span class="tsd-kind-call-signature">set<wbr/>Timeout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setTimeout.setTimeout-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
699
741
|
<li class="tsd-description">
|
|
700
742
|
<div class="tsd-parameters">
|
|
701
743
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -704,9 +746,9 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
704
746
|
<h5><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type ">Duration</span></h5></li></ul></div>
|
|
705
747
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
706
748
|
<section class="tsd-panel tsd-member"><a id="setUserPool" class="tsd-anchor"></a>
|
|
707
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Pool</span><a href="#setUserPool" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
749
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Pool</span><a href="#setUserPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
708
750
|
<ul class="tsd-signatures">
|
|
709
|
-
<li class="tsd-signature tsd-anchor-link" id="setUserPool.setUserPool-1"><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Pool</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userPool</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setUserPool.setUserPool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
751
|
+
<li class="tsd-signature tsd-anchor-link" id="setUserPool.setUserPool-1"><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Pool</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userPool</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a><a href="#setUserPool.setUserPool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
710
752
|
<li class="tsd-description">
|
|
711
753
|
<div class="tsd-parameters">
|
|
712
754
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -715,20 +757,21 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
715
757
|
<h5><span class="tsd-kind-parameter">userPool</span>: <span class="tsd-signature-type ">IUserPool</span></h5></li></ul></div>
|
|
716
758
|
<h4 class="tsd-returns-title">Returns <a href="LambdaFunction.html" class="tsd-signature-type tsd-kind-class">LambdaFunction</a></h4></li></ul></section>
|
|
717
759
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString" class="tsd-anchor"></a>
|
|
718
|
-
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
760
|
+
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
719
761
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
720
|
-
<li class="tsd-signature tsd-anchor-link" id="toString.toString-1"><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
762
|
+
<li class="tsd-signature tsd-anchor-link" id="toString.toString-1"><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
721
763
|
<li class="tsd-description">
|
|
722
764
|
<div class="tsd-comment tsd-typography"><p>Returns a string representation of this construct.</p>
|
|
723
|
-
|
|
724
|
-
<h3>Stability</h3><p>stable</p>
|
|
725
765
|
</div>
|
|
726
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4
|
|
766
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
767
|
+
<div class="tsd-comment tsd-typography">
|
|
768
|
+
<h4>Stability</h4><p>stable</p>
|
|
769
|
+
</div><aside class="tsd-sources">
|
|
727
770
|
<p>Inherited from lambdaNodejs.NodejsFunction.toString</p></aside></li></ul></section>
|
|
728
771
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="warnInvokeFunctionPermissions" class="tsd-anchor"></a>
|
|
729
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#warnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
772
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><a href="#warnInvokeFunctionPermissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
730
773
|
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external">
|
|
731
|
-
<li class="tsd-signature tsd-anchor-link" id="warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
774
|
+
<li class="tsd-signature tsd-anchor-link" id="warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1"><span class="tsd-kind-call-signature">warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#warnInvokeFunctionPermissions.warnInvokeFunctionPermissions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
732
775
|
<li class="tsd-description">
|
|
733
776
|
<div class="tsd-parameters">
|
|
734
777
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -738,9 +781,9 @@ Commonly this is the resource's <code>ref</code>.</p>
|
|
|
738
781
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
739
782
|
<p>Inherited from lambdaNodejs.NodejsFunction.warnInvokeFunctionPermissions</p></aside></li></ul></section>
|
|
740
783
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="classifyVersionProperty" class="tsd-anchor"></a>
|
|
741
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>classify<wbr/>Version<wbr/>Property</span><a href="#classifyVersionProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
784
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>classify<wbr/>Version<wbr/>Property</span><a href="#classifyVersionProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
742
785
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
743
|
-
<li class="tsd-signature tsd-anchor-link" id="classifyVersionProperty.classifyVersionProperty-1"><span class="tsd-kind-call-signature">classify<wbr/>Version<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyName</span>, <span class="tsd-kind-parameter">locked</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#classifyVersionProperty.classifyVersionProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
786
|
+
<li class="tsd-signature tsd-anchor-link" id="classifyVersionProperty.classifyVersionProperty-1"><span class="tsd-kind-call-signature">classify<wbr/>Version<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyName</span>, <span class="tsd-kind-parameter">locked</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#classifyVersionProperty.classifyVersionProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
744
787
|
<li class="tsd-description">
|
|
745
788
|
<div class="tsd-comment tsd-typography"><p>Record whether specific properties in the <code>AWS::Lambda::Function</code> resource should
|
|
746
789
|
also be associated to the Version resource.
|
|
@@ -752,17 +795,20 @@ See 'currentVersion' section in the module README for more details.</p>
|
|
|
752
795
|
<li>
|
|
753
796
|
<h5><span class="tsd-kind-parameter">propertyName</span>: <span class="tsd-signature-type">string</span></h5>
|
|
754
797
|
<div class="tsd-comment tsd-typography"><p>The property to classify</p>
|
|
755
|
-
</div
|
|
798
|
+
</div>
|
|
799
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
756
800
|
<li>
|
|
757
801
|
<h5><span class="tsd-kind-parameter">locked</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
758
802
|
<div class="tsd-comment tsd-typography"><p>whether the property should be associated to the version or not.</p>
|
|
759
|
-
</div
|
|
760
|
-
<
|
|
803
|
+
</div>
|
|
804
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
805
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
806
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
761
807
|
<p>Inherited from lambdaNodejs.NodejsFunction.classifyVersionProperty</p></aside></li></ul></section>
|
|
762
808
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionArn" class="tsd-anchor"></a>
|
|
763
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Arn</span><a href="#fromFunctionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
809
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Arn</span><a href="#fromFunctionArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
764
810
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
765
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionArn.fromFunctionArn-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Arn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionArn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionArn.fromFunctionArn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
811
|
+
<li class="tsd-signature tsd-anchor-link" id="fromFunctionArn.fromFunctionArn-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Arn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionArn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionArn.fromFunctionArn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
766
812
|
<li class="tsd-description">
|
|
767
813
|
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its ARN</p>
|
|
768
814
|
</div>
|
|
@@ -775,12 +821,13 @@ See 'currentVersion' section in the module README for more details.</p>
|
|
|
775
821
|
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
776
822
|
<li>
|
|
777
823
|
<h5><span class="tsd-kind-parameter">functionArn</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
778
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4
|
|
824
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
825
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
779
826
|
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionArn</p></aside></li></ul></section>
|
|
780
827
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionAttributes" class="tsd-anchor"></a>
|
|
781
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Attributes</span><a href="#fromFunctionAttributes" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
828
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Attributes</span><a href="#fromFunctionAttributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
782
829
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
783
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionAttributes.fromFunctionAttributes-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Attributes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">attrs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionAttributes.fromFunctionAttributes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
830
|
+
<li class="tsd-signature tsd-anchor-link" id="fromFunctionAttributes.fromFunctionAttributes-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Attributes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">attrs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionAttributes.fromFunctionAttributes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
784
831
|
<li class="tsd-description">
|
|
785
832
|
<div class="tsd-comment tsd-typography"><p>Creates a Lambda function object which represents a function not defined
|
|
786
833
|
within this stack.</p>
|
|
@@ -791,21 +838,25 @@ within this stack.</p>
|
|
|
791
838
|
<li>
|
|
792
839
|
<h5><span class="tsd-kind-parameter">scope</span>: <span class="tsd-signature-type ">Construct</span></h5>
|
|
793
840
|
<div class="tsd-comment tsd-typography"><p>The parent construct</p>
|
|
794
|
-
</div
|
|
841
|
+
</div>
|
|
842
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
795
843
|
<li>
|
|
796
844
|
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5>
|
|
797
845
|
<div class="tsd-comment tsd-typography"><p>The name of the lambda construct</p>
|
|
798
|
-
</div
|
|
846
|
+
</div>
|
|
847
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
799
848
|
<li>
|
|
800
849
|
<h5><span class="tsd-kind-parameter">attrs</span>: <span class="tsd-signature-type ">FunctionAttributes</span></h5>
|
|
801
850
|
<div class="tsd-comment tsd-typography"><p>the attributes of the function to import</p>
|
|
802
|
-
</div
|
|
803
|
-
<
|
|
851
|
+
</div>
|
|
852
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
853
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
854
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
804
855
|
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionAttributes</p></aside></li></ul></section>
|
|
805
856
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromFunctionName" class="tsd-anchor"></a>
|
|
806
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Name</span><a href="#fromFunctionName" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
857
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Function<wbr/>Name</span><a href="#fromFunctionName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
807
858
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
808
|
-
<li class="tsd-signature tsd-anchor-link" id="fromFunctionName.fromFunctionName-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionName.fromFunctionName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
859
|
+
<li class="tsd-signature tsd-anchor-link" id="fromFunctionName.fromFunctionName-1"><span class="tsd-kind-call-signature">from<wbr/>Function<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">functionName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IFunction</span><a href="#fromFunctionName.fromFunctionName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
809
860
|
<li class="tsd-description">
|
|
810
861
|
<div class="tsd-comment tsd-typography"><p>Import a lambda function into the CDK using its name</p>
|
|
811
862
|
</div>
|
|
@@ -818,16 +869,15 @@ within this stack.</p>
|
|
|
818
869
|
<h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
819
870
|
<li>
|
|
820
871
|
<h5><span class="tsd-kind-parameter">functionName</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
821
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4
|
|
872
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IFunction</span></h4>
|
|
873
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
822
874
|
<p>Inherited from lambdaNodejs.NodejsFunction.fromFunctionName</p></aside></li></ul></section>
|
|
823
875
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isConstruct" class="tsd-anchor"></a>
|
|
824
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
876
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Construct</span><a href="#isConstruct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
825
877
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
826
|
-
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
878
|
+
<li class="tsd-signature tsd-anchor-link" id="isConstruct.isConstruct-1"><span class="tsd-kind-call-signature">is<wbr/>Construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span><a href="#isConstruct.isConstruct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
827
879
|
<li class="tsd-description">
|
|
828
880
|
<div class="tsd-comment tsd-typography"><p>(deprecated) Checks if <code>x</code> is a construct.</p>
|
|
829
|
-
|
|
830
|
-
<h3>Deprecated</h3><p>use <code>x instanceof Construct</code> instead</p>
|
|
831
881
|
</div>
|
|
832
882
|
<div class="tsd-parameters">
|
|
833
883
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -835,14 +885,18 @@ within this stack.</p>
|
|
|
835
885
|
<li>
|
|
836
886
|
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">any</span></h5>
|
|
837
887
|
<div class="tsd-comment tsd-typography"><p>Any object.</p>
|
|
838
|
-
</div
|
|
888
|
+
</div>
|
|
889
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
839
890
|
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Construct</span></h4><p>true if <code>x</code> is an object created from a class which extends <code>Construct</code>.</p>
|
|
840
|
-
|
|
891
|
+
|
|
892
|
+
<div class="tsd-comment tsd-typography">
|
|
893
|
+
<h4>Deprecated</h4><p>use <code>x instanceof Construct</code> instead</p>
|
|
894
|
+
</div><aside class="tsd-sources">
|
|
841
895
|
<p>Inherited from lambdaNodejs.NodejsFunction.isConstruct</p></aside></li></ul></section>
|
|
842
896
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isOwnedResource" class="tsd-anchor"></a>
|
|
843
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Owned<wbr/>Resource</span><a href="#isOwnedResource" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
897
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Owned<wbr/>Resource</span><a href="#isOwnedResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
844
898
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
845
|
-
<li class="tsd-signature tsd-anchor-link" id="isOwnedResource.isOwnedResource-1"><span class="tsd-kind-call-signature">is<wbr/>Owned<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isOwnedResource.isOwnedResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
899
|
+
<li class="tsd-signature tsd-anchor-link" id="isOwnedResource.isOwnedResource-1"><span class="tsd-kind-call-signature">is<wbr/>Owned<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isOwnedResource.isOwnedResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
846
900
|
<li class="tsd-description">
|
|
847
901
|
<div class="tsd-comment tsd-typography"><p>Returns true if the construct was created by CDK, and false otherwise</p>
|
|
848
902
|
</div>
|
|
@@ -851,12 +905,13 @@ within this stack.</p>
|
|
|
851
905
|
<ul class="tsd-parameter-list">
|
|
852
906
|
<li>
|
|
853
907
|
<h5><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type ">IConstruct</span></h5></li></ul></div>
|
|
854
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
908
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
909
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
855
910
|
<p>Inherited from lambdaNodejs.NodejsFunction.isOwnedResource</p></aside></li></ul></section>
|
|
856
911
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isResource" class="tsd-anchor"></a>
|
|
857
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Resource</span><a href="#isResource" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
912
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Resource</span><a href="#isResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
858
913
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
859
|
-
<li class="tsd-signature tsd-anchor-link" id="isResource.isResource-1"><span class="tsd-kind-call-signature">is<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span><a href="#isResource.isResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
914
|
+
<li class="tsd-signature tsd-anchor-link" id="isResource.isResource-1"><span class="tsd-kind-call-signature">is<wbr/>Resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span><a href="#isResource.isResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
860
915
|
<li class="tsd-description">
|
|
861
916
|
<div class="tsd-comment tsd-typography"><p>Check whether the given construct is a Resource</p>
|
|
862
917
|
</div>
|
|
@@ -865,12 +920,13 @@ within this stack.</p>
|
|
|
865
920
|
<ul class="tsd-parameter-list">
|
|
866
921
|
<li>
|
|
867
922
|
<h5><span class="tsd-kind-parameter">construct</span>: <span class="tsd-signature-type ">IConstruct</span></h5></li></ul></div>
|
|
868
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span></h4
|
|
923
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">construct</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type ">Resource</span></h4>
|
|
924
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
869
925
|
<p>Inherited from lambdaNodejs.NodejsFunction.isResource</p></aside></li></ul></section>
|
|
870
926
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAll" class="tsd-anchor"></a>
|
|
871
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All</span><a href="#metricAll" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
927
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All</span><a href="#metricAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
872
928
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
873
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAll.metricAll-1"><span class="tsd-kind-call-signature">metric<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAll.metricAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
929
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAll.metricAll-1"><span class="tsd-kind-call-signature">metric<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricName</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAll.metricAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
874
930
|
<li class="tsd-description">
|
|
875
931
|
<div class="tsd-comment tsd-typography"><p>Return the given named metric for this Lambda</p>
|
|
876
932
|
</div>
|
|
@@ -881,115 +937,122 @@ within this stack.</p>
|
|
|
881
937
|
<h5><span class="tsd-kind-parameter">metricName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
882
938
|
<li>
|
|
883
939
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
884
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
940
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
941
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
885
942
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAll</p></aside></li></ul></section>
|
|
886
943
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllConcurrentExecutions" class="tsd-anchor"></a>
|
|
887
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
944
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
888
945
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
889
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllConcurrentExecutions.metricAllConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllConcurrentExecutions.metricAllConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
946
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllConcurrentExecutions.metricAllConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllConcurrentExecutions.metricAllConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
890
947
|
<li class="tsd-description">
|
|
891
948
|
<div class="tsd-comment tsd-typography"><p>Metric for the number of concurrent executions across all Lambdas</p>
|
|
892
|
-
|
|
893
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">max</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
894
|
-
</code><button>Copy</button></pre>
|
|
895
949
|
</div>
|
|
896
950
|
<div class="tsd-parameters">
|
|
897
951
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
898
952
|
<ul class="tsd-parameter-list">
|
|
899
953
|
<li>
|
|
900
954
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
901
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
955
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
956
|
+
<div class="tsd-comment tsd-typography">
|
|
957
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">max</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
958
|
+
</code><button>Copy</button></pre>
|
|
959
|
+
</div><aside class="tsd-sources">
|
|
902
960
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllConcurrentExecutions</p></aside></li></ul></section>
|
|
903
961
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllDuration" class="tsd-anchor"></a>
|
|
904
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Duration</span><a href="#metricAllDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
962
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Duration</span><a href="#metricAllDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
905
963
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
906
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllDuration.metricAllDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllDuration.metricAllDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
964
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllDuration.metricAllDuration-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllDuration.metricAllDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
907
965
|
<li class="tsd-description">
|
|
908
966
|
<div class="tsd-comment tsd-typography"><p>Metric for the Duration executing all Lambdas</p>
|
|
909
|
-
|
|
910
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">average</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
911
|
-
</code><button>Copy</button></pre>
|
|
912
967
|
</div>
|
|
913
968
|
<div class="tsd-parameters">
|
|
914
969
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
915
970
|
<ul class="tsd-parameter-list">
|
|
916
971
|
<li>
|
|
917
972
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
918
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
973
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
974
|
+
<div class="tsd-comment tsd-typography">
|
|
975
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">average</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
976
|
+
</code><button>Copy</button></pre>
|
|
977
|
+
</div><aside class="tsd-sources">
|
|
919
978
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllDuration</p></aside></li></ul></section>
|
|
920
979
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllErrors" class="tsd-anchor"></a>
|
|
921
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Errors</span><a href="#metricAllErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
980
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Errors</span><a href="#metricAllErrors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
922
981
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
923
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllErrors.metricAllErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllErrors.metricAllErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
982
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllErrors.metricAllErrors-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Errors</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllErrors.metricAllErrors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
924
983
|
<li class="tsd-description">
|
|
925
984
|
<div class="tsd-comment tsd-typography"><p>Metric for the number of Errors executing all Lambdas</p>
|
|
926
|
-
|
|
927
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">sum</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
928
|
-
</code><button>Copy</button></pre>
|
|
929
985
|
</div>
|
|
930
986
|
<div class="tsd-parameters">
|
|
931
987
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
932
988
|
<ul class="tsd-parameter-list">
|
|
933
989
|
<li>
|
|
934
990
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
935
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
991
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
992
|
+
<div class="tsd-comment tsd-typography">
|
|
993
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
994
|
+
</code><button>Copy</button></pre>
|
|
995
|
+
</div><aside class="tsd-sources">
|
|
936
996
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllErrors</p></aside></li></ul></section>
|
|
937
997
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllInvocations" class="tsd-anchor"></a>
|
|
938
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Invocations</span><a href="#metricAllInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
998
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Invocations</span><a href="#metricAllInvocations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
939
999
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
940
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllInvocations.metricAllInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllInvocations.metricAllInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1000
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllInvocations.metricAllInvocations-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Invocations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllInvocations.metricAllInvocations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
941
1001
|
<li class="tsd-description">
|
|
942
1002
|
<div class="tsd-comment tsd-typography"><p>Metric for the number of invocations of all Lambdas</p>
|
|
943
|
-
|
|
944
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">sum</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
945
|
-
</code><button>Copy</button></pre>
|
|
946
1003
|
</div>
|
|
947
1004
|
<div class="tsd-parameters">
|
|
948
1005
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
949
1006
|
<ul class="tsd-parameter-list">
|
|
950
1007
|
<li>
|
|
951
1008
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
952
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
1009
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1010
|
+
<div class="tsd-comment tsd-typography">
|
|
1011
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
1012
|
+
</code><button>Copy</button></pre>
|
|
1013
|
+
</div><aside class="tsd-sources">
|
|
953
1014
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllInvocations</p></aside></li></ul></section>
|
|
954
1015
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllThrottles" class="tsd-anchor"></a>
|
|
955
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Throttles</span><a href="#metricAllThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1016
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Throttles</span><a href="#metricAllThrottles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
956
1017
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
957
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllThrottles.metricAllThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllThrottles.metricAllThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1018
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllThrottles.metricAllThrottles-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Throttles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllThrottles.metricAllThrottles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
958
1019
|
<li class="tsd-description">
|
|
959
1020
|
<div class="tsd-comment tsd-typography"><p>Metric for the number of throttled invocations of all Lambdas</p>
|
|
960
|
-
|
|
961
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">sum</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
962
|
-
</code><button>Copy</button></pre>
|
|
963
1021
|
</div>
|
|
964
1022
|
<div class="tsd-parameters">
|
|
965
1023
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
966
1024
|
<ul class="tsd-parameter-list">
|
|
967
1025
|
<li>
|
|
968
1026
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
969
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
1027
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1028
|
+
<div class="tsd-comment tsd-typography">
|
|
1029
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">sum</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
1030
|
+
</code><button>Copy</button></pre>
|
|
1031
|
+
</div><aside class="tsd-sources">
|
|
970
1032
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllThrottles</p></aside></li></ul></section>
|
|
971
1033
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="metricAllUnreservedConcurrentExecutions" class="tsd-anchor"></a>
|
|
972
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllUnreservedConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1034
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><a href="#metricAllUnreservedConcurrentExecutions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
973
1035
|
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
974
|
-
<li class="tsd-signature tsd-anchor-link" id="metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
1036
|
+
<li class="tsd-signature tsd-anchor-link" id="metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1"><span class="tsd-kind-call-signature">metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Metric</span><a href="#metricAllUnreservedConcurrentExecutions.metricAllUnreservedConcurrentExecutions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
975
1037
|
<li class="tsd-description">
|
|
976
1038
|
<div class="tsd-comment tsd-typography"><p>Metric for the number of unreserved concurrent executions across all Lambdas</p>
|
|
977
|
-
|
|
978
|
-
<h3>Default</h3><pre><code class="language-ts"><span class="hl-5">max</span><span class="hl-0"> </span><span class="hl-5">over</span><span class="hl-0"> </span><span class="hl-8">5</span><span class="hl-0"> </span><span class="hl-5">minutes</span>
|
|
979
|
-
</code><button>Copy</button></pre>
|
|
980
1039
|
</div>
|
|
981
1040
|
<div class="tsd-parameters">
|
|
982
1041
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
983
1042
|
<ul class="tsd-parameter-list">
|
|
984
1043
|
<li>
|
|
985
1044
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type ">MetricOptions</span></h5></li></ul></div>
|
|
986
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4
|
|
1045
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Metric</span></h4>
|
|
1046
|
+
<div class="tsd-comment tsd-typography">
|
|
1047
|
+
<h4>Default</h4><pre><code class="language-ts"><span class="hl-6">max</span><span class="hl-1"> </span><span class="hl-6">over</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1"> </span><span class="hl-6">minutes</span>
|
|
1048
|
+
</code><button>Copy</button></pre>
|
|
1049
|
+
</div><aside class="tsd-sources">
|
|
987
1050
|
<p>Inherited from lambdaNodejs.NodejsFunction.metricAllUnreservedConcurrentExecutions</p></aside></li></ul></section></section></div>
|
|
988
1051
|
<div class="col-sidebar">
|
|
989
1052
|
<div class="page-menu">
|
|
990
1053
|
<div class="tsd-navigation settings">
|
|
991
1054
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
992
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
1055
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
993
1056
|
<div class="tsd-accordion-details">
|
|
994
1057
|
<div class="tsd-filter-visibility">
|
|
995
1058
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -1001,100 +1064,103 @@ within this stack.</p>
|
|
|
1001
1064
|
<div class="tsd-theme-toggle">
|
|
1002
1065
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
1003
1066
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1004
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
1067
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1005
1068
|
<div class="tsd-accordion-details">
|
|
1006
1069
|
<ul>
|
|
1007
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon"
|
|
1008
|
-
<li><a href="#architecture" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1009
|
-
<li><a href="#canCreatePermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1010
|
-
<li><a href="#deadLetterQueue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1011
|
-
<li><a href="#deadLetterTopic" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1012
|
-
<li><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1013
|
-
<li><a href="#functionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1014
|
-
<li><a href="#functionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1015
|
-
<li><a href="#grantPrincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1016
|
-
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1017
|
-
<li><a href="#permissionsNode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1018
|
-
<li><a href="#physicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1019
|
-
<li><a href="#props" class="tsd-is-private"><svg class="tsd-kind-icon"
|
|
1020
|
-
<li><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1021
|
-
<li><a href="#runtime" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1022
|
-
<li><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1023
|
-
<li><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1024
|
-
<li><a href="#connections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1025
|
-
<li><a href="#currentVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1026
|
-
<li><a href="#isBoundToVpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1027
|
-
<li><a href="#latestVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1028
|
-
<li><a href="#logGroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1029
|
-
<li><a href="#resourceArnsForGrantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1030
|
-
<li><a href="#addAlias" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1031
|
-
<li><a href="#addEnvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1032
|
-
<li><a href="#addEventSource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1033
|
-
<li><a href="#addEventSourceMapping" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1034
|
-
<li><a href="#addFunctionUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1035
|
-
<li><a href="#addLayers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1036
|
-
<li><a href="#addPermission" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1037
|
-
<li><a href="#addToRolePolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1038
|
-
<li><a href="#applyRemovalPolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1039
|
-
<li><a href="#configureAsyncInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1040
|
-
<li><a href="#considerWarningOnInvokeFunctionPermissions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1041
|
-
<li><a href="#generatePhysicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1042
|
-
<li><a href="#getResourceArnAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1043
|
-
<li><a href="#getResourceNameAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1044
|
-
<li><a href="#grantDeleteAsset" class=""><svg class="tsd-kind-icon"
|
|
1045
|
-
<li><a href="#grantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1046
|
-
<li><a href="#grantInvokeUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1047
|
-
<li><a href="#grantSendEmails" class=""><svg class="tsd-kind-icon"
|
|
1048
|
-
<li><a href="#grantTableWrite" class=""><svg class="tsd-kind-icon"
|
|
1049
|
-
<li><a href="#grantUploadAssets" class=""><svg class="tsd-kind-icon"
|
|
1050
|
-
<li><a href="#grantUserpoolRead" class=""><svg class="tsd-kind-icon"
|
|
1051
|
-
<li><a href="#grantUserpoolReadWrite" class=""><svg class="tsd-kind-icon"
|
|
1052
|
-
<li><a href="#metric" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1053
|
-
<li><a href="#metricDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1054
|
-
<li><a href="#metricErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1055
|
-
<li><a href="#metricInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1056
|
-
<li><a href="#metricThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1057
|
-
<li><a href="#setTable" class=""><svg class="tsd-kind-icon"
|
|
1058
|
-
<li><a href="#setTimeout" class=""><svg class="tsd-kind-icon"
|
|
1059
|
-
<li><a href="#setUserPool" class=""><svg class="tsd-kind-icon"
|
|
1060
|
-
<li><a href="#toString" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1061
|
-
<li><a href="#warnInvokeFunctionPermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1062
|
-
<li><a href="#classifyVersionProperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1063
|
-
<li><a href="#fromFunctionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1064
|
-
<li><a href="#fromFunctionAttributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1065
|
-
<li><a href="#fromFunctionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1066
|
-
<li><a href="#isConstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1067
|
-
<li><a href="#isOwnedResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1068
|
-
<li><a href="#isResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1069
|
-
<li><a href="#metricAll" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1070
|
-
<li><a href="#metricAllConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1071
|
-
<li><a href="#metricAllDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1072
|
-
<li><a href="#metricAllErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1073
|
-
<li><a href="#metricAllInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1074
|
-
<li><a href="#metricAllThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1075
|
-
<li><a href="#metricAllUnreservedConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon"
|
|
1070
|
+
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
1071
|
+
<li><a href="#architecture" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>architecture</span></a></li>
|
|
1072
|
+
<li><a href="#canCreatePermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>can<wbr/>Create<wbr/>Permissions</span></a></li>
|
|
1073
|
+
<li><a href="#deadLetterQueue" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Queue</span></a></li>
|
|
1074
|
+
<li><a href="#deadLetterTopic" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dead<wbr/>Letter<wbr/>Topic</span></a></li>
|
|
1075
|
+
<li><a href="#env" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>env</span></a></li>
|
|
1076
|
+
<li><a href="#functionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Arn</span></a></li>
|
|
1077
|
+
<li><a href="#functionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>function<wbr/>Name</span></a></li>
|
|
1078
|
+
<li><a href="#grantPrincipal" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>grant<wbr/>Principal</span></a></li>
|
|
1079
|
+
<li><a href="#node" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>node</span></a></li>
|
|
1080
|
+
<li><a href="#permissionsNode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>permissions<wbr/>Node</span></a></li>
|
|
1081
|
+
<li><a href="#physicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>physical<wbr/>Name</span></a></li>
|
|
1082
|
+
<li><a href="#props" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>props</span></a></li>
|
|
1083
|
+
<li><a href="#role" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>role</span></a></li>
|
|
1084
|
+
<li><a href="#runtime" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>runtime</span></a></li>
|
|
1085
|
+
<li><a href="#stack" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>stack</span></a></li>
|
|
1086
|
+
<li><a href="#timeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>timeout</span></a></li>
|
|
1087
|
+
<li><a href="#connections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>connections</span></a></li>
|
|
1088
|
+
<li><a href="#currentVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>current<wbr/>Version</span></a></li>
|
|
1089
|
+
<li><a href="#isBoundToVpc" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>is<wbr/>Bound<wbr/>To<wbr/>Vpc</span></a></li>
|
|
1090
|
+
<li><a href="#latestVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>latest<wbr/>Version</span></a></li>
|
|
1091
|
+
<li><a href="#logGroup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>log<wbr/>Group</span></a></li>
|
|
1092
|
+
<li><a href="#resourceArnsForGrantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>resource<wbr/>Arns<wbr/>For<wbr/>Grant<wbr/>Invoke</span></a></li>
|
|
1093
|
+
<li><a href="#addAlias" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Alias</span></a></li>
|
|
1094
|
+
<li><a href="#addEnvironment" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Environment</span></a></li>
|
|
1095
|
+
<li><a href="#addEventSource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source</span></a></li>
|
|
1096
|
+
<li><a href="#addEventSourceMapping" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Source<wbr/>Mapping</span></a></li>
|
|
1097
|
+
<li><a href="#addFunctionUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Function<wbr/>Url</span></a></li>
|
|
1098
|
+
<li><a href="#addLayers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Layers</span></a></li>
|
|
1099
|
+
<li><a href="#addPermission" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Permission</span></a></li>
|
|
1100
|
+
<li><a href="#addToRolePolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Role<wbr/>Policy</span></a></li>
|
|
1101
|
+
<li><a href="#applyRemovalPolicy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>apply<wbr/>Removal<wbr/>Policy</span></a></li>
|
|
1102
|
+
<li><a href="#configureAsyncInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>configure<wbr/>Async<wbr/>Invoke</span></a></li>
|
|
1103
|
+
<li><a href="#considerWarningOnInvokeFunctionPermissions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>consider<wbr/>Warning<wbr/>On<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a></li>
|
|
1104
|
+
<li><a href="#generatePhysicalName" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>generate<wbr/>Physical<wbr/>Name</span></a></li>
|
|
1105
|
+
<li><a href="#getResourceArnAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Arn<wbr/>Attribute</span></a></li>
|
|
1106
|
+
<li><a href="#getResourceNameAttribute" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Resource<wbr/>Name<wbr/>Attribute</span></a></li>
|
|
1107
|
+
<li><a href="#grantDeleteAsset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Delete<wbr/>Asset</span></a></li>
|
|
1108
|
+
<li><a href="#grantInvoke" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke</span></a></li>
|
|
1109
|
+
<li><a href="#grantInvokeUrl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Invoke<wbr/>Url</span></a></li>
|
|
1110
|
+
<li><a href="#grantSendEmails" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Send<wbr/>Emails</span></a></li>
|
|
1111
|
+
<li><a href="#grantTableWrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Table<wbr/>Write</span></a></li>
|
|
1112
|
+
<li><a href="#grantUploadAssets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Upload<wbr/>Assets</span></a></li>
|
|
1113
|
+
<li><a href="#grantUserpoolRead" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read</span></a></li>
|
|
1114
|
+
<li><a href="#grantUserpoolReadWrite" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>grant<wbr/>Userpool<wbr/>Read<wbr/>Write</span></a></li>
|
|
1115
|
+
<li><a href="#metric" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric</span></a></li>
|
|
1116
|
+
<li><a href="#metricDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Duration</span></a></li>
|
|
1117
|
+
<li><a href="#metricErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Errors</span></a></li>
|
|
1118
|
+
<li><a href="#metricInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Invocations</span></a></li>
|
|
1119
|
+
<li><a href="#metricThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>Throttles</span></a></li>
|
|
1120
|
+
<li><a href="#setTable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Table</span></a></li>
|
|
1121
|
+
<li><a href="#setTimeout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Timeout</span></a></li>
|
|
1122
|
+
<li><a href="#setUserPool" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Pool</span></a></li>
|
|
1123
|
+
<li><a href="#toString" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a></li>
|
|
1124
|
+
<li><a href="#warnInvokeFunctionPermissions" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>warn<wbr/>Invoke<wbr/>Function<wbr/>Permissions</span></a></li>
|
|
1125
|
+
<li><a href="#classifyVersionProperty" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>classify<wbr/>Version<wbr/>Property</span></a></li>
|
|
1126
|
+
<li><a href="#fromFunctionArn" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Arn</span></a></li>
|
|
1127
|
+
<li><a href="#fromFunctionAttributes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Attributes</span></a></li>
|
|
1128
|
+
<li><a href="#fromFunctionName" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Function<wbr/>Name</span></a></li>
|
|
1129
|
+
<li><a href="#isConstruct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Construct</span></a></li>
|
|
1130
|
+
<li><a href="#isOwnedResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a></li>
|
|
1131
|
+
<li><a href="#isResource" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Resource</span></a></li>
|
|
1132
|
+
<li><a href="#metricAll" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All</span></a></li>
|
|
1133
|
+
<li><a href="#metricAllConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Concurrent<wbr/>Executions</span></a></li>
|
|
1134
|
+
<li><a href="#metricAllDuration" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Duration</span></a></li>
|
|
1135
|
+
<li><a href="#metricAllErrors" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Errors</span></a></li>
|
|
1136
|
+
<li><a href="#metricAllInvocations" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Invocations</span></a></li>
|
|
1137
|
+
<li><a href="#metricAllThrottles" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Throttles</span></a></li>
|
|
1138
|
+
<li><a href="#metricAllUnreservedConcurrentExecutions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>metric<wbr/>All<wbr/>Unreserved<wbr/>Concurrent<wbr/>Executions</span></a></li></ul></div></details></div>
|
|
1076
1139
|
<div class="site-menu">
|
|
1077
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
1140
|
+
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
1078
1141
|
<ul class="tsd-small-nested-navigation">
|
|
1079
|
-
<li><a href="AssetCdn.html"><svg class="tsd-kind-icon"
|
|
1080
|
-
<li><a href="BaseApi.html"><svg class="tsd-kind-icon"
|
|
1081
|
-
<li><a href="CognitoAuthentication.html"><svg class="tsd-kind-icon"
|
|
1082
|
-
<li><a href="
|
|
1083
|
-
<li><a href="
|
|
1084
|
-
<li><a href="
|
|
1085
|
-
<li><a href="
|
|
1086
|
-
<li><a href="
|
|
1087
|
-
<li><a href="../interfaces/
|
|
1088
|
-
<li><a href="../interfaces/
|
|
1089
|
-
<li><a href="../interfaces/
|
|
1090
|
-
<li><a href="../interfaces/
|
|
1091
|
-
<li><a href="../interfaces/
|
|
1092
|
-
<li><a href="../interfaces/
|
|
1093
|
-
<li><a href="../interfaces/
|
|
1094
|
-
<li><a href="../interfaces/
|
|
1095
|
-
<li><a href="../interfaces/
|
|
1096
|
-
<li><a href="../interfaces/
|
|
1097
|
-
<li><a href="../
|
|
1142
|
+
<li><a href="AssetCdn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn</span></a></li>
|
|
1143
|
+
<li><a href="BaseApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Base<wbr/>Api</span></a></li>
|
|
1144
|
+
<li><a href="CognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authentication</span></a></li>
|
|
1145
|
+
<li><a href="GraphQlApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Ql<wbr/>Api</span></a></li>
|
|
1146
|
+
<li><a href="LambdaFunction.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Lambda<wbr/>Function</span></a></li>
|
|
1147
|
+
<li><a href="RestApi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rest<wbr/>Api</span></a></li>
|
|
1148
|
+
<li><a href="SingleTableDatastore.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Single<wbr/>Table<wbr/>Datastore</span></a></li>
|
|
1149
|
+
<li><a href="Workflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Workflow</span></a></li>
|
|
1150
|
+
<li><a href="../interfaces/AssetCdnProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Cdn<wbr/>Props</span></a></li>
|
|
1151
|
+
<li><a href="../interfaces/BaseApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Api<wbr/>Props</span></a></li>
|
|
1152
|
+
<li><a href="../interfaces/CognitoAuthenticationProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cognito<wbr/>Authentication<wbr/>Props</span></a></li>
|
|
1153
|
+
<li><a href="../interfaces/GraphQlApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Graph<wbr/>Ql<wbr/>Api<wbr/>Props</span></a></li>
|
|
1154
|
+
<li><a href="../interfaces/ICognitoAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>ICognito<wbr/>Authentication</span></a></li>
|
|
1155
|
+
<li><a href="../interfaces/IJwtAuthentication.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IJwt<wbr/>Authentication</span></a></li>
|
|
1156
|
+
<li><a href="../interfaces/LambdaFunctionProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Function<wbr/>Props</span></a></li>
|
|
1157
|
+
<li><a href="../interfaces/LambdaTracingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Lambda<wbr/>Tracing<wbr/>Options</span></a></li>
|
|
1158
|
+
<li><a href="../interfaces/RestApiProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rest<wbr/>Api<wbr/>Props</span></a></li>
|
|
1159
|
+
<li><a href="../interfaces/SingleTableDatastoreProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Datastore<wbr/>Props</span></a></li>
|
|
1160
|
+
<li><a href="../interfaces/SingleTableDesign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Table<wbr/>Design</span></a></li>
|
|
1161
|
+
<li><a href="../interfaces/VtlResolverOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vtl<wbr/>Resolver<wbr/>Options</span></a></li>
|
|
1162
|
+
<li><a href="../interfaces/WorkflowProps.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workflow<wbr/>Props</span></a></li>
|
|
1163
|
+
<li><a href="../types/LambdaOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Lambda<wbr/>Options</span></a></li></ul></nav></div></div></div>
|
|
1098
1164
|
<div class="tsd-generator">
|
|
1099
1165
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
1100
1166
|
<div class="overlay"></div></body></html>
|