@ashishpandeyone/cdk-lambda-web-function 0.1.9 → 0.1.11

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/.jsii CHANGED
@@ -9745,7 +9745,7 @@
9745
9745
  },
9746
9746
  "name": "@ashishpandeyone/cdk-lambda-web-function",
9747
9747
  "readme": {
9748
- "markdown": "# CDK constructs for AWS Lambda Web Functions\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[AWS Lambda Web Functions](https://docs.aws.amazon.com/lambda/latest/dg/web-functions.html) run an ordinary Node.js HTTP server (Express, Fastify, Hono, `node:http`) on Lambda and give it an HTTPS endpoint, optionally served from several regions. `WebFunction` deploys one, following the conventions of `aws-cdk-lib/aws-lambda` where the two services overlap.\n\n```ts fixture=bare\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\nimport { WebFunction, WebFunctionAuthType, WebFunctionEndpointType } from '@ashishpandeyone/cdk-lambda-web-function';\n\nconst fn = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n endpointType: WebFunctionEndpointType.MULTI_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n },\n});\n\nnew CfnOutput(this, 'Url', { value: fn.endpoint.url }); // https://<id>.lambda-web.global.on.aws\n```\n\nThe stack's region is the function's **home region**. Multi-region endpoints need a stack with an explicit `env.region`.\n\n## Installation\n\n```bash\nnpm install @ashishpandeyone/cdk-lambda-web-function\n```\n\nIt needs `aws-cdk-lib` 2.273.0 or later and `constructs` 10.5.1 or later (peer dependencies), and Node.js 22 or later. The package is published for TypeScript and JavaScript only.\n\n## Writing the server\n\n1. Listen on the host and port in **`AWS_LAMBDA_HTTP_ENDPOINT`** (`0.0.0.0:3000` today). `PORT` is not set.\n2. Start listening within **10 seconds**, or initialisation fails with `Application.TimeoutListenError`.\n3. Put the entry file at the root of your bundle as **`index.js`**, or set `entrypoint`.\n4. The runtime has **no AWS SDK**: bundle the clients you import.\n5. Code runs on **arm64**.\n\n```js\nconst express = require('express');\n\nconst app = express();\napp.get('/', (req, res) => res.json({ hello: 'world', region: process.env.AWS_REGION }));\n\nconst [host, port] = process.env.AWS_LAMBDA_HTTP_ENDPOINT.split(':');\napp.listen(Number(port), host);\n```\n\nRequests carry `lambda-web-request-id` and `lambda-web-endpoint-name` headers.\n\n## Regions and endpoints\n\nEach `WebFunction` has a default endpoint, `fn.endpoint`, configured with the `endpoint` property. [Add more](#more-endpoints) with `fn.addEndpoint()`.\n\n| `endpointType` | URL | Routing |\n|---|---|---|\n| `HOME_REGION` (default) | `https://<id>.<cell>.lambda-web.<home>.on.aws` | home region only |\n| `MULTI_REGION` | one global `https://<id>.lambda-web.global.on.aws` | nearest region |\n| `PER_REGION` | one URL per region, from `fn.endpoint.regionalUrl(region)` | the region in the hostname |\n\n```ts\nconst perRegion = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n endpointType: WebFunctionEndpointType.PER_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n },\n});\n\nnew CfnOutput(this, 'UsEast1Url', { value: perRegion.endpoint.regionalUrl('us-east-1') });\n// perRegion.endpoint.regions is ['<home region>', 'eu-west-1', 'us-east-1']\n```\n\n- `MULTI_REGION` and `PER_REGION` need at least one region besides the home region; `HOME_REGION` takes none.\n- A MultiRegion endpoint takes about a minute to create.\n- Lambda routes a `MULTI_REGION` endpoint by latency, not by health: it doesn't fail over when a region has problems.\n\n### More endpoints\n\nA function can have up to 10 endpoints, each with its own URL, authentication, regions and limits. For example, a public endpoint next to an IAM-only global one:\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.NONE, // the default endpoint is public\n endpoint: { rateLimit: 1000 }, // requests per second\n});\n\nconst internal = api.addEndpoint('Internal', {\n authType: WebFunctionAuthType.AWS_IAM,\n endpointType: WebFunctionEndpointType.MULTI_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n description: 'Service-to-service traffic',\n maxEnvironments: 50,\n});\ninternal.grantInvoke(consumerRole);\nnew CfnOutput(this, 'InternalUrl', { value: internal.url });\n```\n\n- `rateLimit` takes 0 (blocks all traffic), 100–1,000 in steps of 100, or 2,000–10,000 in steps of 1,000; excess requests get HTTP 429. `maxEnvironments` takes 2–10,000.\n- **Both limits apply separately in each region** an endpoint serves from: a 3-region endpoint with `rateLimit: 1000` accepts up to 1,000 requests per second in each region.\n- Endpoints can serve the same regions. The construct owns one `.local` log group per region, whichever endpoints serve it.\n\n### Changing regions or the endpoint type\n\nAn endpoint's type and regions can't change in place: a change creates a **new endpoint with a new URL**, and the old one is deleted once the new one is live. Two endpoints of one function can't share a name, so:\n\n| `endpointName` | Physical name | Changing `regions` or `endpointType` |\n|---|---|---|\n| omitted (recommended) | `default-<hash>` for `fn.endpoint`, `<id>-<hash>` for added endpoints; the hash covers the type and regions | works: new endpoint, new URL |\n| set, e.g. `'live'` | `live` | also change the name in the same deployment, or it fails with *The endpoint live already exists* (the stack rolls back and the old endpoint keeps serving) |\n\nThe construct warns at synth time when `endpointName` is set.\n\n## Authentication and invoking\n\n| `authType` | Meaning |\n|---|---|\n| `AWS_IAM` | Callers sign requests (SigV4 or SigV4a, signing name `lambda`) and need `lambda:InvokeWebFunctionEndpoint` |\n| `NONE` | **Public**: Lambda does no authentication; your application does (JWT, sessions). The `Authorization` header reaches your application untouched. The construct warns at synth time |\n\n```ts\nfn.grants.invoke(consumerRole); // or fn.grantInvoke(consumerRole), as on lambda.Function\n```\n\nThe grant is on the endpoint's home-region ARN, which IAM evaluates in every region the endpoint serves from, including the global URL. `fn.grants` covers the default endpoint only; grant other endpoints with their own `grantInvoke()` or `grants.invoke()`.\n\n| Endpoint | How to sign |\n|---|---|\n| `HOME_REGION` | SigV4 for the home region |\n| `PER_REGION` | SigV4 for the hostname's region, or SigV4a |\n| `MULTI_REGION` | **SigV4a with region set `*`**: you can't know which region will serve the request |\n\n```js\nimport { SignatureV4a } from '@smithy/signature-v4a';\nimport { Sha256 } from '@aws-crypto/sha256-js';\nimport { fromNodeProviderChain } from '@aws-sdk/credential-providers';\n\nconst host = new URL(url).hostname; // url: the endpoint's URL\nconst signer = new SignatureV4a({ service: 'lambda', region: '*', sha256: Sha256, credentials: fromNodeProviderChain() });\nconst signed = await signer.sign(\n { method: 'GET', protocol: 'https:', hostname: host, path: '/', headers: { host } },\n { signingRegion: '*' },\n);\nconst response = await fetch(`https://${host}/`, { headers: signed.headers });\n```\n\n### Other accounts and AWS services\n\nA caller in another account needs permission twice: in its own IAM policy, and in the function's **resource policy**. `grantInvoke` handles the function's side: a role in the function's account only gets an IAM policy statement, while a principal in another account or an AWS service also gets a statement in the resource policy.\n\n```ts\nfn.grantInvoke(iam.Role.fromRoleArn(this, 'Partner', 'arn:aws:iam::444455556666:role/caller'));\n```\n\nFor principals you can't grant to (a whole account, an organization, an AWS service with conditions), use `addPermission`. The `id` becomes the statement's `Sid`:\n\n```ts\nfn.addPermission('PartnerAccount', { principal: new iam.AccountPrincipal('444455556666') });\nfn.addPermission('MyOrg', { principal: new iam.OrganizationPrincipal('o-a1b2c3d4e5'), endpoint: fn.endpoint });\nfn.addPermission('Cdn', {\n principal: new iam.ServicePrincipal('cloudfront.amazonaws.com'),\n sourceArn: `arn:aws:cloudfront::${this.account}:distribution/EDFDVBD6EXAMPLE`,\n});\n```\n\n`addPermission` allows calling every endpoint unless you pass `endpoint`. For other actions, such as letting another account create revisions, use `fn.addToResourcePolicy(statement)`. Statements use the endpoint ARN for invoking and the function ARN for actions on the function.\n\n- **Each stack writes only its own statements.** A Web Function has a single resource policy, and Web Functions have no `AddPermission`. So each stack that adds statements gets a custom resource (`Custom::LambdaWebResourcePolicyStatements`). It reads the policy, replaces the statements that stack wrote before, and writes the policy back, retrying if another writer changed it in the meantime. Statements from other stacks, and ones added outside CloudFormation, are kept. Writers include the function's stack, a stack with a CloudFront distribution, and a stack that imports the function in the same account.\n- **Sids are unique in the policy.** `addPermission`'s `id` becomes the statement's `Sid`, and other statements get a generated one (`Cdk<hash><n>`). If another stack or tool already uses that `Sid` for different content, the deployment fails with the `Sid`.\n- **Don't also attach an `AWS::Lambda::ResourcePolicy` yourself.** That resource replaces the whole document on every update, dropping every other writer's statements.\n- **Public policies are rejected.** Lambda refuses a policy that lets anyone call the function, and the construct fails synthesis first. A `*` principal is only accepted with a condition that pins the caller, such as `aws:PrincipalOrgID` (`iam.OrganizationPrincipal`) or `aws:SourceAccount`. For a public endpoint, use `authType: NONE`.\n- **Scope AWS services to your resource.** Lambda accepts a service principal with no condition, which would let that service call the endpoint on behalf of any account. The construct warns unless you give `sourceArn` or `sourceAccount` (or an `aws:SourceArn`, `aws:SourceAccount`, `aws:SourceOrgID` or `aws:SourceOrgPaths` condition).\n- Lambda copies the policy to every region the function's endpoints serve from. The copy is eventually consistent, and in tests changes applied in every region within seconds.\n\n### CloudFront\n\nPut a CloudFront distribution (`aws-cdk-lib/aws-cloudfront`) in front of an `AWS_IAM` endpoint to serve the public with a custom domain, caching and AWS WAF. Viewers don't sign anything, and only your distribution may call the endpoint:\n\n```ts\nnew cloudfront.Distribution(this, 'Cdn', {\n defaultBehavior: {\n origin: WebFunctionOrigin.withOriginAccessControl(fn.endpoint),\n viewerProtocolPolicy: cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,\n allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL,\n cachePolicy: cloudfront.CachePolicy.CACHING_DISABLED,\n originRequestPolicy: cloudfront.OriginRequestPolicy.ALL_VIEWER_EXCEPT_HOST_HEADER,\n },\n});\n```\n\n`withOriginAccessControl` adds:\n- an origin access control (origin type `lambda`, signing behavior `always-amz-auth`, the only one CloudFront accepts for Web Function origins), one per stack and signing protocol: SigV4 for a regional domain, SigV4a for a `MULTI_REGION` endpoint's global domain;\n- a statement in the function's resource policy that allows `cloudfront.amazonaws.com` to call this endpoint on behalf of this distribution only (`aws:SourceArn`).\n\nSome things to know:\n- **Forward everything except `Host`.** The endpoint answers 404 when `Host` is the distribution's domain, so use `ALL_VIEWER_EXCEPT_HOST_HEADER` (not `ALL_VIEWER`), or a policy of your own without `Host`.\n- **Your application can still authenticate viewers.** CloudFront signs in its own headers and passes the viewer's `Authorization` header (a JWT, for example) through unchanged, but only when `Authorization` is in the cache policy. CloudFront drops it from `GET` and `HEAD` requests otherwise:\n\n ```ts\n const forwardAuthorization = new cloudfront.CachePolicy(this, 'ForwardAuthorization', {\n headerBehavior: cloudfront.CacheHeaderBehavior.allowList('Authorization'),\n minTtl: Duration.seconds(0),\n defaultTtl: Duration.seconds(0),\n maxTtl: Duration.seconds(1), // a cache key with headers needs caching enabled; 0/0/1 keeps it off in practice\n });\n ```\n- Request bodies work without clients sending `x-amz-content-sha256`: CloudFront signs `POST`, `PUT` and `PATCH` requests with an unsigned payload.\n- A `PER_REGION` endpoint's origin calls one region: the home region, or the one you pass as `region`. Use one origin per region, for example in an origin group.\n- A `MULTI_REGION` endpoint can't include opt-in regions (such as `me-central-1`), because CloudFront can't sign for them. The construct fails synthesis.\n- The distribution can be in another stack, in the function's account. Its stack writes the CloudFront statement into the function's resource policy, so the function's stack doesn't depend on it.\n- That stack can also be in another region, for example us-east-1 for an ACM certificate. CDK then passes the endpoint's domain and ARN with its cross-region references: SSM parameters plus custom resources of its own.\n- **Those references are strong by default.** A change that replaces the endpoint gives it a new domain and ARN. That includes a new endpoint type or region set, or a renamed function. The function's stack can't update a value while the distribution's stack still uses the old one, the same as with `Fn::ImportValue` in one region. Deploy such a change in two steps, or use weak references: CDK's synth warning `@aws-cdk/core:crossStackReferencesDefaultStrong` explains how.\n- Lambda@Edge origin-request and origin-response triggers aren't supported on behaviors with this origin.\n- The endpoint stays reachable at its own domain for signed requests your policies allow. Until a new distribution finishes deploying, requests through it can get a transient 403.\n- `new WebFunctionOrigin(endpoint)` is for a public (`NONE`) endpoint, for example behind AWS WAF. Lambda doesn't authenticate those requests, so the endpoint's own domain stays public too.\n\n### Functions defined elsewhere\n\nImport a Web Function defined in another stack or app to grant access to it, read its metrics, or reference its revisions:\n\n```ts\nconst orders = WebFunction.fromWebFunctionArn(this, 'Orders', 'arn:aws:lambda:us-east-1:111122223333:web-function/orders');\norders.grantInvoke(consumerRole); // every endpoint of the function\n\nconst live = WebFunction.fromWebFunctionAttributes(this, 'Live', {\n webFunctionName: 'orders', // in this stack's account and region\n endpointName: 'live', // grantInvoke allows this endpoint only\n});\nlive.metricConcurrentRequests().createAlarm(this, 'Busy', { threshold: 60, evaluationPeriods: 3 });\n```\n\nAn imported function's metrics default to its own region. Its endpoints, revisions and log groups stay with the stack that defines it.\n\nAn imported function works like a `WebFunction` here. `grantInvoke` and `addToResourcePolicy` write the importing stack's statements into the function's resource policy, in the function's region. This works only when the function is in the stack's account. For a function in another account, `grantInvoke` adds to the caller's IAM policy only, and `addToResourcePolicy` adds nothing and warns, so ask that account to allow the caller.\n\n## Configuration\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('build'),\n authType: WebFunctionAuthType.AWS_IAM,\n entrypoint: 'server.js', // default index.js\n webFunctionName: 'orders-api', // default: generated from the construct path\n description: 'Orders HTTP API',\n environment: { TABLE_NAME: table.tableName },\n timeout: Duration.seconds(60), // per request: 3 seconds to 15 minutes, default 30 seconds\n maxConcurrencyPerEnvironment: 32, // requests per environment at once: 1-128, default 64\n});\n\napi.addEnvironment('FEATURE_FLAG', 'on');\ntable.grantReadWriteData(api); // the default role trusts lambda.amazonaws.com\n```\n\n- **Each execution environment has 2 vCPUs and 2 GB of memory.** There's no memory setting as on Lambda functions; scale with `maxConcurrencyPerEnvironment` and more environments instead.\n- Requests handled by one environment share module-level state, so keep handlers concurrency-safe.\n- Environment variable names starting with `AWS_` are reserved.\n- **The default execution role can only write to the function's own log groups**: the home region's, and the `.local` copy in every region it serves from. That's the minimum AWS documents for Web Functions. It doesn't use `AWSLambdaBasicExecutionRole`, which can also create any log group. Pass `role` to use your own, and include those log permissions.\n- **Renaming the function replaces it and changes its URL.** A generated name depends on the construct path, so moving the construct renames it too.\n\n### Bundling TypeScript with `NodejsWebFunction`\n\n`NodejsWebFunction` is a `WebFunction` that bundles your server from a TypeScript or JavaScript entry file with esbuild, like `NodejsFunction` does for Lambda functions:\n\n```ts\nnew NodejsWebFunction(this, 'Api', {\n entry: 'src/server.ts',\n authType: WebFunctionAuthType.AWS_IAM,\n bundling: {\n minify: true, // default true\n sourceMap: true, // default true\n format: lambdaNodejs.OutputFormat.ESM, // default ESM (index.mjs); CJS gives index.js\n externalModules: [], // default: bundle everything you import\n },\n});\n```\n\n- **Defaults:** `runtime` is `NODEJS_24_X`, and the esbuild target follows the runtime (`node24`). The project root is the directory of the nearest lock file above `entry` (override it with `depsLockFilePath` or `projectRoot`).\n- **It also sets what a `lambda.Code` can't:** the entry point that matches the bundle, and `NODE_OPTIONS=--enable-source-maps` when source maps are on, appended to any `NODE_OPTIONS` you set, so stack traces point at your `.ts` files (e.g. `/var/task/src/server.ts:22:12`). Source map paths are relative to the project root, so no build-machine paths are deployed.\n- **ESM bundles include a `require` shim**, so CommonJS dependencies that load Node.js built-ins (Express, for example) work.\n- **The AWS SDK is bundled like any other dependency**, since the runtime has none. Only the clients you import are included.\n- **Bundling runs locally** when esbuild is installed in your project, and otherwise in Docker (an arm64 AWS SAM build image; set `forceDockerBundling` to always use Docker).\n- **Not yet supported:** installing native modules next to the bundle (`nodeModules`) and command hooks. For native dependencies, use `WebFunction` with `Code.fromAsset(..., { bundling: { image, command } })`.\n\n### Code\n\n`code` takes any `lambda.Code` that produces a zip in S3: `fromAsset`, `fromBucket`/`fromBucketV2`, `fromCustomCommand`, `fromDockerBuild`. Inline code and container images fail at synth time.\n\nLambda Web Functions download code as the `lambda.amazonaws.com` service principal, from a **versioned** bucket, and the CDK bootstrap bucket allows neither. So each stack gets a small code bucket, and the code is copied into it on deploy. The bucket is emptied and deleted with the stack.\n\nCopying code, managing the function's log groups in every region, looking up regional URLs, cleaning up old revisions, creating rollback alarms in other regions and emptying the code bucket all run in one custom resource Lambda per stack. Its logs go to a log group the stack owns, kept for a month and deleted with the stack.\n\n## Revisions\n\nAny change to code or configuration creates a new **revision** (`fn.currentRevision`), and endpoints switch to it once it's ready. A failed deployment rolls back to the previous revision. If nothing changed, nothing is deployed.\n\nEarlier revisions are kept, so you can roll back or route traffic to them. After each deployment, the construct deletes the oldest beyond `revisionRetention` (default 20, up to 50). It never deletes a revision an endpoint routes to, or one the previous deployment used, which a rollback returns to.\n\n```ts\nnew WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n revisionRetention: 5,\n});\n```\n\n### Routing to earlier revisions\n\nReference an earlier revision by its ID (for example from a `CfnOutput` of `fn.currentRevision.revisionId`, or `aws lambda-web list-web-function-revisions`). Then pin an endpoint to it, or split traffic between two revisions:\n\n```ts\nconst previous = WebFunctionRevision.fromRevisionAttributes(this, 'Previous', {\n webFunction: fn,\n revisionId: 'rev-a1b2c',\n});\n\n// Keep the default endpoint on the previous revision, and send 10% to the new one:\nfn.endpoint.routeTraffic(previous, [{ revision: fn.currentRevision, weight: 0.1 }]);\n\n// Or a second endpoint that stays on the previous revision while fn.endpoint moves on:\nfn.addEndpoint('Stable', { authType: WebFunctionAuthType.AWS_IAM, revision: previous });\n```\n\n- An endpoint routes to at most two revisions. The additional revision's `weight` is a whole percentage, from 0.01 to 0.99.\n- To promote, remove `routeTraffic` (or `revision`) and deploy: the endpoint serves the current revision again.\n- Lambda Web Function metrics have no revision dimension. To compare a split's revisions, log a version you control (for example an environment variable) from your application.\n\n### Canary and linear deployments\n\nBy default an endpoint moves all its traffic to a new revision at once. With `deployment`, it moves in steps instead, watching CloudWatch alarms: if one goes into ALARM, the endpoint goes back to the revision it served before and the deployment fails, so CloudFormation rolls the stack back.\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n // 10% of the traffic for 10 minutes, then all of it; back if more than 2% of requests get a 5XX.\n deployment: WebFunctionDeployment.canary({ percent: 10, bake: Duration.minutes(10), rollbackOn: { serverErrorRate: 2 } }),\n },\n});\n\n// 25% more every 5 minutes, watching an alarm of your own. Each endpoint has its own deployment.\n// errorRate: any cloudwatch.IAlarm, e.g. on a metric your application publishes.\napi.addEndpoint('Public', {\n authType: WebFunctionAuthType.NONE,\n deployment: WebFunctionDeployment.linear({ percent: 25, interval: Duration.minutes(5), alarms: [errorRate] }),\n});\n```\n\n| | Steps | Limits |\n|---|---|---|\n| `allAtOnce()` (default) | 100% | |\n| `canary({ percent, bake })` | `percent`, then 100% after `bake` | `percent` 1–99, `bake` 1–45 minutes |\n| `linear({ percent, interval })` | `percent` more every `interval` | `percent` 5–50, `interval` from 1 minute, at most 45 minutes in all |\n\nHow it works:\n\n- Each deployment that creates a revision (code or configuration) moves the traffic from the revision the endpoint serves at that moment, which is also what it goes back to. If someone switched the endpoint outside CloudFormation, the deployment starts from there.\n- Each step waits until every region of a `MULTI_REGION` or `PER_REGION` endpoint has applied it (usually about 15 seconds), and if a region fails to update, the endpoint goes back as for an alarm. The bake or interval counts from the start of the step.\n- Alarms are checked before the first step (an alarm already in ALARM stops the deployment before any traffic moves), throughout every step, and once the new revision has all the traffic. They can be in any region, and composite alarms work. `INSUFFICIENT_DATA` doesn't stop a deployment.\n- A rollback of the stack, for any reason, moves the traffic back at once, without waiting or checking alarms.\n- A stack's first deployment, and a new endpoint (including one renamed by a region change), serve the revision at once: there's nothing to move from.\n- A deployment can take up to an hour: CloudFormation waits for it before it updates the endpoint. Deployments of different endpoints run in parallel.\n- A canary or linear endpoint always moves to the current revision, so it can't also use `revision`, `additionalRevisions` or `routeTraffic()`. Use `allAtOnce()` to deploy a fix immediately, for example while an alarm is in ALARM.\n\n#### Rollback alarms\n\n`rollbackOn` makes the endpoint create alarms on its own error rates, and the deployment watches them alongside any `alarms` you pass:\n\n| `rollbackOn` | Default | |\n|---|---|---|\n| `serverErrorRate` | none | roll back when more than this % of requests get a 5XX |\n| `clientErrorRate` | none | the same for 4XX (including 429s from `rateLimit` and `maxEnvironments`) |\n| `minimumRequests` | 10 | periods with fewer requests don't count, so one failed request out of two doesn't roll back |\n| `period`, `evaluationPeriods` | 1 minute, 2 | consecutive periods over the threshold before rolling back |\n\n- **One alarm per threshold in every region the endpoint serves from.** Metrics are published in the region that served the request, and an alarm can only watch metrics in its own region. The home region's alarm is a normal CloudFormation alarm; the others are created and deleted with the endpoint by a custom resource, and named `LambdaWeb-<function>-<endpoint>-5xx-rate` (or `-4xx-rate`). `endpoint.rollbackAlarms` lists them all, e.g. to add notifications to the home region's.\n- **The alarms see the whole endpoint.** Lambda Web Function metrics have no revision dimension, so at 10% a new revision's errors are about a tenth of the endpoint's: set the threshold low enough to notice that, or alarm on metrics your application publishes with its version.\n- **5XX includes the platform's 503s** while the endpoint scales up for a sudden burst, not only your application's errors.\n- **A step should outlast the alarm.** CloudWatch needs `period` × `evaluationPeriods`, plus a couple of minutes of delay, to fire; the construct warns when a canary's bake or a linear interval is shorter.\n\nThe deployment runs in a few resources per stack, created on first use: two Lambda functions, a Step Functions state machine that calls them every 15 seconds, and a log group.\n\n## Metrics\n\nEndpoints and functions have helpers for their CloudWatch metrics (namespace `AWS/Lambda/Web`), like `lambda.Function`'s:\n\n```ts\nfn.endpoint.metricServerErrorRate().createAlarm(this, 'ErrorRate', { threshold: 1, evaluationPeriods: 3 });\nfn.endpoint.metricRequestThrottles().createAlarm(this, 'Throttled', { threshold: 10, evaluationPeriods: 3 });\nfn.metricConcurrentRequests().createAlarm(this, 'Saturated', { threshold: 60, evaluationPeriods: 3 });\n```\n\n| Endpoint | Metric |\n|---|---|\n| `metricRequests()` | `ExecutedRequests` (there's no separate 2XX count) |\n| `metricClientErrors()`, `metricServerErrors()` | `HTTPResponseStatusClass4XX`, `HTTPResponseStatusClass5XX` |\n| `metricClientErrorRate()`, `metricServerErrorRate()` | 4XX or 5XX as a % of requests (math expression) |\n| `metricActiveEnvironments()` | `EndpointActiveEnvironments`, to compare with `maxEnvironments` |\n| `metricRequestThrottles()`, `metricEnvironmentThrottles()` | 429s from `rateLimit` and from `maxEnvironments` |\n\n| Function | Metric |\n|---|---|\n| `metricConcurrentRequests()` | `EnvironmentConcurrentRequests` (maximum), to compare with `maxConcurrencyPerEnvironment` |\n| `metricMaxMemoryUsage()` | `EnvironmentMaxMemoryUsage` (maximum) |\n| `metricActiveTime()`, `metricCpuTime()`, `metricResponseBytes()` | `EnvironmentActiveTime`, `EnvironmentCPUTime`, `ResponseBytes` |\n\n- **Metrics stay in the region that served the request**; unlike logs, they aren't copied to the home region. Every helper takes `region`. Dashboards can show any region, but an alarm can only use metrics from its own stack's region.\n- 4XX, 5XX and the throttle metrics only exist once they're non-zero: alarm on them with `treatMissingData: NOT_BREACHING`. The rate helpers count missing errors as 0.\n- There's no latency metric. Publish one from your application (e.g. with the CloudWatch embedded metric format).\n\n## Logs in every region\n\nWeb Functions log in two tiers:\n\n```text\n every serving region home region\n ┌──────────────────┐ ┌──────────────────────────────────────────┐\n │ <group>.local │── copied ───►│ <group> every region's logs │\n │ (that region's │ (seconds) │ streams …[rev]<instance>-<acct>-<region> │\n │ environments) │ │ <group>.local (home-region traffic) │\n └──────────────────┘ └──────────────────────────────────────────┘\n```\n\n**Query `fn.logGroup`**, the home-region group that receives every region's logs. The service would create missing groups without retention and never delete them, so the construct creates and owns all of them: both home-region groups, and `<group>.local` in every other region any of its endpoints serves from.\n\n```ts\nnew WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n logRetention: logs.RetentionDays.THREE_MONTHS, // default ONE_MONTH, every group in every region\n logRemovalPolicy: RemovalPolicy.DESTROY, // default RETAIN\n applicationLogLevelV2: lambda.ApplicationLogLevel.WARN,\n systemLogLevelV2: lambda.SystemLogLevel.INFO, // DEBUG, INFO or WARN\n});\n```\n\n- The default group is `/aws/lambda/web/<function name>`. Log lines are JSON; application lines carry `requestId`, `endpointName` and `region`.\n- Every event is stored twice (`.local` plus the home-region copy), so expect about double log ingestion, plus cross-region transfer.\n- With `DESTROY`, deletion waits about a minute after the function is gone, because environments flush their last lines late.\n- Subscribe only to `fn.logGroup`: subscribing to the `.local` groups as well delivers every event twice.\n\n## cdk-nag\n\nThe library acknowledges the [cdk-nag](https://github.com/cdklabs/cdk-nag) AwsSolutions findings on the resources it creates, each with a reason, so they don't show up in your reports:\n\n| Finding | Resource | Reason |\n|---|---|---|\n| IAM5 (wildcards) | the default execution role | log streams of the function's own log groups, in every region it serves from |\n| IAM5 | the deployment handlers' role (canary and linear deployments) | their own log group, `cloudwatch:DescribeAlarms` (composite alarms need `*`), and the revisions and endpoints of the functions they deploy |\n| IAM4, IAM5, SF1, SF2 | the CDK Provider framework behind deployments | CDK's own functions and waiter state machine |\n| S1 (access logs) | the stack's code bucket | it only holds copies of the stack's code assets |\n\n- **This works with both cdk-nag versions**, without depending on cdk-nag. cdk-nag 3 reads CDK's `Validations.of(...).acknowledge()`, one ID per finding. cdk-nag 2 reads `cdk_nag` metadata in the template.\n- **Your own statements and resources are still checked.** That includes statements you add to the function's role (`addToRolePolicy`, grants) and your CloudFront distribution's settings.\n- Only the AwsSolutions pack is covered; findings from the HIPAA, NIST and PCI packs aren't acknowledged.\n\n## Upgrading\n\n### From 0.1.5 to 0.1.7, with a resource policy\n\nVersions 0.1.5 to 0.1.7 wrote the function's resource policy with an `AWS::Lambda::ResourcePolicy`. Later versions don't (0.1.7 has the same code as 0.1.6). When an update removes that resource, CloudFormation deletes the function's **whole** resource policy at the end of the update, including the statements the new version just wrote. Callers that rely on the policy then get 403: other accounts, AWS services, and CloudFront.\n\nIf your function has a resource policy (from `addPermission`, a grant to another account or an AWS service, or `WebFunctionOrigin`), first deploy once on the version you have, with the old resource retained:\n\n```ts\n(fn.node.findChild('ResourcePolicy') as CfnResource).applyRemovalPolicy(RemovalPolicy.RETAIN);\n```\n\nThen upgrade, without changing your statements in the same deployment. The new version takes over the statements it writes itself. A statement you removed in the same deployment would stay in the policy.\n\n## Limitations\n\n- Not yet supported: VPC access (network connectors), KMS encryption, and tracing.\n- **Hotswap skips Web Functions without a warning.** `cdk deploy --hotswap` and `cdk watch`, which hotswaps by default, report `(no changes)` for a code or configuration change and the endpoint keeps serving the old revision. Use `cdk watch --hotswap-fallback` (or `cdk deploy --hotswap-fallback`): it deploys Web Function changes through CloudFormation, in about 40 seconds for a home-region endpoint.\n- Fixed limits: 512 MB of code (unzipped) and 32 KB of environment variables per revision, 512 MB of `/tmp` per execution environment, and 128 KiB of headers per request.\n- Quotas: 10 endpoints and about 50 revisions per function (Lambda cleans up older revisions automatically), and 10,000 requests per second per endpoint. Per account and region: 100,000 requests per second and 2,000 Arm64 vCPUs (each execution environment uses 2). The account quotas are adjustable, and new accounts start lower. See [Lambda quotas](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html).\n\n## Development\n\nTooling is pinned in `mise.toml` (Node 24, AWS CDK CLI). Personal settings, such as the AWS profile for the live end-to-end tests, go in a git-ignored `mise.local.toml`.\n\n```bash\nmise install\nnpx projen build # compile, unit tests, lint, API docs\nnpx projen e2e # deploy, verify and destroy real stacks in three regions (needs AWS credentials)\n```\n"
9748
+ "markdown": "# CDK constructs for AWS Lambda Web Functions\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n[AWS Lambda Web Functions](https://docs.aws.amazon.com/lambda/latest/dg/web-functions.html) run an ordinary Node.js HTTP server (Express, Fastify, Hono, `node:http`) on Lambda and give it an HTTPS endpoint, optionally served from several regions. `WebFunction` deploys one, following the conventions of `aws-cdk-lib/aws-lambda` where the two services overlap.\n\n```ts fixture=bare\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\nimport { WebFunction, WebFunctionAuthType, WebFunctionEndpointType } from '@ashishpandeyone/cdk-lambda-web-function';\n\nconst fn = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n endpointType: WebFunctionEndpointType.MULTI_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n },\n});\n\nnew CfnOutput(this, 'Url', { value: fn.endpoint.url }); // https://<id>.lambda-web.global.on.aws\n```\n\nThe stack's region is the function's **home region**. Multi-region endpoints need a stack with an explicit `env.region`.\n\n## Installation\n\n```bash\nnpm install @ashishpandeyone/cdk-lambda-web-function\n```\n\nIt needs `aws-cdk-lib` 2.273.0 or later and `constructs` 10.5.1 or later (peer dependencies), and Node.js 22 or later. The package is published for TypeScript and JavaScript only.\n\n## Writing the server\n\n1. Listen on the host and port in **`AWS_LAMBDA_HTTP_ENDPOINT`** (`0.0.0.0:3000` today). `PORT` is not set.\n2. Start listening within **10 seconds**, or initialisation fails with `Application.TimeoutListenError`.\n3. Put the entry file at the root of your bundle as **`index.js`**, or set `entrypoint`.\n4. The runtime has **no AWS SDK**: bundle the clients you import.\n5. Code runs on **arm64**.\n\n```js\nconst express = require('express');\n\nconst app = express();\napp.get('/', (req, res) => res.json({ hello: 'world', region: process.env.AWS_REGION }));\n\nconst [host, port] = process.env.AWS_LAMBDA_HTTP_ENDPOINT.split(':');\napp.listen(Number(port), host);\n```\n\nRequests carry `lambda-web-request-id` and `lambda-web-endpoint-name` headers.\n\n## Regions and endpoints\n\nEach `WebFunction` has a default endpoint, `fn.endpoint`, configured with the `endpoint` property. [Add more](#more-endpoints) with `fn.addEndpoint()`.\n\n| `endpointType` | URL | Routing |\n|---|---|---|\n| `HOME_REGION` (default) | `https://<id>.<cell>.lambda-web.<home>.on.aws` | home region only |\n| `MULTI_REGION` | one global `https://<id>.lambda-web.global.on.aws` | nearest region |\n| `PER_REGION` | one URL per region, from `fn.endpoint.regionalUrl(region)` | the region in the hostname |\n\n```ts\nconst perRegion = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n endpointType: WebFunctionEndpointType.PER_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n },\n});\n\nnew CfnOutput(this, 'UsEast1Url', { value: perRegion.endpoint.regionalUrl('us-east-1') });\n// perRegion.endpoint.regions is ['<home region>', 'eu-west-1', 'us-east-1']\n```\n\n- `MULTI_REGION` and `PER_REGION` need at least one region besides the home region; `HOME_REGION` takes none.\n- A MultiRegion endpoint takes about a minute to create.\n- Lambda routes a `MULTI_REGION` endpoint by latency, not by health: it doesn't fail over when a region has problems.\n\n### More endpoints\n\nA function can have up to 10 endpoints, each with its own URL, authentication, regions and limits. For example, a public endpoint next to an IAM-only global one:\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.NONE, // the default endpoint is public\n endpoint: { rateLimit: 1000 }, // requests per second\n});\n\nconst internal = api.addEndpoint('Internal', {\n authType: WebFunctionAuthType.AWS_IAM,\n endpointType: WebFunctionEndpointType.MULTI_REGION,\n regions: ['us-east-1', 'eu-west-1'],\n description: 'Service-to-service traffic',\n maxEnvironments: 50,\n});\ninternal.grantInvoke(consumerRole);\nnew CfnOutput(this, 'InternalUrl', { value: internal.url });\n```\n\n- `rateLimit` takes 0 (blocks all traffic), 100–1,000 in steps of 100, or 2,000–10,000 in steps of 1,000; excess requests get HTTP 429. `maxEnvironments` takes 2–10,000.\n- **Both limits apply separately in each region** an endpoint serves from: a 3-region endpoint with `rateLimit: 1000` accepts up to 1,000 requests per second in each region.\n- Endpoints can serve the same regions. The construct owns one `.local` log group per region, whichever endpoints serve it.\n\n### Changing regions or the endpoint type\n\nAn endpoint's type and regions can't change in place: a change creates a **new endpoint with a new URL**, and the old one is deleted once the new one is live. Two endpoints of one function can't share a name, so:\n\n| `endpointName` | Physical name | Changing `regions` or `endpointType` |\n|---|---|---|\n| omitted (recommended) | `default-<hash>` for `fn.endpoint`, `<id>-<hash>` for added endpoints; the hash covers the type and regions | works: new endpoint, new URL |\n| set, e.g. `'live'` | `live` | also change the name in the same deployment, or it fails with *The endpoint live already exists* (the stack rolls back and the old endpoint keeps serving) |\n\nThe construct warns at synth time when `endpointName` is set.\n\n## Authentication and invoking\n\n| `authType` | Meaning |\n|---|---|\n| `AWS_IAM` | Callers sign requests (SigV4 or SigV4a, signing name `lambda`) and need `lambda:InvokeWebFunctionEndpoint` |\n| `NONE` | **Public**: Lambda does no authentication; your application does (JWT, sessions). The `Authorization` header reaches your application untouched. The construct warns at synth time |\n\n```ts\nfn.grants.invoke(consumerRole); // or fn.grantInvoke(consumerRole), as on lambda.Function\n```\n\nThe grant is on the endpoint's home-region ARN, which IAM evaluates in every region the endpoint serves from, including the global URL. `fn.grants` covers the default endpoint only; grant other endpoints with their own `grantInvoke()` or `grants.invoke()`.\n\n| Endpoint | How to sign |\n|---|---|\n| `HOME_REGION` | SigV4 for the home region |\n| `PER_REGION` | SigV4 for the hostname's region, or SigV4a |\n| `MULTI_REGION` | **SigV4a with region set `*`**: you can't know which region will serve the request |\n\n```js\nimport { SignatureV4a } from '@smithy/signature-v4a';\nimport { Sha256 } from '@aws-crypto/sha256-js';\nimport { fromNodeProviderChain } from '@aws-sdk/credential-providers';\n\nconst host = new URL(url).hostname; // url: the endpoint's URL\nconst signer = new SignatureV4a({ service: 'lambda', region: '*', sha256: Sha256, credentials: fromNodeProviderChain() });\nconst signed = await signer.sign(\n { method: 'GET', protocol: 'https:', hostname: host, path: '/', headers: { host } },\n { signingRegion: '*' },\n);\nconst response = await fetch(`https://${host}/`, { headers: signed.headers });\n```\n\n### Other accounts and AWS services\n\nA caller in another account needs permission twice: in its own IAM policy, and in the function's **resource policy**. `grantInvoke` handles the function's side: a role in the function's account only gets an IAM policy statement, while a principal in another account or an AWS service also gets a statement in the resource policy.\n\n```ts\nfn.grantInvoke(iam.Role.fromRoleArn(this, 'Partner', 'arn:aws:iam::444455556666:role/caller'));\n```\n\nFor principals you can't grant to (a whole account, an organization, an AWS service with conditions), use `addPermission`. The `id` becomes the statement's `Sid`:\n\n```ts\nfn.addPermission('PartnerAccount', { principal: new iam.AccountPrincipal('444455556666') });\nfn.addPermission('MyOrg', { principal: new iam.OrganizationPrincipal('o-a1b2c3d4e5'), endpoint: fn.endpoint });\nfn.addPermission('Cdn', {\n principal: new iam.ServicePrincipal('cloudfront.amazonaws.com'),\n sourceArn: `arn:aws:cloudfront::${this.account}:distribution/EDFDVBD6EXAMPLE`,\n});\n```\n\n`addPermission` allows calling every endpoint unless you pass `endpoint`. For other actions, such as letting another account create revisions, use `fn.addToResourcePolicy(statement)`. Statements use the endpoint ARN for invoking and the function ARN for actions on the function.\n\n- **Each stack writes only its own statements.** A Web Function has a single resource policy, and Web Functions have no `AddPermission`. So each stack that adds statements gets a custom resource (`Custom::LambdaWebResourcePolicyStatements`). It reads the policy, replaces the statements that stack wrote before, and writes the policy back, retrying if another writer changed it in the meantime. Statements from other stacks, and ones added outside CloudFormation, are kept. Writers include the function's stack, a stack with a CloudFront distribution, and a stack that imports the function in the same account.\n- **Sids are unique in the policy.** `addPermission`'s `id` becomes the statement's `Sid`, and other statements get a generated one (`Cdk<hash><n>`). If another stack or tool already uses that `Sid` for different content, the deployment fails with the `Sid`.\n- **Don't also attach an `AWS::Lambda::ResourcePolicy` yourself.** That resource replaces the whole document on every update, dropping every other writer's statements.\n- **Public policies are rejected.** Lambda refuses a policy that lets anyone call the function, and the construct fails synthesis first. A `*` principal is only accepted with a condition that pins the caller, such as `aws:PrincipalOrgID` (`iam.OrganizationPrincipal`) or `aws:SourceAccount`. For a public endpoint, use `authType: NONE`.\n- **Scope AWS services to your resource.** Lambda accepts a service principal with no condition, which would let that service call the endpoint on behalf of any account. The construct warns unless you give `sourceArn` or `sourceAccount` (or an `aws:SourceArn`, `aws:SourceAccount`, `aws:SourceOrgID` or `aws:SourceOrgPaths` condition).\n- Lambda copies the policy to every region the function's endpoints serve from. The copy is eventually consistent, and in tests changes applied in every region within seconds.\n\n### CloudFront\n\nPut a CloudFront distribution (`aws-cdk-lib/aws-cloudfront`) in front of an `AWS_IAM` endpoint to serve the public with a custom domain, caching and AWS WAF. Viewers don't sign anything, and only your distribution may call the endpoint:\n\n```ts\nnew cloudfront.Distribution(this, 'Cdn', {\n defaultBehavior: {\n origin: WebFunctionOrigin.withOriginAccessControl(fn.endpoint),\n viewerProtocolPolicy: cloudfront.ViewerProtocolPolicy.REDIRECT_TO_HTTPS,\n allowedMethods: cloudfront.AllowedMethods.ALLOW_ALL,\n cachePolicy: cloudfront.CachePolicy.CACHING_DISABLED,\n originRequestPolicy: cloudfront.OriginRequestPolicy.ALL_VIEWER_EXCEPT_HOST_HEADER,\n },\n});\n```\n\n`withOriginAccessControl` adds:\n- an origin access control (origin type `lambda`, signing behavior `always-amz-auth`, the only one CloudFront accepts for Web Function origins), one per stack and signing protocol: SigV4 for a regional domain, SigV4a for a `MULTI_REGION` endpoint's global domain;\n- a statement in the function's resource policy that allows `cloudfront.amazonaws.com` to call this endpoint on behalf of this distribution only (`aws:SourceArn`).\n\nSome things to know:\n- **Forward everything except `Host`.** The endpoint answers 404 when `Host` is the distribution's domain, so use `ALL_VIEWER_EXCEPT_HOST_HEADER` (not `ALL_VIEWER`), or a policy of your own without `Host`.\n- **Your application can still authenticate viewers.** CloudFront signs in its own headers and passes the viewer's `Authorization` header (a JWT, for example) through unchanged, but only when `Authorization` is in the cache policy. CloudFront drops it from `GET` and `HEAD` requests otherwise:\n\n ```ts\n const forwardAuthorization = new cloudfront.CachePolicy(this, 'ForwardAuthorization', {\n headerBehavior: cloudfront.CacheHeaderBehavior.allowList('Authorization'),\n minTtl: Duration.seconds(0),\n defaultTtl: Duration.seconds(0),\n maxTtl: Duration.seconds(1), // a cache key with headers needs caching enabled; 0/0/1 keeps it off in practice\n });\n ```\n- Request bodies work without clients sending `x-amz-content-sha256`: CloudFront signs `POST`, `PUT` and `PATCH` requests with an unsigned payload.\n- A `PER_REGION` endpoint's origin calls one region: the home region, or the one you pass as `region`. Use one origin per region, for example in an origin group.\n- A `MULTI_REGION` endpoint can't include opt-in regions (such as `me-central-1`), because CloudFront can't sign for them. The construct fails synthesis.\n- The distribution can be in another stack, in the function's account. Its stack writes the CloudFront statement into the function's resource policy, so the function's stack doesn't depend on it.\n- That stack can also be in another region, for example us-east-1 for an ACM certificate. CDK then passes the endpoint's domain and ARN with its cross-region references: SSM parameters plus custom resources of its own.\n- **Those references are strong by default.** A change that replaces the endpoint gives it a new domain and ARN. That includes a new endpoint type or region set, or a renamed function. The function's stack can't update a value while the distribution's stack still uses the old one, the same as with `Fn::ImportValue` in one region. Deploy such a change in two steps, or use weak references: CDK's synth warning `@aws-cdk/core:crossStackReferencesDefaultStrong` explains how.\n- Lambda@Edge origin-request and origin-response triggers aren't supported on behaviors with this origin.\n- The endpoint stays reachable at its own domain for signed requests your policies allow. Until a new distribution finishes deploying, requests through it can get a transient 403.\n- `new WebFunctionOrigin(endpoint)` is for a public (`NONE`) endpoint, for example behind AWS WAF. Lambda doesn't authenticate those requests, so the endpoint's own domain stays public too.\n\n### Functions defined elsewhere\n\nImport a Web Function defined in another stack or app to grant access to it, read its metrics, or reference its revisions:\n\n```ts\nconst orders = WebFunction.fromWebFunctionArn(this, 'Orders', 'arn:aws:lambda:us-east-1:111122223333:web-function/orders');\norders.grantInvoke(consumerRole); // every endpoint of the function\n\nconst live = WebFunction.fromWebFunctionAttributes(this, 'Live', {\n webFunctionName: 'orders', // in this stack's account and region\n endpointName: 'live', // grantInvoke allows this endpoint only\n});\nlive.metricConcurrentRequests().createAlarm(this, 'Busy', { threshold: 60, evaluationPeriods: 3 });\n```\n\nAn imported function's metrics default to its own region. Its endpoints, revisions and log groups stay with the stack that defines it.\n\nAn imported function works like a `WebFunction` here. `grantInvoke` and `addToResourcePolicy` write the importing stack's statements into the function's resource policy, in the function's region. This works only when the function is in the stack's account. For a function in another account, `grantInvoke` adds to the caller's IAM policy only, and `addToResourcePolicy` adds nothing and warns, so ask that account to allow the caller.\n\n## Configuration\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('build'),\n authType: WebFunctionAuthType.AWS_IAM,\n entrypoint: 'server.js', // default index.js\n webFunctionName: 'orders-api', // default: generated from the construct path\n description: 'Orders HTTP API',\n environment: { TABLE_NAME: table.tableName },\n timeout: Duration.seconds(60), // per request: 3 seconds to 15 minutes, default 30 seconds\n maxConcurrencyPerEnvironment: 32, // requests per environment at once: 1-128, default 64\n});\n\napi.addEnvironment('FEATURE_FLAG', 'on');\ntable.grantReadWriteData(api); // the default role trusts lambda.amazonaws.com\n```\n\n- **Each execution environment has 2 vCPUs and 2 GB of memory.** There's no memory setting as on Lambda functions; scale with `maxConcurrencyPerEnvironment` and more environments instead.\n- Requests handled by one environment share module-level state, so keep handlers concurrency-safe.\n- Environment variable names starting with `AWS_` are reserved.\n- **The default execution role can only write to the function's own log groups**: the home region's, and the `.local` copy in every region it serves from. That's the minimum AWS documents for Web Functions. It doesn't use `AWSLambdaBasicExecutionRole`, which can also create any log group. Pass `role` to use your own, and include those log permissions.\n- **Renaming the function replaces it and changes its URL.** A generated name depends on the construct path, so moving the construct renames it too.\n\n### Encryption\n\nLambda encrypts each revision's code and environment variables with an AWS owned key. To use your own key, pass `encryptionKey`:\n\n```ts\ndeclare const keyStack: Stack; // deploys first\ndeclare const replicaStack: Stack; // in us-east-1, deploys before this stack\n\nconst key = new kms.Key(keyStack, 'Key', { multiRegion: true });\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('build'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: { endpointType: WebFunctionEndpointType.PER_REGION, regions: ['us-east-1'] },\n encryptionKey: key,\n});\n\n// One replica per region the endpoint serves from, with Lambda's statement in its own policy.\nnew kms.CfnReplicaKey(replicaStack, 'KeyReplica', {\n primaryKeyArn: key.keyArn,\n keyPolicy: new iam.PolicyDocument({\n statements: [\n new iam.PolicyStatement({ principals: [new iam.AccountRootPrincipal()], actions: ['kms:*'], resources: ['*'] }),\n api.encryptionKeyPolicyStatement(),\n ],\n }),\n});\n```\n\n- **A key defined in your app gets Lambda's statement automatically.** It allows `kms:Decrypt` for `lambda.amazonaws.com`, limited to this function's revisions through `aws:SourceArn` and the encryption context Lambda sets. For an imported key, add `encryptionKeyPolicyStatement()` to its policy yourself.\n- **`PER_REGION` and `MULTI_REGION` endpoints need a multi-Region key**, with a replica in every region they serve from. The replicas must exist before the endpoint, so put the key and its replicas in stacks that deploy before the function's. Replica policies aren't copied from the primary, so each one needs `encryptionKeyPolicyStatement()`. With a single-Region key, the endpoint fails to activate in its other regions and the whole deployment rolls back. The construct fails synthesis instead, when it can tell: a key in your app without `multiRegion`, or an imported key whose ID doesn't start with `mrk-`.\n- **CloudFormation's role creates the revisions**, so it needs `kms:DescribeKey`, `kms:GenerateDataKey` and `kms:Decrypt` on the key. A key's default policy delegates to IAM, and CDK's default deployment role is allowed.\n- **Changing the key creates a new revision.** Earlier revisions keep their key, including the ones kept as rollback targets (`revisionRetention`). Keep the old key enabled while any of them might serve traffic again.\n- **Disabling the key, or removing Lambda's access, stops new execution environments from starting.** Running ones keep their decrypted copy for a while, so this doesn't contain traffic immediately.\n\n### Defaults for every function (property injection)\n\nTo give every function under a scope the same defaults, register a property injector for `WebFunction.PROPERTY_INJECTION_ID`, as you would for aws-cdk-lib's constructs. For example, a team's log retention:\n\n```ts\nclass TeamDefaults implements IPropertyInjector {\n public readonly constructUniqueId = WebFunction.PROPERTY_INJECTION_ID;\n public inject(originalProps: WebFunctionProps): WebFunctionProps {\n // The team's defaults, with explicit props winning.\n return Object.assign({ logRetention: logs.RetentionDays.ONE_MONTH }, originalProps);\n }\n}\nPropertyInjectors.of(this).add(new TeamDefaults()); // or on the app, for every stack\n```\n\n- An injector applies to functions created under the scope it's added to. The nearest one wins.\n- `NodejsWebFunction` has its own ID (`NodejsWebFunction.PROPERTY_INJECTION_ID`). Its injector runs first, then `WebFunction`'s, as with aws-cdk-lib's `NodejsFunction` and `Function`.\n\n### Bundling TypeScript with `NodejsWebFunction`\n\n`NodejsWebFunction` is a `WebFunction` that bundles your server from a TypeScript or JavaScript entry file with esbuild, like `NodejsFunction` does for Lambda functions:\n\n```ts\nnew NodejsWebFunction(this, 'Api', {\n entry: 'src/server.ts',\n authType: WebFunctionAuthType.AWS_IAM,\n bundling: {\n minify: true, // default true\n sourceMap: true, // default true\n format: lambdaNodejs.OutputFormat.ESM, // default ESM (index.mjs); CJS gives index.js\n externalModules: [], // default: bundle everything you import\n },\n});\n```\n\n- **Defaults:** `runtime` is `NODEJS_24_X`, and the esbuild target follows the runtime (`node24`). The project root is the directory of the nearest lock file above `entry` (override it with `depsLockFilePath` or `projectRoot`).\n- **It also sets what a `lambda.Code` can't:** the entry point that matches the bundle, and `NODE_OPTIONS=--enable-source-maps` when source maps are on, appended to any `NODE_OPTIONS` you set, so stack traces point at your `.ts` files (e.g. `/var/task/src/server.ts:22:12`). Source map paths are relative to the project root, so no build-machine paths are deployed.\n- **ESM bundles include a `require` shim**, so CommonJS dependencies that load Node.js built-ins (Express, for example) work.\n- **The AWS SDK is bundled like any other dependency**, since the runtime has none. Only the clients you import are included.\n- **Bundling runs locally** when esbuild is installed in your project, and otherwise in Docker (an arm64 AWS SAM build image; set `forceDockerBundling` to always use Docker).\n- **Not yet supported:** installing native modules next to the bundle (`nodeModules`) and command hooks. For native dependencies, use `WebFunction` with `Code.fromAsset(..., { bundling: { image, command } })`.\n\n### Code\n\n`code` takes any `lambda.Code` that produces a zip in S3: `fromAsset`, `fromBucket`/`fromBucketV2`, `fromCustomCommand`, `fromDockerBuild`. Inline code and container images fail at synth time.\n\nLambda Web Functions download code as the `lambda.amazonaws.com` service principal, from a **versioned** bucket, and the CDK bootstrap bucket allows neither. So each stack gets a small code bucket, and the code is copied into it on deploy. The bucket is emptied and deleted with the stack.\n\nCopying code, managing the function's log groups in every region, looking up regional URLs, cleaning up old revisions, creating rollback alarms in other regions and emptying the code bucket all run in one custom resource Lambda per stack. Its logs go to a log group the stack owns, kept for a month and deleted with the stack.\n\n## Revisions\n\nAny change to code or configuration creates a new **revision** (`fn.currentRevision`), and endpoints switch to it once it's ready. A failed deployment rolls back to the previous revision. If nothing changed, nothing is deployed.\n\nEarlier revisions are kept, so you can roll back or route traffic to them. After each deployment, the construct deletes the oldest beyond `revisionRetention` (default 20, up to 50). It never deletes a revision an endpoint routes to, or one the previous deployment used, which a rollback returns to.\n\n```ts\nnew WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n revisionRetention: 5,\n});\n```\n\n### Routing to earlier revisions\n\nReference an earlier revision by its ID (for example from a `CfnOutput` of `fn.currentRevision.revisionId`, or `aws lambda-web list-web-function-revisions`). Then pin an endpoint to it, or split traffic between two revisions:\n\n```ts\nconst previous = WebFunctionRevision.fromRevisionAttributes(this, 'Previous', {\n webFunction: fn,\n revisionId: 'rev-a1b2c',\n});\n\n// Keep the default endpoint on the previous revision, and send 10% to the new one:\nfn.endpoint.routeTraffic(previous, [{ revision: fn.currentRevision, weight: 0.1 }]);\n\n// Or a second endpoint that stays on the previous revision while fn.endpoint moves on:\nfn.addEndpoint('Stable', { authType: WebFunctionAuthType.AWS_IAM, revision: previous });\n```\n\n- An endpoint routes to at most two revisions. The additional revision's `weight` is a whole percentage, from 0.01 to 0.99.\n- To promote, remove `routeTraffic` (or `revision`) and deploy: the endpoint serves the current revision again.\n- Lambda Web Function metrics have no revision dimension. To compare a split's revisions, log a version you control (for example an environment variable) from your application.\n\n### Canary and linear deployments\n\nBy default an endpoint moves all its traffic to a new revision at once. With `deployment`, it moves in steps instead, watching CloudWatch alarms: if one goes into ALARM, the endpoint goes back to the revision it served before and the deployment fails, so CloudFormation rolls the stack back.\n\n```ts\nconst api = new WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n endpoint: {\n // 10% of the traffic for 10 minutes, then all of it; back if more than 2% of requests get a 5XX.\n deployment: WebFunctionDeployment.canary({ percent: 10, bake: Duration.minutes(10), rollbackOn: { serverErrorRate: 2 } }),\n },\n});\n\n// 25% more every 5 minutes, watching an alarm of your own. Each endpoint has its own deployment.\n// errorRate: any cloudwatch.IAlarm, e.g. on a metric your application publishes.\napi.addEndpoint('Public', {\n authType: WebFunctionAuthType.NONE,\n deployment: WebFunctionDeployment.linear({ percent: 25, interval: Duration.minutes(5), alarms: [errorRate] }),\n});\n```\n\n| | Steps | Limits |\n|---|---|---|\n| `allAtOnce()` (default) | 100% | |\n| `canary({ percent, bake })` | `percent`, then 100% after `bake` | `percent` 1–99, `bake` 1–45 minutes |\n| `linear({ percent, interval })` | `percent` more every `interval` | `percent` 5–50, `interval` from 1 minute, at most 45 minutes in all |\n\nHow it works:\n\n- Each deployment that creates a revision (code or configuration) moves the traffic from the revision the endpoint serves at that moment, which is also what it goes back to. If someone switched the endpoint outside CloudFormation, the deployment starts from there.\n- Each step waits until every region of a `MULTI_REGION` or `PER_REGION` endpoint has applied it (usually about 15 seconds), and if a region fails to update, the endpoint goes back as for an alarm. The bake or interval counts from the start of the step.\n- Alarms are checked before the first step (an alarm already in ALARM stops the deployment before any traffic moves), throughout every step, and once the new revision has all the traffic. They can be in any region, and composite alarms work. `INSUFFICIENT_DATA` doesn't stop a deployment.\n- A rollback of the stack, for any reason, moves the traffic back at once, without waiting or checking alarms.\n- A stack's first deployment, and a new endpoint (including one renamed by a region change), serve the revision at once: there's nothing to move from.\n- A deployment can take up to an hour: CloudFormation waits for it before it updates the endpoint. Deployments of different endpoints run in parallel.\n- A canary or linear endpoint always moves to the current revision, so it can't also use `revision`, `additionalRevisions` or `routeTraffic()`. Use `allAtOnce()` to deploy a fix immediately, for example while an alarm is in ALARM.\n\n#### Rollback alarms\n\n`rollbackOn` makes the endpoint create alarms on its own error rates, and the deployment watches them alongside any `alarms` you pass:\n\n| `rollbackOn` | Default | |\n|---|---|---|\n| `serverErrorRate` | none | roll back when more than this % of requests get a 5XX |\n| `clientErrorRate` | none | the same for 4XX (including 429s from `rateLimit` and `maxEnvironments`) |\n| `minimumRequests` | 10 | periods with fewer requests don't count, so one failed request out of two doesn't roll back |\n| `period`, `evaluationPeriods` | 1 minute, 2 | consecutive periods over the threshold before rolling back |\n\n- **One alarm per threshold in every region the endpoint serves from.** Metrics are published in the region that served the request, and an alarm can only watch metrics in its own region. The home region's alarm is a normal CloudFormation alarm; the others are created and deleted with the endpoint by a custom resource, and named `LambdaWeb-<function>-<endpoint>-5xx-rate` (or `-4xx-rate`). `endpoint.rollbackAlarms` lists them all, e.g. to add notifications to the home region's.\n- **The alarms see the whole endpoint.** Lambda Web Function metrics have no revision dimension, so at 10% a new revision's errors are about a tenth of the endpoint's: set the threshold low enough to notice that, or alarm on metrics your application publishes with its version.\n- **5XX includes the platform's 503s** while the endpoint scales up for a sudden burst, not only your application's errors.\n- **A step should outlast the alarm.** CloudWatch needs `period` × `evaluationPeriods`, plus a couple of minutes of delay, to fire; the construct warns when a canary's bake or a linear interval is shorter.\n\nThe deployment runs in a few resources per stack, created on first use: two Lambda functions, a Step Functions state machine that calls them every 15 seconds, and a log group.\n\n## Metrics\n\nEndpoints and functions have helpers for their CloudWatch metrics (namespace `AWS/Lambda/Web`), like `lambda.Function`'s:\n\n```ts\nfn.endpoint.metricServerErrorRate().createAlarm(this, 'ErrorRate', { threshold: 1, evaluationPeriods: 3 });\nfn.endpoint.metricRequestThrottles().createAlarm(this, 'Throttled', { threshold: 10, evaluationPeriods: 3 });\nfn.metricConcurrentRequests().createAlarm(this, 'Saturated', { threshold: 60, evaluationPeriods: 3 });\n```\n\n| Endpoint | Metric |\n|---|---|\n| `metricRequests()` | `ExecutedRequests` (there's no separate 2XX count) |\n| `metricClientErrors()`, `metricServerErrors()` | `HTTPResponseStatusClass4XX`, `HTTPResponseStatusClass5XX` |\n| `metricClientErrorRate()`, `metricServerErrorRate()` | 4XX or 5XX as a % of requests (math expression) |\n| `metricActiveEnvironments()` | `EndpointActiveEnvironments`, to compare with `maxEnvironments` |\n| `metricRequestThrottles()`, `metricEnvironmentThrottles()` | 429s from `rateLimit` and from `maxEnvironments` |\n\n| Function | Metric |\n|---|---|\n| `metricConcurrentRequests()` | `EnvironmentConcurrentRequests` (maximum), to compare with `maxConcurrencyPerEnvironment` |\n| `metricMaxMemoryUsage()` | `EnvironmentMaxMemoryUsage` (maximum) |\n| `metricActiveTime()`, `metricCpuTime()`, `metricResponseBytes()` | `EnvironmentActiveTime`, `EnvironmentCPUTime`, `ResponseBytes` |\n\n- **Metrics stay in the region that served the request**; unlike logs, they aren't copied to the home region. Every helper takes `region`. Dashboards can show any region, but an alarm can only use metrics from its own stack's region.\n- 4XX, 5XX and the throttle metrics only exist once they're non-zero: alarm on them with `treatMissingData: NOT_BREACHING`. The rate helpers count missing errors as 0.\n- There's no latency metric. Publish one from your application (e.g. with the CloudWatch embedded metric format).\n\n## Logs in every region\n\nWeb Functions log in two tiers:\n\n```text\n every serving region home region\n ┌──────────────────┐ ┌──────────────────────────────────────────┐\n │ <group>.local │── copied ───►│ <group> every region's logs │\n │ (that region's │ (seconds) │ streams …[rev]<instance>-<acct>-<region> │\n │ environments) │ │ <group>.local (home-region traffic) │\n └──────────────────┘ └──────────────────────────────────────────┘\n```\n\n**Query `fn.logGroup`**, the home-region group that receives every region's logs. The service would create missing groups without retention and never delete them, so the construct creates and owns all of them: both home-region groups, and `<group>.local` in every other region any of its endpoints serves from.\n\n```ts\nnew WebFunction(this, 'Api', {\n runtime: lambda.Runtime.NODEJS_24_X,\n code: lambda.Code.fromAsset('dist'),\n authType: WebFunctionAuthType.AWS_IAM,\n logRetention: logs.RetentionDays.THREE_MONTHS, // default ONE_MONTH, every group in every region\n logRemovalPolicy: RemovalPolicy.DESTROY, // default RETAIN\n applicationLogLevelV2: lambda.ApplicationLogLevel.WARN,\n systemLogLevelV2: lambda.SystemLogLevel.INFO, // DEBUG, INFO or WARN\n});\n```\n\n- The default group is `/aws/lambda/web/<function name>`. Log lines are JSON; application lines carry `requestId`, `endpointName` and `region`.\n- Every event is stored twice (`.local` plus the home-region copy), so expect about double log ingestion, plus cross-region transfer.\n- With `DESTROY`, deletion waits about a minute after the function is gone, because environments flush their last lines late.\n- Subscribe only to `fn.logGroup`: subscribing to the `.local` groups as well delivers every event twice.\n\n## cdk-nag\n\nThe library acknowledges the [cdk-nag](https://github.com/cdklabs/cdk-nag) AwsSolutions findings on the resources it creates, each with a reason, so they don't show up in your reports:\n\n| Finding | Resource | Reason |\n|---|---|---|\n| IAM5 (wildcards) | the default execution role | log streams of the function's own log groups, in every region it serves from |\n| IAM5 | the deployment handlers' role (canary and linear deployments) | their own log group, `cloudwatch:DescribeAlarms` (composite alarms need `*`), and the revisions and endpoints of the functions they deploy |\n| IAM4, IAM5, SF1, SF2 | the CDK Provider framework behind deployments | CDK's own functions and waiter state machine |\n| S1 (access logs) | the stack's code bucket | it only holds copies of the stack's code assets |\n\n- **This works with both cdk-nag versions**, without depending on cdk-nag. cdk-nag 3 reads CDK's `Validations.of(...).acknowledge()`, one ID per finding. cdk-nag 2 reads `cdk_nag` metadata in the template.\n- **Your own statements and resources are still checked.** That includes statements you add to the function's role (`addToRolePolicy`, grants) and your CloudFront distribution's settings.\n- Only the AwsSolutions pack is covered; findings from the HIPAA, NIST and PCI packs aren't acknowledged.\n\n## Upgrading\n\n### From 0.1.5 to 0.1.7, with a resource policy\n\nVersions 0.1.5 to 0.1.7 wrote the function's resource policy with an `AWS::Lambda::ResourcePolicy`. Later versions don't (0.1.7 has the same code as 0.1.6). When an update removes that resource, CloudFormation deletes the function's **whole** resource policy at the end of the update, including the statements the new version just wrote. Callers that rely on the policy then get 403: other accounts, AWS services, and CloudFront.\n\nIf your function has a resource policy (from `addPermission`, a grant to another account or an AWS service, or `WebFunctionOrigin`), first deploy once on the version you have, with the old resource retained:\n\n```ts\n(fn.node.findChild('ResourcePolicy') as CfnResource).applyRemovalPolicy(RemovalPolicy.RETAIN);\n```\n\nThen upgrade, without changing your statements in the same deployment. The new version takes over the statements it writes itself. A statement you removed in the same deployment would stay in the policy.\n\n## Limitations\n\n- Not yet supported: VPC access (network connectors), KMS encryption, and tracing.\n- **Hotswap skips Web Functions without a warning.** `cdk deploy --hotswap` and `cdk watch`, which hotswaps by default, report `(no changes)` for a code or configuration change and the endpoint keeps serving the old revision. Use `cdk watch --hotswap-fallback` (or `cdk deploy --hotswap-fallback`): it deploys Web Function changes through CloudFormation, in about 40 seconds for a home-region endpoint.\n- Fixed limits: 512 MB of code (unzipped) and 32 KB of environment variables per revision, 512 MB of `/tmp` per execution environment, and 128 KiB of headers per request.\n- Quotas: 10 endpoints and about 50 revisions per function (Lambda cleans up older revisions automatically), and 10,000 requests per second per endpoint. Per account and region: 100,000 requests per second and 2,000 Arm64 vCPUs (each execution environment uses 2). The account quotas are adjustable, and new accounts start lower. See [Lambda quotas](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html).\n\n## Development\n\nTooling is pinned in `mise.toml` (Node 24, AWS CDK CLI). Personal settings, such as the AWS profile for the live end-to-end tests, go in a git-ignored `mise.local.toml`.\n\n```bash\nmise install\nnpx projen build # compile, unit tests, lint, API docs\nnpx projen e2e # deploy, verify and destroy real stacks in three regions (needs AWS credentials)\n```\n"
9749
9749
  },
9750
9750
  "repository": {
9751
9751
  "type": "git",
@@ -9853,7 +9853,7 @@
9853
9853
  "kind": "interface",
9854
9854
  "locationInModule": {
9855
9855
  "filename": "src/web-function.ts",
9856
- "line": 161
9856
+ "line": 178
9857
9857
  },
9858
9858
  "methods": [
9859
9859
  {
@@ -9865,7 +9865,7 @@
9865
9865
  },
9866
9866
  "locationInModule": {
9867
9867
  "filename": "src/web-function.ts",
9868
- "line": 184
9868
+ "line": 201
9869
9869
  },
9870
9870
  "name": "grantInvoke",
9871
9871
  "parameters": [
@@ -9890,7 +9890,7 @@
9890
9890
  },
9891
9891
  "locationInModule": {
9892
9892
  "filename": "src/web-function.ts",
9893
- "line": 189
9893
+ "line": 206
9894
9894
  },
9895
9895
  "name": "metric",
9896
9896
  "parameters": [
@@ -9922,7 +9922,7 @@
9922
9922
  },
9923
9923
  "locationInModule": {
9924
9924
  "filename": "src/web-function.ts",
9925
- "line": 192
9925
+ "line": 209
9926
9926
  },
9927
9927
  "name": "metricActiveTime",
9928
9928
  "parameters": [
@@ -9948,7 +9948,7 @@
9948
9948
  },
9949
9949
  "locationInModule": {
9950
9950
  "filename": "src/web-function.ts",
9951
- "line": 198
9951
+ "line": 215
9952
9952
  },
9953
9953
  "name": "metricConcurrentRequests",
9954
9954
  "parameters": [
@@ -9974,7 +9974,7 @@
9974
9974
  },
9975
9975
  "locationInModule": {
9976
9976
  "filename": "src/web-function.ts",
9977
- "line": 195
9977
+ "line": 212
9978
9978
  },
9979
9979
  "name": "metricCpuTime",
9980
9980
  "parameters": [
@@ -10000,7 +10000,7 @@
10000
10000
  },
10001
10001
  "locationInModule": {
10002
10002
  "filename": "src/web-function.ts",
10003
- "line": 201
10003
+ "line": 218
10004
10004
  },
10005
10005
  "name": "metricMaxMemoryUsage",
10006
10006
  "parameters": [
@@ -10026,7 +10026,7 @@
10026
10026
  },
10027
10027
  "locationInModule": {
10028
10028
  "filename": "src/web-function.ts",
10029
- "line": 204
10029
+ "line": 221
10030
10030
  },
10031
10031
  "name": "metricResponseBytes",
10032
10032
  "parameters": [
@@ -10059,7 +10059,7 @@
10059
10059
  "immutable": true,
10060
10060
  "locationInModule": {
10061
10061
  "filename": "src/web-function.ts",
10062
- "line": 174
10062
+ "line": 191
10063
10063
  },
10064
10064
  "name": "webFunctionArn",
10065
10065
  "type": {
@@ -10078,7 +10078,7 @@
10078
10078
  "immutable": true,
10079
10079
  "locationInModule": {
10080
10080
  "filename": "src/web-function.ts",
10081
- "line": 167
10081
+ "line": 184
10082
10082
  },
10083
10083
  "name": "webFunctionName",
10084
10084
  "type": {
@@ -10171,7 +10171,7 @@
10171
10171
  },
10172
10172
  "locationInModule": {
10173
10173
  "filename": "src/nodejs-web-function.ts",
10174
- "line": 167
10174
+ "line": 174
10175
10175
  },
10176
10176
  "parameters": [
10177
10177
  {
@@ -10197,9 +10197,29 @@
10197
10197
  "kind": "class",
10198
10198
  "locationInModule": {
10199
10199
  "filename": "src/nodejs-web-function.ts",
10200
- "line": 166
10200
+ "line": 167
10201
10201
  },
10202
10202
  "name": "NodejsWebFunction",
10203
+ "properties": [
10204
+ {
10205
+ "const": true,
10206
+ "docs": {
10207
+ "stability": "experimental",
10208
+ "summary": "Identifies this class to property injectors (`PropertyInjectors.of(scope).add(...)`). A `NodejsWebFunction` gets its own injector first, then `WebFunction`'s, as aws-cdk-lib's `NodejsFunction` does with `Function`'s."
10209
+ },
10210
+ "immutable": true,
10211
+ "locationInModule": {
10212
+ "filename": "src/nodejs-web-function.ts",
10213
+ "line": 172
10214
+ },
10215
+ "name": "PROPERTY_INJECTION_ID",
10216
+ "overrides": "@ashishpandeyone/cdk-lambda-web-function.WebFunction",
10217
+ "static": true,
10218
+ "type": {
10219
+ "primitive": "string"
10220
+ }
10221
+ }
10222
+ ],
10203
10223
  "symbolId": "src/nodejs-web-function:NodejsWebFunction"
10204
10224
  },
10205
10225
  "@ashishpandeyone/cdk-lambda-web-function.NodejsWebFunctionBundlingOptions": {
@@ -10213,7 +10233,7 @@
10213
10233
  "kind": "interface",
10214
10234
  "locationInModule": {
10215
10235
  "filename": "src/nodejs-web-function.ts",
10216
- "line": 12
10236
+ "line": 13
10217
10237
  },
10218
10238
  "name": "NodejsWebFunctionBundlingOptions",
10219
10239
  "properties": [
@@ -10227,7 +10247,7 @@
10227
10247
  "immutable": true,
10228
10248
  "locationInModule": {
10229
10249
  "filename": "src/nodejs-web-function.ts",
10230
- "line": 69
10250
+ "line": 70
10231
10251
  },
10232
10252
  "name": "banner",
10233
10253
  "optional": true,
@@ -10245,7 +10265,7 @@
10245
10265
  "immutable": true,
10246
10266
  "locationInModule": {
10247
10267
  "filename": "src/nodejs-web-function.ts",
10248
- "line": 55
10268
+ "line": 56
10249
10269
  },
10250
10270
  "name": "define",
10251
10271
  "optional": true,
@@ -10268,7 +10288,7 @@
10268
10288
  "immutable": true,
10269
10289
  "locationInModule": {
10270
10290
  "filename": "src/nodejs-web-function.ts",
10271
- "line": 118
10291
+ "line": 119
10272
10292
  },
10273
10293
  "name": "dockerImage",
10274
10294
  "optional": true,
@@ -10286,7 +10306,7 @@
10286
10306
  "immutable": true,
10287
10307
  "locationInModule": {
10288
10308
  "filename": "src/nodejs-web-function.ts",
10289
- "line": 104
10309
+ "line": 105
10290
10310
  },
10291
10311
  "name": "environment",
10292
10312
  "optional": true,
@@ -10309,7 +10329,7 @@
10309
10329
  "immutable": true,
10310
10330
  "locationInModule": {
10311
10331
  "filename": "src/nodejs-web-function.ts",
10312
- "line": 97
10332
+ "line": 98
10313
10333
  },
10314
10334
  "name": "esbuildArgs",
10315
10335
  "optional": true,
@@ -10342,7 +10362,7 @@
10342
10362
  "immutable": true,
10343
10363
  "locationInModule": {
10344
10364
  "filename": "src/nodejs-web-function.ts",
10345
- "line": 48
10365
+ "line": 49
10346
10366
  },
10347
10367
  "name": "externalModules",
10348
10368
  "optional": true,
@@ -10365,7 +10385,7 @@
10365
10385
  "immutable": true,
10366
10386
  "locationInModule": {
10367
10387
  "filename": "src/nodejs-web-function.ts",
10368
- "line": 76
10388
+ "line": 77
10369
10389
  },
10370
10390
  "name": "footer",
10371
10391
  "optional": true,
@@ -10383,7 +10403,7 @@
10383
10403
  "immutable": true,
10384
10404
  "locationInModule": {
10385
10405
  "filename": "src/nodejs-web-function.ts",
10386
- "line": 111
10406
+ "line": 112
10387
10407
  },
10388
10408
  "name": "forceDockerBundling",
10389
10409
  "optional": true,
@@ -10402,7 +10422,7 @@
10402
10422
  "immutable": true,
10403
10423
  "locationInModule": {
10404
10424
  "filename": "src/nodejs-web-function.ts",
10405
- "line": 33
10425
+ "line": 34
10406
10426
  },
10407
10427
  "name": "format",
10408
10428
  "optional": true,
@@ -10420,7 +10440,7 @@
10420
10440
  "immutable": true,
10421
10441
  "locationInModule": {
10422
10442
  "filename": "src/nodejs-web-function.ts",
10423
- "line": 90
10443
+ "line": 91
10424
10444
  },
10425
10445
  "name": "keepNames",
10426
10446
  "optional": true,
@@ -10438,7 +10458,7 @@
10438
10458
  "immutable": true,
10439
10459
  "locationInModule": {
10440
10460
  "filename": "src/nodejs-web-function.ts",
10441
- "line": 62
10461
+ "line": 63
10442
10462
  },
10443
10463
  "name": "loader",
10444
10464
  "optional": true,
@@ -10461,7 +10481,7 @@
10461
10481
  "immutable": true,
10462
10482
  "locationInModule": {
10463
10483
  "filename": "src/nodejs-web-function.ts",
10464
- "line": 18
10484
+ "line": 19
10465
10485
  },
10466
10486
  "name": "minify",
10467
10487
  "optional": true,
@@ -10479,7 +10499,7 @@
10479
10499
  "immutable": true,
10480
10500
  "locationInModule": {
10481
10501
  "filename": "src/nodejs-web-function.ts",
10482
- "line": 25
10502
+ "line": 26
10483
10503
  },
10484
10504
  "name": "sourceMap",
10485
10505
  "optional": true,
@@ -10497,7 +10517,7 @@
10497
10517
  "immutable": true,
10498
10518
  "locationInModule": {
10499
10519
  "filename": "src/nodejs-web-function.ts",
10500
- "line": 40
10520
+ "line": 41
10501
10521
  },
10502
10522
  "name": "target",
10503
10523
  "optional": true,
@@ -10515,7 +10535,7 @@
10515
10535
  "immutable": true,
10516
10536
  "locationInModule": {
10517
10537
  "filename": "src/nodejs-web-function.ts",
10518
- "line": 83
10538
+ "line": 84
10519
10539
  },
10520
10540
  "name": "tsconfig",
10521
10541
  "optional": true,
@@ -10540,7 +10560,7 @@
10540
10560
  "kind": "interface",
10541
10561
  "locationInModule": {
10542
10562
  "filename": "src/nodejs-web-function.ts",
10543
- "line": 124
10563
+ "line": 125
10544
10564
  },
10545
10565
  "name": "NodejsWebFunctionProps",
10546
10566
  "properties": [
@@ -10554,7 +10574,7 @@
10554
10574
  "immutable": true,
10555
10575
  "locationInModule": {
10556
10576
  "filename": "src/nodejs-web-function.ts",
10557
- "line": 128
10577
+ "line": 129
10558
10578
  },
10559
10579
  "name": "entry",
10560
10580
  "type": {
@@ -10571,7 +10591,7 @@
10571
10591
  "immutable": true,
10572
10592
  "locationInModule": {
10573
10593
  "filename": "src/nodejs-web-function.ts",
10574
- "line": 156
10594
+ "line": 157
10575
10595
  },
10576
10596
  "name": "bundling",
10577
10597
  "optional": true,
@@ -10589,7 +10609,7 @@
10589
10609
  "immutable": true,
10590
10610
  "locationInModule": {
10591
10611
  "filename": "src/nodejs-web-function.ts",
10592
- "line": 142
10612
+ "line": 143
10593
10613
  },
10594
10614
  "name": "depsLockFilePath",
10595
10615
  "optional": true,
@@ -10608,7 +10628,7 @@
10608
10628
  "immutable": true,
10609
10629
  "locationInModule": {
10610
10630
  "filename": "src/nodejs-web-function.ts",
10611
- "line": 149
10631
+ "line": 150
10612
10632
  },
10613
10633
  "name": "projectRoot",
10614
10634
  "optional": true,
@@ -10626,7 +10646,7 @@
10626
10646
  "immutable": true,
10627
10647
  "locationInModule": {
10628
10648
  "filename": "src/nodejs-web-function.ts",
10629
- "line": 135
10649
+ "line": 136
10630
10650
  },
10631
10651
  "name": "runtime",
10632
10652
  "optional": true,
@@ -10655,7 +10675,7 @@
10655
10675
  },
10656
10676
  "locationInModule": {
10657
10677
  "filename": "src/web-function.ts",
10658
- "line": 445
10678
+ "line": 471
10659
10679
  },
10660
10680
  "parameters": [
10661
10681
  {
@@ -10684,7 +10704,7 @@
10684
10704
  "kind": "class",
10685
10705
  "locationInModule": {
10686
10706
  "filename": "src/web-function.ts",
10687
- "line": 387
10707
+ "line": 404
10688
10708
  },
10689
10709
  "methods": [
10690
10710
  {
@@ -10694,7 +10714,7 @@
10694
10714
  },
10695
10715
  "locationInModule": {
10696
10716
  "filename": "src/web-function.ts",
10697
- "line": 391
10717
+ "line": 414
10698
10718
  },
10699
10719
  "name": "fromWebFunctionArn",
10700
10720
  "parameters": [
@@ -10731,7 +10751,7 @@
10731
10751
  },
10732
10752
  "locationInModule": {
10733
10753
  "filename": "src/web-function.ts",
10734
- "line": 405
10754
+ "line": 428
10735
10755
  },
10736
10756
  "name": "fromWebFunctionAttributes",
10737
10757
  "parameters": [
@@ -10768,7 +10788,7 @@
10768
10788
  },
10769
10789
  "locationInModule": {
10770
10790
  "filename": "src/web-function.ts",
10771
- "line": 398
10791
+ "line": 421
10772
10792
  },
10773
10793
  "name": "fromWebFunctionName",
10774
10794
  "parameters": [
@@ -10805,7 +10825,7 @@
10805
10825
  },
10806
10826
  "locationInModule": {
10807
10827
  "filename": "src/web-function.ts",
10808
- "line": 544
10828
+ "line": 579
10809
10829
  },
10810
10830
  "name": "addEndpoint",
10811
10831
  "parameters": [
@@ -10839,7 +10859,7 @@
10839
10859
  },
10840
10860
  "locationInModule": {
10841
10861
  "filename": "src/web-function.ts",
10842
- "line": 552
10862
+ "line": 587
10843
10863
  },
10844
10864
  "name": "addEnvironment",
10845
10865
  "parameters": [
@@ -10870,7 +10890,7 @@
10870
10890
  },
10871
10891
  "locationInModule": {
10872
10892
  "filename": "src/web-function.ts",
10873
- "line": 581
10893
+ "line": 616
10874
10894
  },
10875
10895
  "name": "addPermission",
10876
10896
  "parameters": [
@@ -10898,7 +10918,7 @@
10898
10918
  },
10899
10919
  "locationInModule": {
10900
10920
  "filename": "src/web-function.ts",
10901
- "line": 563
10921
+ "line": 598
10902
10922
  },
10903
10923
  "name": "addToRolePolicy",
10904
10924
  "parameters": [
@@ -10910,6 +10930,23 @@
10910
10930
  }
10911
10931
  ]
10912
10932
  },
10933
+ {
10934
+ "docs": {
10935
+ "remarks": "It's added to `encryptionKey` when the key is defined in this app. Add it to every replica of a multi-Region key\nyourself: replicas don't share their primary's policy.",
10936
+ "stability": "experimental",
10937
+ "summary": "The key-policy statement Lambda needs to start this function's environments with `encryptionKey`: `kms:Decrypt` for `lambda.amazonaws.com`, limited to this function's revisions (`aws:SourceArn` and the encryption context Lambda sets)."
10938
+ },
10939
+ "locationInModule": {
10940
+ "filename": "src/web-function.ts",
10941
+ "line": 646
10942
+ },
10943
+ "name": "encryptionKeyPolicyStatement",
10944
+ "returns": {
10945
+ "type": {
10946
+ "fqn": "aws-cdk-lib.aws_iam.PolicyStatement"
10947
+ }
10948
+ }
10949
+ },
10913
10950
  {
10914
10951
  "docs": {
10915
10952
  "remarks": "Shortcut for `grants.invoke(grantee)`, as on `lambda.Function`.\n[disable-awslint:no-grants]",
@@ -10918,7 +10955,7 @@
10918
10955
  },
10919
10956
  "locationInModule": {
10920
10957
  "filename": "src/web-function.ts",
10921
- "line": 571
10958
+ "line": 606
10922
10959
  },
10923
10960
  "name": "grantInvoke",
10924
10961
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.WebFunctionBase",
@@ -10939,6 +10976,23 @@
10939
10976
  ],
10940
10977
  "name": "WebFunction",
10941
10978
  "properties": [
10979
+ {
10980
+ "const": true,
10981
+ "docs": {
10982
+ "stability": "experimental",
10983
+ "summary": "Identifies this class to property injectors (`PropertyInjectors.of(scope).add(...)`), which can set default props for every `WebFunction` under a scope. Injectors for `WebFunction` also apply to `NodejsWebFunction`."
10984
+ },
10985
+ "immutable": true,
10986
+ "locationInModule": {
10987
+ "filename": "src/web-function.ts",
10988
+ "line": 409
10989
+ },
10990
+ "name": "PROPERTY_INJECTION_ID",
10991
+ "static": true,
10992
+ "type": {
10993
+ "primitive": "string"
10994
+ }
10995
+ },
10942
10996
  {
10943
10997
  "docs": {
10944
10998
  "stability": "experimental",
@@ -10947,7 +11001,7 @@
10947
11001
  "immutable": true,
10948
11002
  "locationInModule": {
10949
11003
  "filename": "src/web-function.ts",
10950
- "line": 416
11004
+ "line": 439
10951
11005
  },
10952
11006
  "name": "currentRevision",
10953
11007
  "type": {
@@ -10963,7 +11017,7 @@
10963
11017
  "immutable": true,
10964
11018
  "locationInModule": {
10965
11019
  "filename": "src/web-function.ts",
10966
- "line": 419
11020
+ "line": 442
10967
11021
  },
10968
11022
  "name": "endpoint",
10969
11023
  "type": {
@@ -10978,7 +11032,7 @@
10978
11032
  "immutable": true,
10979
11033
  "locationInModule": {
10980
11034
  "filename": "src/web-function.ts",
10981
- "line": 428
11035
+ "line": 454
10982
11036
  },
10983
11037
  "name": "grantPrincipal",
10984
11038
  "overrides": "aws-cdk-lib.aws_iam.IGrantable",
@@ -10994,7 +11048,7 @@
10994
11048
  "immutable": true,
10995
11049
  "locationInModule": {
10996
11050
  "filename": "src/web-function.ts",
10997
- "line": 422
11051
+ "line": 445
10998
11052
  },
10999
11053
  "name": "grants",
11000
11054
  "type": {
@@ -11010,7 +11064,7 @@
11010
11064
  "immutable": true,
11011
11065
  "locationInModule": {
11012
11066
  "filename": "src/web-function.ts",
11013
- "line": 434
11067
+ "line": 460
11014
11068
  },
11015
11069
  "name": "logGroup",
11016
11070
  "type": {
@@ -11026,7 +11080,7 @@
11026
11080
  "immutable": true,
11027
11081
  "locationInModule": {
11028
11082
  "filename": "src/web-function.ts",
11029
- "line": 413
11083
+ "line": 436
11030
11084
  },
11031
11085
  "name": "revisionId",
11032
11086
  "type": {
@@ -11041,7 +11095,7 @@
11041
11095
  "immutable": true,
11042
11096
  "locationInModule": {
11043
11097
  "filename": "src/web-function.ts",
11044
- "line": 425
11098
+ "line": 448
11045
11099
  },
11046
11100
  "name": "role",
11047
11101
  "type": {
@@ -11056,7 +11110,7 @@
11056
11110
  "immutable": true,
11057
11111
  "locationInModule": {
11058
11112
  "filename": "src/web-function.ts",
11059
- "line": 410
11113
+ "line": 433
11060
11114
  },
11061
11115
  "name": "webFunctionArn",
11062
11116
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.WebFunctionBase",
@@ -11072,13 +11126,29 @@
11072
11126
  "immutable": true,
11073
11127
  "locationInModule": {
11074
11128
  "filename": "src/web-function.ts",
11075
- "line": 409
11129
+ "line": 432
11076
11130
  },
11077
11131
  "name": "webFunctionName",
11078
11132
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.WebFunctionBase",
11079
11133
  "type": {
11080
11134
  "primitive": "string"
11081
11135
  }
11136
+ },
11137
+ {
11138
+ "docs": {
11139
+ "stability": "experimental",
11140
+ "summary": "The customer managed key of the function's revisions, if any."
11141
+ },
11142
+ "immutable": true,
11143
+ "locationInModule": {
11144
+ "filename": "src/web-function.ts",
11145
+ "line": 451
11146
+ },
11147
+ "name": "encryptionKey",
11148
+ "optional": true,
11149
+ "type": {
11150
+ "fqn": "aws-cdk-lib.aws_kms.IKey"
11151
+ }
11082
11152
  }
11083
11153
  ],
11084
11154
  "symbolId": "src/web-function:WebFunction"
@@ -11095,7 +11165,7 @@
11095
11165
  "kind": "interface",
11096
11166
  "locationInModule": {
11097
11167
  "filename": "src/web-function.ts",
11098
- "line": 210
11168
+ "line": 227
11099
11169
  },
11100
11170
  "name": "WebFunctionAttributes",
11101
11171
  "properties": [
@@ -11109,7 +11179,7 @@
11109
11179
  "immutable": true,
11110
11180
  "locationInModule": {
11111
11181
  "filename": "src/web-function.ts",
11112
- "line": 232
11182
+ "line": 249
11113
11183
  },
11114
11184
  "name": "endpointName",
11115
11185
  "optional": true,
@@ -11127,7 +11197,7 @@
11127
11197
  "immutable": true,
11128
11198
  "locationInModule": {
11129
11199
  "filename": "src/web-function.ts",
11130
- "line": 218
11200
+ "line": 235
11131
11201
  },
11132
11202
  "name": "webFunctionArn",
11133
11203
  "optional": true,
@@ -11145,7 +11215,7 @@
11145
11215
  "immutable": true,
11146
11216
  "locationInModule": {
11147
11217
  "filename": "src/web-function.ts",
11148
- "line": 225
11218
+ "line": 242
11149
11219
  },
11150
11220
  "name": "webFunctionName",
11151
11221
  "optional": true,
@@ -11233,7 +11303,7 @@
11233
11303
  "kind": "class",
11234
11304
  "locationInModule": {
11235
11305
  "filename": "src/web-function.ts",
11236
- "line": 273
11306
+ "line": 290
11237
11307
  },
11238
11308
  "methods": [
11239
11309
  {
@@ -11244,7 +11314,7 @@
11244
11314
  },
11245
11315
  "locationInModule": {
11246
11316
  "filename": "src/web-function.ts",
11247
- "line": 296
11317
+ "line": 313
11248
11318
  },
11249
11319
  "name": "addToResourcePolicy",
11250
11320
  "overrides": "aws-cdk-lib.aws_iam.IResourceWithPolicyV2",
@@ -11271,7 +11341,7 @@
11271
11341
  },
11272
11342
  "locationInModule": {
11273
11343
  "filename": "src/web-function.ts",
11274
- "line": 286
11344
+ "line": 303
11275
11345
  },
11276
11346
  "name": "grantInvoke",
11277
11347
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11298,7 +11368,7 @@
11298
11368
  },
11299
11369
  "locationInModule": {
11300
11370
  "filename": "src/web-function.ts",
11301
- "line": 327
11371
+ "line": 344
11302
11372
  },
11303
11373
  "name": "metric",
11304
11374
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11330,7 +11400,7 @@
11330
11400
  },
11331
11401
  "locationInModule": {
11332
11402
  "filename": "src/web-function.ts",
11333
- "line": 342
11403
+ "line": 359
11334
11404
  },
11335
11405
  "name": "metricActiveTime",
11336
11406
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11357,7 +11427,7 @@
11357
11427
  },
11358
11428
  "locationInModule": {
11359
11429
  "filename": "src/web-function.ts",
11360
- "line": 357
11430
+ "line": 374
11361
11431
  },
11362
11432
  "name": "metricConcurrentRequests",
11363
11433
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11383,7 +11453,7 @@
11383
11453
  },
11384
11454
  "locationInModule": {
11385
11455
  "filename": "src/web-function.ts",
11386
- "line": 347
11456
+ "line": 364
11387
11457
  },
11388
11458
  "name": "metricCpuTime",
11389
11459
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11411,7 +11481,7 @@
11411
11481
  },
11412
11482
  "locationInModule": {
11413
11483
  "filename": "src/web-function.ts",
11414
- "line": 366
11484
+ "line": 383
11415
11485
  },
11416
11486
  "name": "metricMaxMemoryUsage",
11417
11487
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11437,7 +11507,7 @@
11437
11507
  },
11438
11508
  "locationInModule": {
11439
11509
  "filename": "src/web-function.ts",
11440
- "line": 371
11510
+ "line": 388
11441
11511
  },
11442
11512
  "name": "metricResponseBytes",
11443
11513
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11468,7 +11538,7 @@
11468
11538
  "immutable": true,
11469
11539
  "locationInModule": {
11470
11540
  "filename": "src/web-function.ts",
11471
- "line": 275
11541
+ "line": 292
11472
11542
  },
11473
11543
  "name": "webFunctionArn",
11474
11544
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11485,7 +11555,7 @@
11485
11555
  "immutable": true,
11486
11556
  "locationInModule": {
11487
11557
  "filename": "src/web-function.ts",
11488
- "line": 274
11558
+ "line": 291
11489
11559
  },
11490
11560
  "name": "webFunctionName",
11491
11561
  "overrides": "@ashishpandeyone/cdk-lambda-web-function.IWebFunction",
@@ -11501,7 +11571,7 @@
11501
11571
  "immutable": true,
11502
11572
  "locationInModule": {
11503
11573
  "filename": "src/web-function.ts",
11504
- "line": 278
11574
+ "line": 295
11505
11575
  },
11506
11576
  "name": "webFunctionRef",
11507
11577
  "overrides": "aws-cdk-lib.interfaces.aws_lambda.IWebFunctionRef",
@@ -12563,7 +12633,7 @@
12563
12633
  "kind": "interface",
12564
12634
  "locationInModule": {
12565
12635
  "filename": "src/web-function.ts",
12566
- "line": 25
12636
+ "line": 27
12567
12637
  },
12568
12638
  "name": "WebFunctionOptions",
12569
12639
  "properties": [
@@ -12576,7 +12646,7 @@
12576
12646
  "immutable": true,
12577
12647
  "locationInModule": {
12578
12648
  "filename": "src/web-function.ts",
12579
- "line": 29
12649
+ "line": 31
12580
12650
  },
12581
12651
  "name": "authType",
12582
12652
  "type": {
@@ -12593,7 +12663,7 @@
12593
12663
  "immutable": true,
12594
12664
  "locationInModule": {
12595
12665
  "filename": "src/web-function.ts",
12596
- "line": 118
12666
+ "line": 135
12597
12667
  },
12598
12668
  "name": "applicationLogLevelV2",
12599
12669
  "optional": true,
@@ -12611,7 +12681,7 @@
12611
12681
  "immutable": true,
12612
12682
  "locationInModule": {
12613
12683
  "filename": "src/web-function.ts",
12614
- "line": 64
12684
+ "line": 66
12615
12685
  },
12616
12686
  "name": "description",
12617
12687
  "optional": true,
@@ -12619,6 +12689,25 @@
12619
12689
  "primitive": "string"
12620
12690
  }
12621
12691
  },
12692
+ {
12693
+ "abstract": true,
12694
+ "docs": {
12695
+ "default": "- an AWS owned key",
12696
+ "remarks": "A `PER_REGION` or `MULTI_REGION` endpoint needs a **multi-Region key** with a replica in every region it serves\nfrom, and each replica's policy must allow Lambda to decrypt (see `encryptionKeyPolicyStatement()`). A key defined\nin this app gets that statement added to its own policy.\n\nChanging the key creates a new revision. Earlier revisions, including the ones kept as rollback targets, still\nneed their key.\n[disable-awslint:prefer-ref-interface]",
12697
+ "stability": "experimental",
12698
+ "summary": "A customer managed KMS key for the function's revisions: their code and environment variables."
12699
+ },
12700
+ "immutable": true,
12701
+ "locationInModule": {
12702
+ "filename": "src/web-function.ts",
12703
+ "line": 91
12704
+ },
12705
+ "name": "encryptionKey",
12706
+ "optional": true,
12707
+ "type": {
12708
+ "fqn": "aws-cdk-lib.aws_kms.IKey"
12709
+ }
12710
+ },
12622
12711
  {
12623
12712
  "abstract": true,
12624
12713
  "docs": {
@@ -12629,7 +12718,7 @@
12629
12718
  "immutable": true,
12630
12719
  "locationInModule": {
12631
12720
  "filename": "src/web-function.ts",
12632
- "line": 38
12721
+ "line": 40
12633
12722
  },
12634
12723
  "name": "endpoint",
12635
12724
  "optional": true,
@@ -12648,7 +12737,7 @@
12648
12737
  "immutable": true,
12649
12738
  "locationInModule": {
12650
12739
  "filename": "src/web-function.ts",
12651
- "line": 81
12740
+ "line": 98
12652
12741
  },
12653
12742
  "name": "environment",
12654
12743
  "optional": true,
@@ -12672,7 +12761,7 @@
12672
12761
  "immutable": true,
12673
12762
  "locationInModule": {
12674
12763
  "filename": "src/web-function.ts",
12675
- "line": 111
12764
+ "line": 128
12676
12765
  },
12677
12766
  "name": "logRemovalPolicy",
12678
12767
  "optional": true,
@@ -12690,7 +12779,7 @@
12690
12779
  "immutable": true,
12691
12780
  "locationInModule": {
12692
12781
  "filename": "src/web-function.ts",
12693
- "line": 103
12782
+ "line": 120
12694
12783
  },
12695
12784
  "name": "logRetention",
12696
12785
  "optional": true,
@@ -12709,7 +12798,7 @@
12709
12798
  "immutable": true,
12710
12799
  "locationInModule": {
12711
12800
  "filename": "src/web-function.ts",
12712
- "line": 96
12801
+ "line": 113
12713
12802
  },
12714
12803
  "name": "maxConcurrencyPerEnvironment",
12715
12804
  "optional": true,
@@ -12728,7 +12817,7 @@
12728
12817
  "immutable": true,
12729
12818
  "locationInModule": {
12730
12819
  "filename": "src/web-function.ts",
12731
- "line": 50
12820
+ "line": 52
12732
12821
  },
12733
12822
  "name": "revisionRetention",
12734
12823
  "optional": true,
@@ -12747,7 +12836,7 @@
12747
12836
  "immutable": true,
12748
12837
  "locationInModule": {
12749
12838
  "filename": "src/web-function.ts",
12750
- "line": 74
12839
+ "line": 76
12751
12840
  },
12752
12841
  "name": "role",
12753
12842
  "optional": true,
@@ -12765,7 +12854,7 @@
12765
12854
  "immutable": true,
12766
12855
  "locationInModule": {
12767
12856
  "filename": "src/web-function.ts",
12768
- "line": 125
12857
+ "line": 142
12769
12858
  },
12770
12859
  "name": "systemLogLevelV2",
12771
12860
  "optional": true,
@@ -12783,7 +12872,7 @@
12783
12872
  "immutable": true,
12784
12873
  "locationInModule": {
12785
12874
  "filename": "src/web-function.ts",
12786
- "line": 88
12875
+ "line": 105
12787
12876
  },
12788
12877
  "name": "timeout",
12789
12878
  "optional": true,
@@ -12802,7 +12891,7 @@
12802
12891
  "immutable": true,
12803
12892
  "locationInModule": {
12804
12893
  "filename": "src/web-function.ts",
12805
- "line": 57
12894
+ "line": 59
12806
12895
  },
12807
12896
  "name": "webFunctionName",
12808
12897
  "optional": true,
@@ -13053,7 +13142,7 @@
13053
13142
  "kind": "interface",
13054
13143
  "locationInModule": {
13055
13144
  "filename": "src/web-function.ts",
13056
- "line": 238
13145
+ "line": 255
13057
13146
  },
13058
13147
  "name": "WebFunctionPermission",
13059
13148
  "properties": [
@@ -13067,7 +13156,7 @@
13067
13156
  "immutable": true,
13068
13157
  "locationInModule": {
13069
13158
  "filename": "src/web-function.ts",
13070
- "line": 245
13159
+ "line": 262
13071
13160
  },
13072
13161
  "name": "principal",
13073
13162
  "type": {
@@ -13085,7 +13174,7 @@
13085
13174
  "immutable": true,
13086
13175
  "locationInModule": {
13087
13176
  "filename": "src/web-function.ts",
13088
- "line": 252
13177
+ "line": 269
13089
13178
  },
13090
13179
  "name": "endpoint",
13091
13180
  "optional": true,
@@ -13103,7 +13192,7 @@
13103
13192
  "immutable": true,
13104
13193
  "locationInModule": {
13105
13194
  "filename": "src/web-function.ts",
13106
- "line": 267
13195
+ "line": 284
13107
13196
  },
13108
13197
  "name": "sourceAccount",
13109
13198
  "optional": true,
@@ -13121,7 +13210,7 @@
13121
13210
  "immutable": true,
13122
13211
  "locationInModule": {
13123
13212
  "filename": "src/web-function.ts",
13124
- "line": 260
13213
+ "line": 277
13125
13214
  },
13126
13215
  "name": "sourceArn",
13127
13216
  "optional": true,
@@ -13146,7 +13235,7 @@
13146
13235
  "kind": "interface",
13147
13236
  "locationInModule": {
13148
13237
  "filename": "src/web-function.ts",
13149
- "line": 131
13238
+ "line": 148
13150
13239
  },
13151
13240
  "name": "WebFunctionProps",
13152
13241
  "properties": [
@@ -13160,7 +13249,7 @@
13160
13249
  "immutable": true,
13161
13250
  "locationInModule": {
13162
13251
  "filename": "src/web-function.ts",
13163
- "line": 143
13252
+ "line": 160
13164
13253
  },
13165
13254
  "name": "code",
13166
13255
  "type": {
@@ -13176,7 +13265,7 @@
13176
13265
  "immutable": true,
13177
13266
  "locationInModule": {
13178
13267
  "filename": "src/web-function.ts",
13179
- "line": 135
13268
+ "line": 152
13180
13269
  },
13181
13270
  "name": "runtime",
13182
13271
  "type": {
@@ -13193,7 +13282,7 @@
13193
13282
  "immutable": true,
13194
13283
  "locationInModule": {
13195
13284
  "filename": "src/web-function.ts",
13196
- "line": 150
13285
+ "line": 167
13197
13286
  },
13198
13287
  "name": "entrypoint",
13199
13288
  "optional": true,
@@ -13525,6 +13614,6 @@
13525
13614
  "symbolId": "src/web-function-deployment:WebFunctionRollbackOptions"
13526
13615
  }
13527
13616
  },
13528
- "version": "0.1.9",
13529
- "fingerprint": "Dn29ca+sUsH1dlKk8++TAaaSga5SpeYgvVF0XGm7cX4="
13617
+ "version": "0.1.11",
13618
+ "fingerprint": "XHiV3rReOWg8t/oaiEl/zpW3DJhhCMpXEytqX7ZmJoI="
13530
13619
  }