From 9f689d40582d923740b9608b908e953dfb9a37fd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 02:56:56 +0000 Subject: [PATCH 1/2] chore(deps): upgrade dependencies Upgrades project dependencies. See details in [workflow run]. [Workflow Run]: https://github.com/open-constructs/cdk-serverless/actions/runs/29220533521 ------ *Automatically created by projen via the "upgrade-main" workflow* Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- package-lock.json | 276 +++++++++++++++++++++++++--------------------- package.json | 20 ++-- 2 files changed, 163 insertions(+), 133 deletions(-) diff --git a/package-lock.json b/package-lock.json index 90ceb8c..269b84c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,10 +9,10 @@ "version": "0.0.0", "license": "Apache-2.0", "dependencies": { - "@types/aws-lambda": "^8.10.161", + "@types/aws-lambda": "^8.10.162", "constructs": "^10.5.1", - "date-fns": "^4.1.0", - "js-yaml": "^4.1.1", + "date-fns": "^4.4.0", + "js-yaml": "^4.3.0", "jsonwebtoken": "^9.0.3", "jwk-to-pem": "^2.0.7", "lambda-log": "^3.1.0" @@ -37,22 +37,22 @@ "constructs": "^10.0.0", "dynamodb-onetable": "2.7.7", "eslint": "^9", - "eslint-import-resolver-typescript": "^4.4.4", + "eslint-import-resolver-typescript": "^4.4.5", "eslint-plugin-import": "^2.32.0", "jest": "^29.7.0", "jest-junit": "^16", "openapi-typescript": "7.13.0", "projen": "0.99.47", - "ts-jest": "^29.4.9", + "ts-jest": "^29.4.11", "ts-node": "^10.9.2", - "typedoc": "0.28.19", + "typedoc": "0.28.20", "typescript": "^5.9.3" }, "peerDependencies": { - "@aws-sdk/client-cognito-identity-provider": "^3.1014.0", - "@aws-sdk/client-dynamodb": "^3.1014.0", - "@aws-sdk/client-s3": "^3.1014.0", - "@aws-sdk/lib-dynamodb": "^3.1014.0", + "@aws-sdk/client-cognito-identity-provider": "^3.1085.0", + "@aws-sdk/client-dynamodb": "^3.1085.0", + "@aws-sdk/client-s3": "^3.1085.0", + "@aws-sdk/lib-dynamodb": "^3.1085.0", "aws-cdk-lib": ">=2.248.0 <3.0.0", "dynamodb-onetable": "2.7.7", "openapi-typescript": "^7.13.0", @@ -1903,9 +1903,9 @@ } }, "node_modules/@eslint/eslintrc": { - "version": "3.3.5", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.5.tgz", - "integrity": "sha512-4IlJx0X0qftVsN5E+/vGujTRIFtwuLbNsVUe7TO6zYPDR1O6nFwvwhIKEKSrl6dZchmYBITazxKoUYOjdtjlRg==", + "version": "3.3.6", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.6.tgz", + "integrity": "sha512-l2Ul9PrHsPCKcEY/ac7VgFj9D80C7S68sOKc618SyHDPK36s1XcFebXY0iTzUVn4Yq+YbwvSnDmCz9yxjX+QrA==", "dev": true, "license": "MIT", "dependencies": { @@ -1915,7 +1915,7 @@ "globals": "^14.0.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", - "js-yaml": "^4.1.1", + "js-yaml": "^4.3.0", "minimatch": "^3.1.5", "strip-json-comments": "^3.1.1" }, @@ -1927,9 +1927,9 @@ } }, "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.14.tgz", - "integrity": "sha512-MWPGfDxnyzKU7rNOW9SP/c50vi3xrmrua/+6hfPbCS2ABNWfx24vPidzvC7krjU/RTo235sV776ymlsMtGKj8g==", + "version": "1.1.16", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.16.tgz", + "integrity": "sha512-IDw48K2/2kRkg9LdJxurvq3lV3aBgq0REY89duEqFRthjlPdXHKMj7EnQOXVckxzgisinf3nHfrcE2FufFLXMw==", "dev": true, "license": "MIT", "dependencies": { @@ -1961,9 +1961,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.39.4", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.4.tgz", - "integrity": "sha512-nE7DEIchvtiFTwBw4Lfbu59PG+kCofhjsKaCWzxTpt4lfRjRMqG6uMBzKXuEcyXhOHoUp9riAm7/aWYGhXZ9cw==", + "version": "9.39.5", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.5.tgz", + "integrity": "sha512-QywQuszQh77pIXCsq998c8hbhSTI/azTty1Z6N53dmAudKHhy573j3yvRLsX2BSp8YpLtoCEG8E9DJe+8zUh4A==", "dev": true, "license": "MIT", "engines": { @@ -2132,9 +2132,9 @@ } }, "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": { - "version": "3.14.2", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", - "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.0.tgz", + "integrity": "sha512-ttBQIIQPDeLjpPOohtUdXuXUVoA2uIB6fEH9HyJ7234s5mBJ5wTx20njxplLZQgLaOfpmPQA7X2t5AX6tIPbog==", "dev": true, "license": "MIT", "dependencies": { @@ -3920,9 +3920,9 @@ } }, "node_modules/@types/aws-lambda": { - "version": "8.10.161", - "resolved": "https://registry.npmjs.org/@types/aws-lambda/-/aws-lambda-8.10.161.tgz", - "integrity": "sha512-rUYdp+MQwSFocxIOcSsYSF3YYYC/uUpMbCY/mbO21vGqfrEYvNSoPyKYDj6RhXXpPfS0KstW9RwG3qXh9sL7FQ==", + "version": "8.10.162", + "resolved": "https://registry.npmjs.org/@types/aws-lambda/-/aws-lambda-8.10.162.tgz", + "integrity": "sha512-Fn658grtLOci1oxi1391vvDWJRKNGWRSqfxRkmN/Iy3c0tQH1USMKEXcPYHLvope+ZgTFocx9FRQJx1muBL6qw==", "license": "MIT" }, "node_modules/@types/babel__core": { @@ -4147,17 +4147,17 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.58.1.tgz", - "integrity": "sha512-eSkwoemjo76bdXl2MYqtxg51HNwUSkWfODUOQ3PaTLZGh9uIWWFZIjyjaJnex7wXDu+TRx+ATsnSxdN9YWfRTQ==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.63.0.tgz", + "integrity": "sha512-rvwSgqT+DHpWdzfSzPatRLm02a0GlESt++9iy3hLCDY4BgkaLcl8LBi9Yh7XGFBpwcBE/K3024QuXWTpbz4FfQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.12.2", - "@typescript-eslint/scope-manager": "8.58.1", - "@typescript-eslint/type-utils": "8.58.1", - "@typescript-eslint/utils": "8.58.1", - "@typescript-eslint/visitor-keys": "8.58.1", + "@typescript-eslint/scope-manager": "8.63.0", + "@typescript-eslint/type-utils": "8.63.0", + "@typescript-eslint/utils": "8.63.0", + "@typescript-eslint/visitor-keys": "8.63.0", "ignore": "^7.0.5", "natural-compare": "^1.4.0", "ts-api-utils": "^2.5.0" @@ -4170,22 +4170,22 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^8.58.1", + "@typescript-eslint/parser": "^8.63.0", "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0", "typescript": ">=4.8.4 <6.1.0" } }, "node_modules/@typescript-eslint/parser": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.58.1.tgz", - "integrity": "sha512-gGkiNMPqerb2cJSVcruigx9eHBlLG14fSdPdqMoOcBfh+vvn4iCq2C8MzUB89PrxOXk0y3GZ1yIWb9aOzL93bw==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.63.0.tgz", + "integrity": "sha512-gwh4gvvlaVDKKxyfxMG+Gnu1u9X0OQBwyGLkbwB65dIzBKnxeRiJlNFqlI3zwVhNXJIs6qV7mlFCn/BIajlVig==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.58.1", - "@typescript-eslint/types": "8.58.1", - "@typescript-eslint/typescript-estree": "8.58.1", - "@typescript-eslint/visitor-keys": "8.58.1", + "@typescript-eslint/scope-manager": "8.63.0", + "@typescript-eslint/types": "8.63.0", + "@typescript-eslint/typescript-estree": "8.63.0", + "@typescript-eslint/visitor-keys": "8.63.0", "debug": "^4.4.3" }, "engines": { @@ -4201,14 +4201,14 @@ } }, "node_modules/@typescript-eslint/project-service": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.58.1.tgz", - "integrity": "sha512-gfQ8fk6cxhtptek+/8ZIqw8YrRW5048Gug8Ts5IYcMLCw18iUgrZAEY/D7s4hkI0FxEfGakKuPK/XUMPzPxi5g==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.63.0.tgz", + "integrity": "sha512-e5dh0/UI0ok53AlZ5wRkXCB32z/f2jUZqPR/ygAw5WYaSw8j9EoJWlS7wQjr/dmOaqWjnPIn2m+HhVPCMWGZVQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/tsconfig-utils": "^8.58.1", - "@typescript-eslint/types": "^8.58.1", + "@typescript-eslint/tsconfig-utils": "^8.63.0", + "@typescript-eslint/types": "^8.63.0", "debug": "^4.4.3" }, "engines": { @@ -4223,14 +4223,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.58.1.tgz", - "integrity": "sha512-TPYUEqJK6avLcEjumWsIuTpuYODTTDAtoMdt8ZZa93uWMTX13Nb8L5leSje1NluammvU+oI3QRr5lLXPgihX3w==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.63.0.tgz", + "integrity": "sha512-uUyfMWCnDSN8bCpcrY8nGP2BLkQ9Xn0GsipcONcpIDWhwhO4ZSyHvyS14U3X75mzxWxL3I2UZIrenTzdzcJO8A==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.58.1", - "@typescript-eslint/visitor-keys": "8.58.1" + "@typescript-eslint/types": "8.63.0", + "@typescript-eslint/visitor-keys": "8.63.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -4241,9 +4241,9 @@ } }, "node_modules/@typescript-eslint/tsconfig-utils": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.58.1.tgz", - "integrity": "sha512-JAr2hOIct2Q+qk3G+8YFfqkqi7sC86uNryT+2i5HzMa2MPjw4qNFvtjnw1IiA1rP7QhNKVe21mSSLaSjwA1Olw==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.63.0.tgz", + "integrity": "sha512-sUAbkulqBAsncKnbRP3+7CtQFRKicexnj7ZwNC6ddCR7EmrXvjvdCYMJbUIqMd6lwoEriZjwLo08aS5tSjVMHg==", "dev": true, "license": "MIT", "engines": { @@ -4258,15 +4258,15 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.58.1.tgz", - "integrity": "sha512-HUFxvTJVroT+0rXVJC7eD5zol6ID+Sn5npVPWoFuHGg9Ncq5Q4EYstqR+UOqaNRFXi5TYkpXXkLhoCHe3G0+7w==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.63.0.tgz", + "integrity": "sha512-Nzzh/OGxVCOjObjaj1CQF2RUasyYy2Jfuh+zZ3PjLzG2fYRriAiZLib9UKtO+CpQAS3YHiAS+ckZDclwqI1TPA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.58.1", - "@typescript-eslint/typescript-estree": "8.58.1", - "@typescript-eslint/utils": "8.58.1", + "@typescript-eslint/types": "8.63.0", + "@typescript-eslint/typescript-estree": "8.63.0", + "@typescript-eslint/utils": "8.63.0", "debug": "^4.4.3", "ts-api-utils": "^2.5.0" }, @@ -4283,9 +4283,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.58.1.tgz", - "integrity": "sha512-io/dV5Aw5ezwzfPBBWLoT+5QfVtP8O7q4Kftjn5azJ88bYyp/ZMCsyW1lpKK46EXJcaYMZ1JtYj+s/7TdzmQMw==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.63.0.tgz", + "integrity": "sha512-xyLtl9DUBBFrcJS4x2pIqGLH68/tC2uOa4Z7pUteW09D3bXnnXUom4dyPikzWgB7llmIc1zoeI3aoUdC4rPK/Q==", "dev": true, "license": "MIT", "engines": { @@ -4297,16 +4297,16 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.58.1.tgz", - "integrity": "sha512-w4w7WR7GHOjqqPnvAYbazq+Y5oS68b9CzasGtnd6jIeOIeKUzYzupGTB2T4LTPSv4d+WPeccbxuneTFHYgAAWg==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.63.0.tgz", + "integrity": "sha512-ygBkU+B7ex5UI/gKhaqexWev79uISfIv7XQCRNYO/jmD8rGLPyWLAb3KMRT6nd8Gt9bmUBi9+iX6tBdYfOY81Q==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/project-service": "8.58.1", - "@typescript-eslint/tsconfig-utils": "8.58.1", - "@typescript-eslint/types": "8.58.1", - "@typescript-eslint/visitor-keys": "8.58.1", + "@typescript-eslint/project-service": "8.63.0", + "@typescript-eslint/tsconfig-utils": "8.63.0", + "@typescript-eslint/types": "8.63.0", + "@typescript-eslint/visitor-keys": "8.63.0", "debug": "^4.4.3", "minimatch": "^10.2.2", "semver": "^7.7.3", @@ -4325,16 +4325,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.58.1.tgz", - "integrity": "sha512-Ln8R0tmWC7pTtLOzgJzYTXSCjJ9rDNHAqTaVONF4FEi2qwce8mD9iSOxOpLFFvWp/wBFlew0mjM1L1ihYWfBdQ==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.63.0.tgz", + "integrity": "sha512-fUKaeAvrTuQg/Tgt3nliAUSZHJM6DlCcfyEmxCvlX8kieWSStBX+5O5Fnidtc3i2JrH+9c/GL4RY2iasd/GPTA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.9.1", - "@typescript-eslint/scope-manager": "8.58.1", - "@typescript-eslint/types": "8.58.1", - "@typescript-eslint/typescript-estree": "8.58.1" + "@typescript-eslint/scope-manager": "8.63.0", + "@typescript-eslint/types": "8.63.0", + "@typescript-eslint/typescript-estree": "8.63.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -4349,13 +4349,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.58.1", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.58.1.tgz", - "integrity": "sha512-y+vH7QE8ycjoa0bWciFg7OpFcipUuem1ujhrdLtq1gByKwfbC7bPeKsiny9e0urg93DqwGcHey+bGRKCnF1nZQ==", + "version": "8.63.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.63.0.tgz", + "integrity": "sha512-UexrHGnGTpbuQHct2ExOc2ZcFbGUS9FOesCxxqdBGcpI1BxYu/LZ6U8Aq6/72XtF/qRBk9nhuGHFJIXXMhPMdw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.58.1", + "@typescript-eslint/types": "8.63.0", "eslint-visitor-keys": "^5.0.0" }, "engines": { @@ -4702,9 +4702,9 @@ } }, "node_modules/ajv": { - "version": "6.14.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", - "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "version": "6.15.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.15.0.tgz", + "integrity": "sha512-fgFx7Hfoq60ytK2c7DhnF8jIvzYgOMxfugjLOSMHjLIPgenqa7S7oaagATUq99mV6IYvN2tRmC0wnTYX6iPbMw==", "dev": true, "license": "MIT", "dependencies": { @@ -5967,9 +5967,9 @@ "license": "MIT" }, "node_modules/commit-and-tag-version": { - "version": "12.7.1", - "resolved": "https://registry.npmjs.org/commit-and-tag-version/-/commit-and-tag-version-12.7.1.tgz", - "integrity": "sha512-18+iV9VMPWQ5rryn1nKprvkwqFMx1eOcEwIprjgyGm8Blhsw7WnsFXgyYLIlBF4uG2fcbbps8P7fBZARvaA0VA==", + "version": "12.7.3", + "resolved": "https://registry.npmjs.org/commit-and-tag-version/-/commit-and-tag-version-12.7.3.tgz", + "integrity": "sha512-rbauuCDU98yEHMy/LrNNu8HLTuGv7C2kN/3GXC59L18aJGii0eiryCESb1SEHXNFem2/2ngWG/Pq6qaCqw3aCw==", "dev": true, "license": "ISC", "dependencies": { @@ -6486,9 +6486,9 @@ } }, "node_modules/date-fns": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-4.1.0.tgz", - "integrity": "sha512-Ukq0owbQXxa/U3EGtsdVBkR1w7KOQ5gIBqdH2hkvknzZPYvBxb/aa6E8L7tmjFtkwZBu3UXBbjIgPo/Ez4xaNg==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-4.4.0.tgz", + "integrity": "sha512-+1UMbeh68lH1SegH83CGWwpb6OHHbpSgr3+s5Eww5M4CAgswBpoWS0AjTOfEJ33HiYKz1hdj/KTFprzXHmq/6w==", "license": "MIT", "funding": { "type": "github", @@ -7073,9 +7073,9 @@ } }, "node_modules/eslint": { - "version": "9.39.4", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.4.tgz", - "integrity": "sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ==", + "version": "9.39.5", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.5.tgz", + "integrity": "sha512-DgZS62aPLXKlnxILS/AYCoRvHaZeXceIzlXPkkGGzJWSow1aEk0lbTlxUSlyjC8jcaKxAdOnTDz+o1JFSBsyjw==", "dev": true, "license": "MIT", "dependencies": { @@ -7084,8 +7084,8 @@ "@eslint/config-array": "^0.21.2", "@eslint/config-helpers": "^0.4.2", "@eslint/core": "^0.17.0", - "@eslint/eslintrc": "^3.3.5", - "@eslint/js": "9.39.4", + "@eslint/eslintrc": "^3.3.6", + "@eslint/js": "9.39.5", "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", @@ -7180,9 +7180,9 @@ } }, "node_modules/eslint-import-resolver-typescript": { - "version": "4.4.4", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-4.4.4.tgz", - "integrity": "sha512-1iM2zeBvrYmUNTj2vSC/90JTHDth+dfOfiNKkxApWRsTJYNrc8rOdxxIf5vazX+BiAXTeOT0UvWpGI/7qIWQOw==", + "version": "4.4.5", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-4.4.5.tgz", + "integrity": "sha512-nbE5XLph6TLtGYcu/U6e6ZVXyKBhbDWK5cLGk76eJ7NdZpwf1P9EFkpt1Z01mNZNrrilsAYWKH6zUkL4reoXbw==", "dev": true, "license": "ISC", "dependencies": { @@ -10818,9 +10818,19 @@ "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", - "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.0.tgz", + "integrity": "sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/nodeca" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1" @@ -11052,10 +11062,20 @@ "license": "MIT" }, "node_modules/linkify-it": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", - "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz", + "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], "license": "MIT", "dependencies": { "uc.micro": "^2.0.0" @@ -11257,15 +11277,25 @@ } }, "node_modules/markdown-it": { - "version": "14.1.1", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", - "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", + "version": "14.3.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.3.0.tgz", + "integrity": "sha512-RCEsPjR+sr0x+AuYp601tKTkgFG4YEPLCzHST3cQ/fhlJkqAkz1L2/Qbp1j9qw5SBwQHFBoW8+hoN5xssOF0Tw==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1", - "entities": "^4.4.0", - "linkify-it": "^5.0.0", + "entities": "^4.5.0", + "linkify-it": "^5.0.2", "mdurl": "^2.0.0", "punycode.js": "^2.3.1", "uc.micro": "^2.1.0" @@ -13787,9 +13817,9 @@ "license": "MIT" }, "node_modules/semver": { - "version": "7.7.4", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", - "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "license": "ISC", "bin": { "semver": "bin/semver.js" @@ -14468,9 +14498,9 @@ } }, "node_modules/ts-jest": { - "version": "29.4.9", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.4.9.tgz", - "integrity": "sha512-LTb9496gYPMCqjeDLdPrKuXtncudeV1yRZnF4Wo5l3SFi0RYEnYRNgMrFIdg+FHvfzjCyQk1cLncWVqiSX+EvQ==", + "version": "29.4.11", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.4.11.tgz", + "integrity": "sha512-IrFl7l9AuB/qrNw5quqvAv/hmKMb8dhWOH4jQOGo0Oq8tCeo1O86/iTFG1FaRimgUkF13l4PcepO8ATFT6Ns4g==", "dev": true, "license": "MIT", "dependencies": { @@ -14480,7 +14510,7 @@ "json5": "^2.2.3", "lodash.memoize": "^4.1.2", "make-error": "^1.3.6", - "semver": "^7.7.4", + "semver": "^7.8.0", "type-fest": "^4.41.0", "yargs-parser": "^21.1.1" }, @@ -14752,17 +14782,17 @@ "license": "MIT" }, "node_modules/typedoc": { - "version": "0.28.19", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.19.tgz", - "integrity": "sha512-wKh+lhdmMFivMlc6vRRcMGXeGEHGU2g8a2CkPTJjJlwRf1iXbimWIPcFolCqe4E0d/FRtGszpIrsp3WLpDB8Pw==", + "version": "0.28.20", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.20.tgz", + "integrity": "sha512-uSKqkh8Cr48vllnEy+jdaAgOeR6Y+QCBW7usgUsKj7gJEfR7stw9U/fE49LBnj2tPRKPY0c0EBJSWe9Appmplg==", "dev": true, "license": "Apache-2.0", "dependencies": { "@gerrit0/mini-shiki": "^3.23.0", "lunr": "^2.3.9", - "markdown-it": "^14.1.1", + "markdown-it": "^14.3.0", "minimatch": "^10.2.5", - "yaml": "^2.8.3" + "yaml": "^2.9.0" }, "bin": { "typedoc": "bin/typedoc" @@ -15194,9 +15224,9 @@ "license": "ISC" }, "node_modules/yaml": { - "version": "2.8.3", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", - "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", + "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", "dev": true, "license": "ISC", "bin": { diff --git a/package.json b/package.json index f245085..7100443 100644 --- a/package.json +++ b/package.json @@ -51,32 +51,32 @@ "constructs": "^10.0.0", "dynamodb-onetable": "2.7.7", "eslint": "^9", - "eslint-import-resolver-typescript": "^4.4.4", + "eslint-import-resolver-typescript": "^4.4.5", "eslint-plugin-import": "^2.32.0", "jest": "^29.7.0", "jest-junit": "^16", "openapi-typescript": "7.13.0", "projen": "0.99.47", - "ts-jest": "^29.4.9", + "ts-jest": "^29.4.11", "ts-node": "^10.9.2", - "typedoc": "0.28.19", + "typedoc": "0.28.20", "typescript": "^5.9.3" }, "peerDependencies": { - "@aws-sdk/client-cognito-identity-provider": "^3.1014.0", - "@aws-sdk/client-dynamodb": "^3.1014.0", - "@aws-sdk/client-s3": "^3.1014.0", - "@aws-sdk/lib-dynamodb": "^3.1014.0", + "@aws-sdk/client-cognito-identity-provider": "^3.1085.0", + "@aws-sdk/client-dynamodb": "^3.1085.0", + "@aws-sdk/client-s3": "^3.1085.0", + "@aws-sdk/lib-dynamodb": "^3.1085.0", "aws-cdk-lib": ">=2.248.0 <3.0.0", "dynamodb-onetable": "2.7.7", "openapi-typescript": "^7.13.0", "projen": ">=0.99.47 <1.0.0" }, "dependencies": { - "@types/aws-lambda": "^8.10.161", + "@types/aws-lambda": "^8.10.162", "constructs": "^10.5.1", - "date-fns": "^4.1.0", - "js-yaml": "^4.1.1", + "date-fns": "^4.4.0", + "js-yaml": "^4.3.0", "jsonwebtoken": "^9.0.3", "jwk-to-pem": "^2.0.7", "lambda-log": "^3.1.0" From 067b06a04bcd424f535a960e4795c9eac9e65d2f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 13 Jul 2026 03:01:29 +0000 Subject: [PATCH 2/2] chore: self mutation Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/constructs/assets/highlight.css | 2 +- docs/constructs/assets/main.js | 2 +- docs/constructs/assets/style.css | 21 +- docs/constructs/classes/AssetCdn.html | 181 +- docs/constructs/classes/BaseApi.html | 166 +- .../classes/CognitoAuthentication.html | 210 +- docs/constructs/classes/GraphQlApi.html | 372 ++- docs/constructs/classes/LambdaFunction.html | 1156 ++++++- docs/constructs/classes/RestApi.html | 323 +- .../classes/SingleTableDatastore.html | 192 +- docs/constructs/classes/Workflow.html | 191 +- docs/constructs/hierarchy.html | 48 +- docs/constructs/index.html | 70 +- docs/constructs/interfaces/AssetCdnProps.html | 66 +- docs/constructs/interfaces/BaseApiProps.html | 161 +- .../CognitoAuthenticationProps.html | 155 +- .../interfaces/GraphQlApiProps.html | 186 +- .../interfaces/ICognitoAuthentication.html | 60 +- .../interfaces/IJwtAuthentication.html | 68 +- .../interfaces/ISingleTableDatastore.html | 60 +- .../interfaces/JsResolverOptions.html | 72 +- .../interfaces/LambdaFunctionProps.html | 144 +- .../interfaces/LambdaTracingOptions.html | 61 +- docs/constructs/interfaces/RestApiProps.html | 215 +- .../interfaces/SingleTableDatastoreProps.html | 86 +- .../interfaces/SingleTableDesign.html | 79 +- .../interfaces/VtlResolverOptions.html | 67 +- docs/constructs/interfaces/WorkflowProps.html | 65 +- docs/constructs/modules.html | 45 +- docs/constructs/types/LambdaOptions.html | 32 +- docs/lambda/assets/highlight.css | 2 +- docs/lambda/assets/main.js | 2 +- docs/lambda/assets/style.css | 21 +- .../auth.ApiGatewayv1CognitoAuthorizer.html | 269 +- .../auth.ApiGatewayv1JwtAuthorizer.html | 267 +- .../auth.ApiGatewayv2CognitoAuthorizer.html | 269 +- .../auth.ApiGatewayv2JwtAuthorizer.html | 266 +- .../auth.AppSyncCognitoAuthorizer.html | 263 +- .../classes/auth.CognitoAuthorizer.html | 255 +- docs/lambda/classes/auth.JwtAuthorizer.html | 245 +- .../classes/errors.BadRequestError.html | 158 +- .../lambda/classes/errors.ForbiddenError.html | 158 +- docs/lambda/classes/errors.HttpError.html | 166 +- docs/lambda/classes/errors.NotFoundError.html | 158 +- .../classes/errors.UnauthenticatedError.html | 158 +- .../functions/api.createAppSyncHandler.html | 53 +- .../functions/api.createHttpHandler.html | 50 +- .../functions/api.createOpenApiHandler.html | 50 +- ...i.createOpenApiHandlerWithRequestBody.html | 50 +- ...enApiHandlerWithRequestBodyNoResponse.html | 49 +- docs/lambda/hierarchy.html | 53 +- docs/lambda/index.html | 70 +- .../interfaces/api.AppSyncHandlerContext.html | 71 +- .../interfaces/api.HttpHandlerContext.html | 70 +- .../interfaces/api.HttpResponseContext.html | 64 +- docs/lambda/interfaces/api.Operation.html | 64 +- .../api.OperationWithRequestBody.html | 68 +- docs/lambda/modules.html | 37 +- docs/lambda/modules/api.html | 46 +- docs/lambda/modules/auth.html | 38 +- docs/lambda/modules/errors.html | 38 +- .../lambda/types/api.APIGatewayv1Handler.html | 36 +- docs/lambda/types/api.AppSyncHandler.html | 53 +- docs/lambda/types/api.HttpHandler.html | 54 +- docs/projen/assets/highlight.css | 2 +- docs/projen/assets/main.js | 2 +- docs/projen/assets/style.css | 21 +- docs/projen/classes/Datastore.html | 232 +- docs/projen/classes/GraphQlApi.html | 216 +- docs/projen/classes/RestApi.html | 325 +- docs/projen/classes/ServerlessProject.html | 1318 +++++++- docs/projen/classes/Workflow.html | 279 +- docs/projen/hierarchy.html | 30 +- docs/projen/index.html | 70 +- docs/projen/interfaces/DatastoreOptions.html | 56 +- docs/projen/interfaces/GraphQlApiOptions.html | 56 +- docs/projen/interfaces/RestApiOptions.html | 56 +- .../interfaces/ServerlessProjectOptions.html | 2786 +++++++++++++---- docs/projen/interfaces/WorkflowOptions.html | 56 +- docs/projen/modules.html | 45 +- docs/projen/variables/PACKAGE_NAME.html | 32 +- 81 files changed, 12238 insertions(+), 1571 deletions(-) diff --git a/docs/constructs/assets/highlight.css b/docs/constructs/assets/highlight.css index 72a5329..e12b856 100644 --- a/docs/constructs/assets/highlight.css +++ b/docs/constructs/assets/highlight.css @@ -89,4 +89,4 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } -pre, code { background: var(--code-background); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/constructs/assets/main.js b/docs/constructs/assets/main.js index 8182cee..b0eda9e 100644 --- a/docs/constructs/assets/main.js +++ b/docs/constructs/assets/main.js @@ -1,6 +1,6 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>{try{return e||t((e={exports:{}}).exports,e),e.exports}catch(n){throw e=0,n}};var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); diff --git a/docs/constructs/assets/style.css b/docs/constructs/assets/style.css index 44328e9..ec257d5 100644 --- a/docs/constructs/assets/style.css +++ b/docs/constructs/assets/style.css @@ -504,8 +504,15 @@ body { background: var(--color-background); font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -531,6 +538,14 @@ scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); } + math[display="block"] { + position: relative; + padding: 10px; + border: 1px solid var(--color-accent); + border-radius: 0.8em; + margin-bottom: 8px; + } + code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; @@ -1047,7 +1062,7 @@ cursor: pointer; } - .tsd-accordion-summary a { + .tsd-accordion-summary > a { width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { diff --git a/docs/constructs/classes/AssetCdn.html b/docs/constructs/classes/AssetCdn.html index 3d07a53..6c55708 100644 --- a/docs/constructs/classes/AssetCdn.html +++ b/docs/constructs/classes/AssetCdn.html @@ -1,31 +1,138 @@ -AssetCdn | cdk-serverless
cdk-serverless
    Preparing search index...

    Class AssetCdn

    The AssetCdn construct is responsible for setting up an S3 bucket for asset storage +AssetCdn | cdk-serverless

    +
    cdk-serverless + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Class AssetCdn

      +
      +

      The AssetCdn construct is responsible for setting up an S3 bucket for asset storage and a CloudFront distribution to serve the assets securely with HTTPS. It also configures a Route 53 DNS record to point to the CloudFront distribution.

      -

      Hierarchy

      • Construct
        • AssetCdn
      Index

      Constructors

      constructor -

      Properties

      assetBucket +
      +
      +

      Hierarchy

      +
        +
      • Construct +
          +
        • AssetCdn
      +
      +
      +
      +
      Index
       +
      +
      + +
      constructor +
      +
      + +
      assetBucket assetDomainName node zone -

      Methods

      toString +
      +
      + +
      toString with isConstruct -

      Constructors

      • Creates an instance of AssetCdn.

        -

        Parameters

        • scope: Construct

          The scope in which this construct is defined.

          -
        • id: string

          The scoped construct ID.

          -
        • props: AssetCdnProps

          The properties of the AssetCdn construct.

          -

        Returns AssetCdn

      Properties

      assetBucket: Bucket

      The S3 bucket used to store the assets.

      -
      assetDomainName: string

      The domain name used for accessing the assets.

      -
      node: Node

      The tree node.

      -
      zone: IHostedZone

      The Route 53 hosted zone for the asset domain.

      -

      Methods

      • Returns a string representation of this construct.

        -

        Returns string

      • Applies one or more mixins to this construct.

        +
      +
      + +
      +
      + +
        +
      • + +
        +

        Creates an instance of AssetCdn.

        +
        +
        +

        Parameters

        +
          +
        • scope: Construct +

          The scope in which this construct is defined.

          +
          • +
        • id: string +

          The scoped construct ID.

          +
          • +
        • props: AssetCdnProps +

          The properties of the AssetCdn construct.

          +
        +

        Returns AssetCdn

      +
      + +
      +
      + +
      assetBucket: Bucket
      +

      The S3 bucket used to store the assets.

      +
      +
      + +
      assetDomainName: string
      +

      The domain name used for accessing the assets.

      +
      +
      + +
      node: Node
      +

      The tree node.

      +
      +
      + +
      zone: IHostedZone
      +

      The Route 53 hosted zone for the asset domain.

      +
      +
      + +
      +
      + +
        +
      • + +
        +

        Returns a string representation of this construct.

        +
        +

        Returns string

      +
      + +
        +
      • + +
        +

        Applies one or more mixins to this construct.

        Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

        -

        Parameters

        • ...mixins: IMixin[]

          The mixins to apply

          -

        Returns IConstruct

        This construct for chaining

        -

      • Checks if x is a construct.

        +
        +
        +

        Parameters

        +
          +
        • ...mixins: IMixin[] +

          The mixins to apply

          +
        +

        Returns IConstruct

        This construct for chaining

        +
      +
      + +
        +
      • + +
        +

        Checks if x is a construct.

        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

        Explanation: in JavaScript, multiple copies of the constructs library on @@ -38,6 +145,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

        -

        Parameters

        • x: any

          Any object

          -

        Returns x is Construct

        true if x is an object created from a class which extends Construct.

        -

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      +
      +
      +

      Parameters

      +
        +
      • x: any +

        Any object

        +
      +

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

      +
      +
      +
      +
      +
      +

      Settings

       +
      +
      Member Visibility +
        +
        • +
        • +
      +
      +
      +

      On This Page

       +
      +
      Constructors +
      +
      Properties +
      +
      Methods +
      +
      +
      +
      diff --git a/docs/constructs/classes/BaseApi.html b/docs/constructs/classes/BaseApi.html index 2d37893..9922167 100644 --- a/docs/constructs/classes/BaseApi.html +++ b/docs/constructs/classes/BaseApi.html @@ -1,23 +1,129 @@ -BaseApi | cdk-serverless
      cdk-serverless
        Preparing search index...

        Class BaseApiAbstract

        Base class for different types of APIs

        -

        Hierarchy (View Summary)

        Index

        Constructors

        constructor -

        Properties

        apiDomainName? +BaseApi | cdk-serverless
        +
        cdk-serverless + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Class BaseApiAbstract

          +
          +

          Base class for different types of APIs

          +
          +
          +

          Hierarchy (View Summary)

          +
          +
          +
          +
          +
          Index
           +
          +
          + +
          constructor +
          +
          + +
          apiDomainName? apiFQDN? apiHostName? hostedZone? node -

          Methods

          toString +
          +
          + +
          toString with isConstruct -

          Constructors

          Properties

          apiDomainName?: string
          apiFQDN?: string
          apiHostName?: string
          hostedZone?: IHostedZone
          node: Node

          The tree node.

          -

          Methods

          • Returns a string representation of this construct.

            -

            Returns string

          • Applies one or more mixins to this construct.

            +
          +
          + +
          +
          + +
            +
          • + +
            +
            +

            Parameters

            +
            +

            Returns BaseApi

          +
          + +
          +
          + +
          apiDomainName?: string
          +
          + +
          apiFQDN?: string
          +
          + +
          apiHostName?: string
          +
          + +
          hostedZone?: IHostedZone
          +
          + +
          node: Node
          +

          The tree node.

          +
          +
          + +
          +
          + +
            +
          • + +
            +

            Returns a string representation of this construct.

            +
            +

            Returns string

          +
          + +
            +
          • + +
            +

            Applies one or more mixins to this construct.

            Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

            -

            Parameters

            • ...mixins: IMixin[]

              The mixins to apply

              -

            Returns IConstruct

            This construct for chaining

            -

          • Checks if x is a construct.

            +
            +
            +

            Parameters

            +
              +
            • ...mixins: IMixin[] +

              The mixins to apply

              +
            +

            Returns IConstruct

            This construct for chaining

            +
          +
          + +
            +
          • + +
            +

            Checks if x is a construct.

            Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

            Explanation: in JavaScript, multiple copies of the constructs library on @@ -30,6 +136,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

            -

            Parameters

            • x: any

              Any object

              -

            Returns x is Construct

            true if x is an object created from a class which extends Construct.

            -

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          + +
          +

          Parameters

          +
            +
          • x: any +

            Any object

            +
          +

          Returns x is Construct

          true if x is an object created from a class which extends Construct.

          + +
          +
          +
          +
          +

          Settings

           +
          +
          Member Visibility +
            +
            • +
            • +
          +
          +
          +

          On This Page

           +
          +
          Constructors +
          +
          Properties +
          +
          Methods +
          +
          +
          +
          diff --git a/docs/constructs/classes/CognitoAuthentication.html b/docs/constructs/classes/CognitoAuthentication.html index 62e396c..29cc88c 100644 --- a/docs/constructs/classes/CognitoAuthentication.html +++ b/docs/constructs/classes/CognitoAuthentication.html @@ -1,35 +1,167 @@ -CognitoAuthentication | cdk-serverless
          cdk-serverless
            Preparing search index...

            Class CognitoAuthentication

            The CognitoAuthentication construct sets up a Cognito User Pool with optional triggers and an optional Cognito Identity Pool. +CognitoAuthentication | cdk-serverless

            +
            cdk-serverless + +
              +
              +
              Preparing search index...
              +
              +
              +
              + +

              Class CognitoAuthentication

              +
              +

              The CognitoAuthentication construct sets up a Cognito User Pool with optional triggers and an optional Cognito Identity Pool. It also configures various Lambda triggers for custom message, pre-sign up, and pre-token generation events.

              -

              Hierarchy

              • Construct
                • CognitoAuthentication

              Implements

              Index

              Constructors

              constructor -

              Properties

              customMessageFunction? +
              +
              +

              Hierarchy

              +
                +
              • Construct +
                  +
                • CognitoAuthentication
              +
              +

              Implements

              +
              +
              +
              +
              +
              Index
               +
              +
              + +
              constructor +
              +
              + +
              customMessageFunction? identityPool? node preSignUpFunction? preTokenGenerationFunction? userpool -

              Methods

              addUserPoolClient +
              +
              + +
              addUserPoolClient toString with isConstruct -

              Constructors

              Properties

              customMessageFunction?: LambdaFunction

              The optional Lambda function for custom message trigger.

              -
              identityPool?: IdentityPool

              The optional Cognito Identity Pool for federated identities.

              -
              node: Node

              The tree node.

              -
              preSignUpFunction?: LambdaFunction

              The optional Lambda function for pre-sign up trigger.

              -
              preTokenGenerationFunction?: LambdaFunction

              The optional Lambda function for pre-token generation trigger.

              -
              userpool: UserPool

              The Cognito User Pool for user authentication.

              -

              Methods

              • Parameters

                • id: string
                • options: UserPoolClientOptions

                Returns UserPoolClient

              • Returns a string representation of this construct.

                -

                Returns string

              • Applies one or more mixins to this construct.

                +
              +
              + +
              +
              + +
                +
              • + +
                +

                Creates an instance of CognitoAuthentication.

                +
                +
                +

                Parameters

                +
                  +
                • scope: Construct +

                  The scope in which this construct is defined.

                  +
                  • +
                • id: string +

                  The scoped construct ID.

                  +
                  • +
                • props: CognitoAuthenticationProps +

                  The properties of the CognitoAuthentication construct.

                  +
                +

                Returns CognitoAuthentication

              +
              + +
              +
              + +
              customMessageFunction?: LambdaFunction
              +

              The optional Lambda function for custom message trigger.

              +
              +
              + +
              identityPool?: IdentityPool
              +

              The optional Cognito Identity Pool for federated identities.

              +
              +
              + +
              node: Node
              +

              The tree node.

              +
              +
              + +
              preSignUpFunction?: LambdaFunction
              +

              The optional Lambda function for pre-sign up trigger.

              +
              +
              + +
              preTokenGenerationFunction?: LambdaFunction
              +

              The optional Lambda function for pre-token generation trigger.

              +
              +
              + +
              userpool: UserPool
              +

              The Cognito User Pool for user authentication.

              +
              +
              + +
              +
              + +
                +
              • + +
                +
                +

                Parameters

                +
                  +
                • id: string
                  • +
                • options: UserPoolClientOptions
                +

                Returns UserPoolClient

              +
              + +
                +
              • + +
                +

                Returns a string representation of this construct.

                +
                +

                Returns string

              +
              + +
                +
              • + +
                +

                Applies one or more mixins to this construct.

                Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                -

                Parameters

                • ...mixins: IMixin[]

                  The mixins to apply

                  -

                Returns IConstruct

                This construct for chaining

                -

              • Checks if x is a construct.

                +
                +
                +

                Parameters

                +
                  +
                • ...mixins: IMixin[] +

                  The mixins to apply

                  +
                +

                Returns IConstruct

                This construct for chaining

                +
              +
              + +
                +
              • + +
                +

                Checks if x is a construct.

                Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                Explanation: in JavaScript, multiple copies of the constructs library on @@ -42,6 +174,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                -

                Parameters

                • x: any

                  Any object

                  -

                Returns x is Construct

                true if x is an object created from a class which extends Construct.

                -

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              +
              +
              +

              Parameters

              +
                +
              • x: any +

                Any object

                +
              +

              Returns x is Construct

              true if x is an object created from a class which extends Construct.

              +
              +
              +
              +
              +
              +

              Settings

               +
              +
              Member Visibility +
                +
                • +
                • +
              +
              +
              +

              On This Page

               +
              +
              Constructors +
              +
              Properties +
              +
              Methods +
              +
              +
              +
              diff --git a/docs/constructs/classes/GraphQlApi.html b/docs/constructs/classes/GraphQlApi.html index 6b5db62..66343fa 100644 --- a/docs/constructs/classes/GraphQlApi.html +++ b/docs/constructs/classes/GraphQlApi.html @@ -1,19 +1,60 @@ -GraphQlApi | cdk-serverless
              cdk-serverless
                Preparing search index...

                Class GraphQlApi<RESOLVERS>

                The GraphQlApi construct sets up an AWS AppSync GraphQL API integrated with Cognito for authentication and DynamoDB for data storage. +GraphQlApi | cdk-serverless

                +
                cdk-serverless + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  +
                  + +

                  Class GraphQlApi<RESOLVERS>

                  +
                  +

                  The GraphQlApi construct sets up an AWS AppSync GraphQL API integrated with Cognito for authentication and DynamoDB for data storage. This construct facilitates the creation of a GraphQL API with various configurations, including custom domain, logging, schema definition, and authorization using Cognito User Pool and Identity Pool. It also provides methods to dynamically add resolvers and grant access to specific fields.

                  -
                  const api = new GraphQlApi(this, 'MyGraphQlApi', {
                    apiName: 'MyAPI',
                    stageName: 'dev',
                    definitionFileName: 'schema.graphql',
                    authentication: myCognitoAuth,
                    singleTableDatastore: myDynamoDBTable,
                  });

                  // Add a Lambda resolver
                  api.addLambdaResolver('Query', 'getItem');

                  // Grant access to unauthenticated users for a specific query
                  api.grantAccessUnAuth('Query', 'getItem');
+
                  +
                  +
                  +
                  const api = new GraphQlApi(this, 'MyGraphQlApi', {
                    apiName: 'MyAPI',
                    stageName: 'dev',
                    definitionFileName: 'schema.graphql',
                    authentication: myCognitoAuth,
                    singleTableDatastore: myDynamoDBTable,
                  });

                  // Add a Lambda resolver
                  api.addLambdaResolver('Query', 'getItem');

                  // Grant access to unauthenticated users for a specific query
                  api.grantAccessUnAuth('Query', 'getItem');
                  -

                  Type Parameters

                  • RESOLVERS

                    The type definition for the GraphQL resolvers.

                    -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor -

                  Properties

                  api +
                  +
                  +

                  Type Parameters

                  +
                    +
                  • RESOLVERS +

                    The type definition for the GraphQL resolvers.

                    +
                  +
                  +

                  Hierarchy (View Summary)

                  +
                  +
                  +
                  +
                  +
                  Index
                   +
                  +
                  + +
                  constructor +
                  +
                  + +
                  api apiDomainName? apiFQDN? apiHostName? hostedZone? node tableDataSource? -

                  Methods

                  addDynamoDbJSResolver +
                  +
                  + +
                  addDynamoDbJSResolver addDynamoDbVtlResolver addJSResolver addLambdaResolver @@ -25,24 +66,275 @@ toString with isConstruct -

                  Constructors

                  Properties

                  api: GraphqlApi

                  The AWS AppSync GraphQL API instance.

                  -
                  apiDomainName?: string
                  apiFQDN?: string
                  apiHostName?: string
                  hostedZone?: IHostedZone
                  node: Node

                  The tree node.

                  -
                  tableDataSource?: DynamoDbDataSource

                  The optional DynamoDB data source for the GraphQL API.

                  -

                  Methods

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns void

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns void

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns void

                  • getFunctionForOperation

                    -

                    Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns LambdaFunction

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    • grantee: IGrantable
                    • typeName: TYPE
                    • ...fieldNames: (keyof FIELDTYPE)[]

                    Returns void

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns void

                  • Type Parameters

                    • TYPE extends string | number | symbol
                    • FIELDTYPE extends {}

                    Parameters

                    Returns void

                  • Returns a string representation of this construct.

                    -

                    Returns string

                  • Applies one or more mixins to this construct.

                    +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    Creates an instance of GraphQlApi.

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • RESOLVERS +

                      The type definition for the GraphQL resolvers.

                      +
                    +
                    +

                    Parameters

                    +
                      +
                    • scope: Construct +

                      The scope in which this construct is defined.

                      +
                      • +
                    • id: string +

                      The scoped construct ID.

                      +
                      • +
                    • props: GraphQlApiProps +

                      The properties of the GraphQlApi construct.

                      +
                    +

                    Returns GraphQlApi<RESOLVERS>

                  +
                  + +
                  +
                  + +
                  api: GraphqlApi
                  +

                  The AWS AppSync GraphQL API instance.

                  +
                  +
                  + +
                  apiDomainName?: string
                  +
                  + +
                  apiFQDN?: string
                  +
                  + +
                  apiHostName?: string
                  +
                  + +
                  hostedZone?: IHostedZone
                  +
                  + +
                  node: Node
                  +

                  The tree node.

                  +
                  +
                  + +
                  tableDataSource?: DynamoDbDataSource
                  +

                  The optional DynamoDB data source for the GraphQL API.

                  +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns void

                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +

                    getFunctionForOperation

                    +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns LambdaFunction

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                      +
                    • grantee: IGrantable
                      • +
                    • typeName: TYPE
                      • +
                    • ...fieldNames: (keyof FIELDTYPE)[]
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Type Parameters

                    +
                      +
                    • TYPE extends string | number | symbol
                      • +
                    • FIELDTYPE extends {}
                    +
                    +

                    Parameters

                    +
                    +

                    Returns void

                  +
                  + +
                    +
                  • + +
                    +

                    Returns a string representation of this construct.

                    +
                    +

                    Returns string

                  +
                  + +
                    +
                  • + +
                    +

                    Applies one or more mixins to this construct.

                    Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                    -

                    Parameters

                    • ...mixins: IMixin[]

                      The mixins to apply

                      -

                    Returns IConstruct

                    This construct for chaining

                    -

                  • Checks if x is a construct.

                    +
                    +
                    +

                    Parameters

                    +
                      +
                    • ...mixins: IMixin[] +

                      The mixins to apply

                      +
                    +

                    Returns IConstruct

                    This construct for chaining

                    +
                  +
                  + +
                    +
                  • + +
                    +

                    Checks if x is a construct.

                    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                    Explanation: in JavaScript, multiple copies of the constructs library on @@ -55,6 +347,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                    -

                    Parameters

                    • x: any

                      Any object

                      -

                    Returns x is Construct

                    true if x is an object created from a class which extends Construct.

                    -

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  + +
                  +

                  Parameters

                  +
                    +
                  • x: any +

                    Any object

                    +
                  +

                  Returns x is Construct

                  true if x is an object created from a class which extends Construct.

                  + +
                  +
                  +
                  +
                  +

                  Settings

                   +
                  +
                  Member Visibility +
                    +
                    • +
                    • +
                  +
                  +
                  +

                  On This Page

                   +
                  +
                  Constructors +
                  +
                  Properties +
                  +
                  Methods +
                  +
                  +
                  +
                  diff --git a/docs/constructs/classes/LambdaFunction.html b/docs/constructs/classes/LambdaFunction.html index af3b3a4..e87b8ed 100644 --- a/docs/constructs/classes/LambdaFunction.html +++ b/docs/constructs/classes/LambdaFunction.html @@ -1,12 +1,45 @@ -LambdaFunction | cdk-serverless
                  cdk-serverless
                    Preparing search index...

                    Class LambdaFunction

                    The LambdaFunction construct extends the AWS CDK NodejsFunction to provide additional configurations and environment settings for AWS Lambda functions. +LambdaFunction | cdk-serverless

                    +
                    cdk-serverless + +
                      +
                      +
                      Preparing search index...
                      +
                      +
                      +
                      + +

                      Class LambdaFunction

                      +
                      +

                      The LambdaFunction construct extends the AWS CDK NodejsFunction to provide additional configurations and environment settings for AWS Lambda functions. This construct facilitates setting up a Lambda function with various custom options, environment variables, and permissions required to interact with AWS services such as DynamoDB, Cognito, and S3. It supports setting up Lambda functions with pre-defined bundles, custom handlers, and integrations with AWS services. The construct also provides methods to dynamically update the configuration and permissions of the Lambda function after it has been created.

                      -
                      const lambdaFunction = new LambdaFunction(this, 'MyLambdaFunction', {
                        entry: 'path/to/lambda/handler.ts',
                        handler: 'main',
                        stageName: 'dev',
                        table: myDynamoDBTable,
                        userPool: myCognitoUserPool,
                        assetBucket: myS3Bucket,
                        lambdaOptions: {
                          timeout: Duration.seconds(30),
                          memorySize: 512,
                        },
                      });

                      // Add additional permissions
                      lambdaFunction.grantSendEmails();
                      lambdaFunction.grantTableWrite();
+
                      +
                      +
                      +
                      const lambdaFunction = new LambdaFunction(this, 'MyLambdaFunction', {
                        entry: 'path/to/lambda/handler.ts',
                        handler: 'main',
                        stageName: 'dev',
                        table: myDynamoDBTable,
                        userPool: myCognitoUserPool,
                        assetBucket: myS3Bucket,
                        lambdaOptions: {
                          timeout: Duration.seconds(30),
                          memorySize: 512,
                        },
                      });

                      // Add additional permissions
                      lambdaFunction.grantSendEmails();
                      lambdaFunction.grantTableWrite();
                      -

                      Hierarchy

                      • NodejsFunction
                        • LambdaFunction
                      Index

                      Constructors

                      constructor -

                      Properties

                      architecture +
                      +
                      +

                      Hierarchy

                      +
                        +
                      • NodejsFunction +
                          +
                        • LambdaFunction
                      +
                      +
                      +
                      +
                      Index
                       +
                      +
                      + +
                      constructor +
                      +
                      + +
                      architecture canCreatePermissions deadLetterQueue? deadLetterTopic? @@ -18,7 +51,10 @@ tenancyConfig? timeout? PROPERTY_INJECTION_ID -

                      Accessors

                      connections +
                      +
                      + +
                      connections currentVersion env functionArn @@ -30,7 +66,10 @@ physicalName resourceArnsForGrantInvoke stack -

                      Methods

                      addAlias +
                      +
                      + +
                      addAlias addEnvironment addEventSource addEventSourceMapping @@ -82,56 +121,231 @@ metricAllInvocations metricAllThrottles metricAllUnreservedConcurrentExecutions -

                      Constructors

                      • Creates an instance of LambdaFunction.

                        -

                        Parameters

                        • scope: Construct

                          The scope in which this construct is defined.

                          -
                        • id: string

                          The scoped construct ID.

                          -
                        • props: LambdaFunctionProps

                          The properties of the LambdaFunction construct.

                          -

                        Returns LambdaFunction

                      Properties

                      architecture: Architecture

                      The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

                      -
                      canCreatePermissions: true

                      Whether the addPermission() call adds any permissions

                      +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Creates an instance of LambdaFunction.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct +

                          The scope in which this construct is defined.

                          +
                          • +
                        • id: string +

                          The scoped construct ID.

                          +
                          • +
                        • props: LambdaFunctionProps +

                          The properties of the LambdaFunction construct.

                          +
                        +

                        Returns LambdaFunction

                      +
                      + +
                      +
                      + +
                      architecture: Architecture
                      +

                      The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

                      +
                      +
                      + +
                      canCreatePermissions: true
                      +

                      Whether the addPermission() call adds any permissions

                      True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

                      -
                      deadLetterQueue?: IQueue

                      The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

                      -
                      deadLetterTopic?: ITopic

                      The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

                      -
                      grantPrincipal: IPrincipal

                      The principal this Lambda Function is running as

                      -
                      node: Node

                      The tree node.

                      -
                      permissionsNode: Node

                      The construct node where permissions are attached.

                      -
                      role?: IRole

                      Execution role associated with this function

                      -
                      runtime: Runtime

                      The runtime configured for this lambda.

                      -
                      tenancyConfig?: TenancyConfig

                      The tenancy configuration for this function.

                      -
                      timeout?: Duration

                      The timeout configured for this lambda.

                      -
                      PROPERTY_INJECTION_ID: string

                      Uniquely identifies this class.

                      -

                      Accessors

                      • get connections(): Connections

                        Access the Connections object

                        +
                      +
                      + +
                      deadLetterQueue?: IQueue
                      +

                      The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

                      +
                      +
                      + +
                      deadLetterTopic?: ITopic
                      +

                      The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

                      +
                      +
                      + +
                      grantPrincipal: IPrincipal
                      +

                      The principal this Lambda Function is running as

                      +
                      +
                      + +
                      node: Node
                      +

                      The tree node.

                      +
                      +
                      + +
                      permissionsNode: Node
                      +

                      The construct node where permissions are attached.

                      +
                      +
                      + +
                      role?: IRole
                      +

                      Execution role associated with this function

                      +
                      +
                      + +
                      runtime: Runtime
                      +

                      The runtime configured for this lambda.

                      +
                      +
                      + +
                      tenancyConfig?: TenancyConfig
                      +

                      The tenancy configuration for this function.

                      +
                      +
                      + +
                      timeout?: Duration
                      +

                      The timeout configured for this lambda.

                      +
                      +
                      + +
                      PROPERTY_INJECTION_ID: string
                      +

                      Uniquely identifies this class.

                      +
                      +
                      + +
                      +
                      + +
                        +
                      • +
                        get connections(): Connections
                        +
                        +

                        Access the Connections object

                        Will fail if not a VPC-enabled Lambda Function

                        -

                        Returns Connections

                      • get currentVersion(): Version

                        Returns a lambda.Version which represents the current version of this +

                        +

                        Returns Connections

                      +
                      + +
                        +
                      • +
                        get currentVersion(): Version
                        +
                        +

                        Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes.

                        You can specify options for this version using the currentVersionOptions prop when initializing the lambda.Function.

                        -

                        Returns Version

                      • get env(): ResourceEnvironment

                        The environment this resource belongs to.

                        +
                        +

                        Returns Version

                      +
                      + +
                        +
                      • +
                        get env(): ResourceEnvironment
                        +
                        +

                        The environment this resource belongs to.

                        For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

                        For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

                        -

                        Returns ResourceEnvironment

                      • get functionArn(): string

                        ARN of this function

                        -

                        Returns string

                      • get functionName(): string

                        Name of this function

                        -

                        Returns string

                      • get functionRef(): FunctionReference

                        A reference to a Function resource.

                        -

                        Returns FunctionReference

                      • get isBoundToVpc(): boolean

                        Whether or not this Lambda function was bound to a VPC

                        +
                        +

                        Returns ResourceEnvironment

                      +
                      + +
                        +
                      • +
                        get functionArn(): string
                        +
                        +

                        ARN of this function

                        +
                        +

                        Returns string

                      +
                      + +
                        +
                      • +
                        get functionName(): string
                        +
                        +

                        Name of this function

                        +
                        +

                        Returns string

                      +
                      + +
                        +
                      • +
                        get functionRef(): FunctionReference
                        +
                        +

                        A reference to a Function resource.

                        +
                        +

                        Returns FunctionReference

                      +
                      + +
                        +
                      • +
                        get isBoundToVpc(): boolean
                        +
                        +

                        Whether or not this Lambda function was bound to a VPC

                        If this is is false, trying to access the connections object will fail.

                        -

                        Returns boolean

                      • get latestVersion(): IVersion

                        The $LATEST version of this function.

                        +
                        +

                        Returns boolean

                      +
                      + +
                        +
                      • +
                        get latestVersion(): IVersion
                        +
                        +

                        The $LATEST version of this function.

                        Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.

                        To obtain a reference to an explicit version which references the current function configuration, use lambdaFunction.currentVersion instead.

                        -

                        Returns IVersion

                      • get logGroup(): ILogGroup

                        The LogGroup where the Lambda function's logs are made available.

                        +
                        +

                        Returns IVersion

                      +
                      + +
                        +
                      • +
                        get logGroup(): ILogGroup
                        +
                        +

                        The LogGroup where the Lambda function's logs are made available.

                        If either logRetention is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default).

                        Further, if the log group already exists and the logRetention is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value.

                        -

                        Returns ILogGroup

                      • get physicalName(): string

                        Returns a string-encoded token that resolves to the physical name that +

                        +

                        Returns ILogGroup

                      +
                      + +
                        +
                      • +
                        get physicalName(): string
                        +
                        +

                        Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

                        This value will resolve to one of the following:

                          @@ -140,85 +354,433 @@
                        • a concrete name generated automatically during synthesis, in cross-environment scenarios.
                        -

                        Returns string

                      • get resourceArnsForGrantInvoke(): string[]

                        The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()

                        -

                        Returns string[]

                      • get stack(): Stack

                        The stack in which this resource is defined.

                        -

                        Returns Stack

                      Methods

                      • Defines an alias for this function.

                        +
                        +

                        Returns string

                      +
                      + +
                        +
                      • +
                        get resourceArnsForGrantInvoke(): string[]
                        +
                        +

                        The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()

                        +
                        +

                        Returns string[]

                      +
                      + +
                        +
                      • +
                        get stack(): Stack
                        +
                        +

                        The stack in which this resource is defined.

                        +
                        +

                        Returns Stack

                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Defines an alias for this function.

                        The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment.

                        declare const fn: lambda.Function;

                        fn.addAlias('Live');

                        // Is equivalent to

                        new lambda.Alias(this, 'AliasLive', {
                          aliasName: 'Live',
                          version: fn.currentVersion,
                        });
                        -

                        Parameters

                        • aliasName: string

                          The name of the alias

                          -
                        • Optionaloptions: AliasOptions

                          Alias options

                          -

                        Returns Alias

                      • Adds an environment variable to this Lambda function. +

                        +
                        +

                        Parameters

                        +
                          +
                        • aliasName: string +

                          The name of the alias

                          +
                          • +
                        • Optionaloptions: AliasOptions +

                          Alias options

                          +
                        +

                        Returns Alias

                      +
                      + +
                        +
                      • + +
                        +

                        Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

                        -

                        Parameters

                        • key: string

                          The environment variable key.

                          -
                        • value: string

                          The environment variable's value.

                          -
                        • Optionaloptions: EnvironmentOptions

                          Environment variable options.

                          -

                        Returns this

                      • Adds an event source to this function.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • key: string +

                          The environment variable key.

                          +
                          • +
                        • value: string +

                          The environment variable's value.

                          +
                          • +
                        • Optionaloptions: EnvironmentOptions +

                          Environment variable options.

                          +
                        +

                        Returns this

                      +
                      + +
                        +
                      • + +
                        +

                        Adds an event source to this function.

                        Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.

                        The following example adds an SQS Queue as an event source:

                        import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
                        myFunction.addEventSource(new SqsEventSource(myQueue));
                        -

                        Parameters

                        • source: IEventSource

                        Returns void

                      • Adds an event source that maps to this AWS Lambda function.

                        -

                        Parameters

                        • id: string

                          construct ID

                          -
                        • options: EventSourceMappingOptions

                          mapping options

                          -

                        Returns EventSourceMapping

                      • Adds a url to this lambda function.

                        -

                        Parameters

                        • Optionaloptions: FunctionUrlOptions

                        Returns FunctionUrl

                      • Adds one or more Lambda Layers to this Lambda function.

                        -

                        Parameters

                        • ...layers: ILayerVersion[]

                          the layers to be added.

                          -

                        Returns void

                        if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

                        -

                      • Adds a permission to the Lambda resource policy.

                        -

                        Parameters

                        • id: string

                          The id for the permission construct

                          -
                        • permission: Permission

                          The permission to grant to this Lambda function.

                          -

                        Returns void

                        Permission for details.

                        -

                      • Adds a statement to the IAM role assumed by the instance.

                        -

                        Parameters

                        • statement: PolicyStatement

                        Returns void

                      • Apply the given removal policy to this resource

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • source: IEventSource
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Adds an event source that maps to this AWS Lambda function.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • id: string +

                          construct ID

                          +
                          • +
                        • options: EventSourceMappingOptions +

                          mapping options

                          +
                        +

                        Returns EventSourceMapping

                      +
                      + +
                        +
                      • + +
                        +

                        Adds a url to this lambda function.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionaloptions: FunctionUrlOptions
                        +

                        Returns FunctionUrl

                      +
                      + +
                        +
                      • + +
                        +

                        Adds one or more Lambda Layers to this Lambda function.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • ...layers: ILayerVersion[] +

                          the layers to be added.

                          +
                        +

                        Returns void

                        +
                        +
                        +

                        if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

                        +
                      +
                      + +
                        +
                      • + +
                        +

                        Adds a permission to the Lambda resource policy.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • id: string +

                          The id for the permission construct

                          +
                          • +
                        • permission: Permission +

                          The permission to grant to this Lambda function.

                          +
                        +

                        Returns void

                        +
                        +
                        +

                        Permission for details.

                        +
                      +
                      + +
                        +
                      • + +
                        +

                        Adds a statement to the IAM role assumed by the instance.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • statement: PolicyStatement
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Apply the given removal policy to this resource

                        The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

                        The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

                        -

                        Parameters

                        • policy: RemovalPolicy

                        Returns void

                      • Configures options for asynchronous invocation.

                        -

                        Parameters

                        • options: EventInvokeConfigOptions

                        Returns void

                      • A warning will be added to functions under the following conditions:

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • policy: RemovalPolicy
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Configures options for asynchronous invocation.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • options: EventInvokeConfigOptions
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        A warning will be added to functions under the following conditions:

                        • permissions that include lambda:InvokeFunction are added to the unqualified function.
                        • function.currentVersion is invoked before or after the permission is created.

                        This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

                        -

                        Parameters

                        • scope: Construct
                        • action: string

                        Returns void

                      • Returns string

                      • Returns an environment-sensitive token that should be used for the +

                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct
                          • +
                        • action: string
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Returns string

                      +
                      + +
                        +
                      • + +
                        +

                        Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

                        Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

                        -

                        Parameters

                        • arnAttr: string

                          The CFN attribute which resolves to the ARN of the resource. +

                          +
                          +

                          Parameters

                          +
                            +
                          • arnAttr: string +

                            The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

                            -
                          • arnComponents: ArnComponents

                            The format of the ARN of this resource. You must +

                            • +
                          • arnComponents: ArnComponents +

                            The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

                            -

                          Returns string

                      • Returns an environment-sensitive token that should be used for the +

                      +

                      Returns string

                      +
                      + +
                        +
                      • + +
                        +

                        Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

                        Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

                        -

                        Parameters

                        • nameAttr: string

                          The CFN attribute which resolves to the resource's name. +

                          +
                          +

                          Parameters

                          +
                            +
                          • nameAttr: string +

                            The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

                            -

                          Returns string

                      • Grant the given identity permissions to invoke this Lambda

                        +
                      +

                      Returns string

                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Grant the given identity permissions to invoke this Lambda

                        [disable-awslint:no-grants]

                        -

                        Parameters

                        • grantee: IGrantable

                        Returns Grant

                      • Grant multiple principals the ability to invoke this Lambda via CompositePrincipal

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • grantee: IGrantable
                        +

                        Returns Grant

                      +
                      + +
                        +
                      • + +
                        +

                        Grant multiple principals the ability to invoke this Lambda via CompositePrincipal

                        [disable-awslint:no-grants]

                        -

                        Parameters

                        • compositePrincipal: CompositePrincipal

                        Returns Grant[]

                      • Grant the given identity permissions to invoke the $LATEST version or +

                        +
                        +

                        Parameters

                        +
                          +
                        • compositePrincipal: CompositePrincipal
                        +

                        Returns Grant[]

                      +
                      + +
                        +
                      • + +
                        +

                        Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda

                        [disable-awslint:no-grants]

                        -

                        Parameters

                        • grantee: IGrantable

                        Returns Grant

                      • Grant the given identity permissions to invoke this Lambda Function URL

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • grantee: IGrantable
                        +

                        Returns Grant

                      +
                      + +
                        +
                      • + +
                        +

                        Grant the given identity permissions to invoke this Lambda Function URL

                        [disable-awslint:no-grants]

                        -

                        Parameters

                        • grantee: IGrantable

                        Returns Grant

                      • Grant the given identity permissions to invoke the given version of this Lambda

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • grantee: IGrantable
                        +

                        Returns Grant

                      +
                      + +
                        +
                      • + +
                        +

                        Grant the given identity permissions to invoke the given version of this Lambda

                        [disable-awslint:no-grants]

                        -

                        Parameters

                        • grantee: IGrantable
                        • version: IVersion

                        Returns Grant

                      • Mix additional information into the hash of the Version object

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • grantee: IGrantable
                          • +
                        • version: IVersion
                        +

                        Returns Grant

                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Mix additional information into the hash of the Version object

                        The Lambda Function construct does its best to automatically create a new Version when anything about the Function changes (its code, its layers, any of the other properties).

                        @@ -230,40 +792,252 @@ any string into this method, and make sure the string changes when you know a new Version needs to be created.

                        This method may be called more than once.

                        -

                        Parameters

                        • x: string

                        Returns void

                      • Return the given named metric for this Function

                        -

                        Parameters

                        • metricName: string
                        • Optionalprops: MetricOptions

                        Returns Metric

                      • How long execution of this Lambda takes

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • x: string
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Return the given named metric for this Function

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • metricName: string
                          • +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +

                        How long execution of this Lambda takes

                        Average over 5 minutes

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                      • How many invocations of this Lambda fail

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +

                        How many invocations of this Lambda fail

                        Sum over 5 minutes

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                      • How often this Lambda is invoked

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +

                        How often this Lambda is invoked

                        Sum over 5 minutes

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                      • How often this Lambda is throttled

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +

                        How often this Lambda is throttled

                        Sum over 5 minutes

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                      • Returns a string representation of this construct.

                        -

                        Returns string

                      • Parameters

                        • scope: Construct

                        Returns void

                      • Applies one or more mixins to this construct.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • table: ITable
                          • +
                        • OptionaltableWrites: boolean
                        +

                        Returns LambdaFunction

                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Returns a string representation of this construct.

                        +
                        +

                        Returns string

                      +
                      + +
                        +
                      • + +
                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Applies one or more mixins to this construct.

                        Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                        -

                        Parameters

                        • ...mixins: IMixin[]

                          The mixins to apply

                          -

                        Returns IConstruct

                        This construct for chaining

                        -

                      • Record whether specific properties in the AWS::Lambda::Function resource should +

                        +
                        +

                        Parameters

                        +
                          +
                        • ...mixins: IMixin[] +

                          The mixins to apply

                          +
                        +

                        Returns IConstruct

                        This construct for chaining

                        +
                      +
                      + +
                        +
                      • + +
                        +

                        Record whether specific properties in the AWS::Lambda::Function resource should also be associated to the Version resource. See 'currentVersion' section in the module README for more details.

                        -

                        Parameters

                        • propertyName: string

                          The property to classify

                          -
                        • locked: boolean

                          whether the property should be associated to the version or not.

                          -

                        Returns void

                      • Import a lambda function into the CDK using its ARN.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • propertyName: string +

                          The property to classify

                          +
                          • +
                        • locked: boolean +

                          whether the property should be associated to the version or not.

                          +
                        +

                        Returns void

                      +
                      + +
                        +
                      • + +
                        +

                        Import a lambda function into the CDK using its ARN.

                        For Function.addPermissions() to work on this imported lambda, make sure that is in the same account and region as the stack you are importing it into.

                        -

                        Parameters

                        • scope: Construct
                        • id: string
                        • functionArn: string

                        Returns IFunction

                      • Creates a Lambda function object which represents a function not defined +

                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct
                          • +
                        • id: string
                          • +
                        • functionArn: string
                        +

                        Returns IFunction

                      +
                      + +
                        +
                      • + +
                        +

                        Creates a Lambda function object which represents a function not defined within this stack.

                        For Function.addPermissions() to work on this imported lambda, set the sameEnvironment property to true if this imported lambda is in the same account and region as the stack you are importing it into.

                        -

                        Parameters

                        • scope: Construct

                          The parent construct

                          -
                        • id: string

                          The name of the lambda construct

                          -
                        • attrs: FunctionAttributes

                          the attributes of the function to import

                          -

                        Returns IFunction

                      • Import a lambda function into the CDK using its name

                        -

                        Parameters

                        • scope: Construct
                        • id: string
                        • functionName: string

                        Returns IFunction

                      • Checks if x is a construct.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct +

                          The parent construct

                          +
                          • +
                        • id: string +

                          The name of the lambda construct

                          +
                          • +
                        • attrs: FunctionAttributes +

                          the attributes of the function to import

                          +
                        +

                        Returns IFunction

                      +
                      + +
                        +
                      • + +
                        +

                        Import a lambda function into the CDK using its name

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • scope: Construct
                          • +
                        • id: string
                          • +
                        • functionName: string
                        +

                        Returns IFunction

                      +
                      + +
                        +
                      • + +
                        +

                        Checks if x is a construct.

                        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                        Explanation: in JavaScript, multiple copies of the constructs library on @@ -276,33 +1050,205 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                        -

                        Parameters

                        • x: any

                          Any object

                          -

                        Returns x is Construct

                        true if x is an object created from a class which extends Construct.

                        -

                      • Returns true if the construct was created by CDK, and false otherwise

                        -

                        Parameters

                        • construct: IConstruct

                        Returns boolean

                      • Check whether the given construct is a Resource

                        -

                        Parameters

                        • construct: IConstruct

                        Returns construct is Resource

                      • Return the given named metric for this Lambda

                        -

                        Parameters

                        • metricName: string
                        • Optionalprops: MetricOptions

                        Returns Metric

                      • Metric for the number of concurrent executions across all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        max over 5 minutes
+
                        +
                        +

                        Parameters

                        +
                          +
                        • x: any +

                          Any object

                          +
                        +

                        Returns x is Construct

                        true if x is an object created from a class which extends Construct.

                        +
                      +
                      + +
                        +
                      • + +
                        +

                        Returns true if the construct was created by CDK, and false otherwise

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • construct: IConstruct
                        +

                        Returns boolean

                      +
                      + +
                        +
                      • + +
                        +

                        Check whether the given construct is a Resource

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • construct: IConstruct
                        +

                        Returns construct is Resource

                      +
                      + +
                        +
                      • + +
                        +

                        Return the given named metric for this Lambda

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • metricName: string
                          • +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the number of concurrent executions across all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        max over 5 minutes
                        -

                      • Metric for the Duration executing all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        average over 5 minutes
+
                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the Duration executing all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        average over 5 minutes
                        -

                      • Metric for the number of Errors executing all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        sum over 5 minutes
+
                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the number of Errors executing all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        sum over 5 minutes
                        -

                      • Metric for the number of invocations of all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        sum over 5 minutes
+
                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the number of invocations of all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        sum over 5 minutes
                        -

                      • Metric for the number of throttled invocations of all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        sum over 5 minutes
+
                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the number of throttled invocations of all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        sum over 5 minutes
                        -

                      • Metric for the number of unreserved concurrent executions across all Lambdas

                        -

                        Parameters

                        • Optionalprops: MetricOptions

                        Returns Metric

                        max over 5 minutes
+
                      +
                      + +
                        +
                      • + +
                        +

                        Metric for the number of unreserved concurrent executions across all Lambdas

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • Optionalprops: MetricOptions
                        +

                        Returns Metric

                        +
                        +
                        +
                        max over 5 minutes
                        -

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      Accessors
                      Methods
                      addAliasaddEnvironmentaddEventSourceaddEventSourceMappingaddFunctionUrladdLayersaddPermissionaddToRolePolicyapplyRemovalPolicyconfigureAsyncInvokeconsiderWarningOnInvokeFunctionPermissionsgeneratePhysicalNamegetResourceArnAttributegetResourceNameAttributegrantDeleteAssetgrantInvokegrantInvokeCompositePrincipalgrantInvokeLatestVersiongrantInvokeUrlgrantInvokeVersiongrantReadAssetsgrantSendEmailsgrantTableWritegrantUploadAssetsgrantUserpoolReadgrantUserpoolReadWriteinvalidateVersionBasedOnmetricmetricDurationmetricErrorsmetricInvocationsmetricThrottlessetTablesetTimeoutsetUserPooltoStringwarnInvokeFunctionPermissionswithclassifyVersionPropertyfromFunctionArnfromFunctionAttributesfromFunctionNameisConstructisOwnedResourceisResourcemetricAllmetricAllConcurrentExecutionsmetricAllDurationmetricAllErrorsmetricAllInvocationsmetricAllThrottlesmetricAllUnreservedConcurrentExecutions
                      + +
                      +
                      +
                      +
                      +

                      Settings

                       +
                      +
                      Member Visibility +
                        +
                        • +
                        • +
                      +
                      +
                      +

                      On This Page

                       +
                      +
                      Constructors +
                      +
                      Properties +
                      +
                      Accessors +
                      +
                      Methods +
                      addAliasaddEnvironmentaddEventSourceaddEventSourceMappingaddFunctionUrladdLayersaddPermissionaddToRolePolicyapplyRemovalPolicyconfigureAsyncInvokeconsiderWarningOnInvokeFunctionPermissionsgeneratePhysicalNamegetResourceArnAttributegetResourceNameAttributegrantDeleteAssetgrantInvokegrantInvokeCompositePrincipalgrantInvokeLatestVersiongrantInvokeUrlgrantInvokeVersiongrantReadAssetsgrantSendEmailsgrantTableWritegrantUploadAssetsgrantUserpoolReadgrantUserpoolReadWriteinvalidateVersionBasedOnmetricmetricDurationmetricErrorsmetricInvocationsmetricThrottlessetTablesetTimeoutsetUserPooltoStringwarnInvokeFunctionPermissionswithclassifyVersionPropertyfromFunctionArnfromFunctionAttributesfromFunctionNameisConstructisOwnedResourceisResourcemetricAllmetricAllConcurrentExecutionsmetricAllDurationmetricAllErrorsmetricAllInvocationsmetricAllThrottlesmetricAllUnreservedConcurrentExecutions
                      +
                      +
                      +
                      diff --git a/docs/constructs/classes/RestApi.html b/docs/constructs/classes/RestApi.html index 2d22555..a3096f1 100644 --- a/docs/constructs/classes/RestApi.html +++ b/docs/constructs/classes/RestApi.html @@ -1,20 +1,63 @@ -RestApi | cdk-serverless
                      cdk-serverless
                        Preparing search index...

                        Class RestApi<PATHS, OPS>

                        The RestApi construct sets up an AWS API Gateway REST API using OpenAPI specification. +RestApi | cdk-serverless

                        +
                        cdk-serverless + +
                          +
                          +
                          Preparing search index...
                          +
                          +
                          +
                          + +

                          Class RestApi<PATHS, OPS>

                          +
                          +

                          The RestApi construct sets up an AWS API Gateway REST API using OpenAPI specification. This construct facilitates the creation of a REST API with various configurations, including custom domain, CORS support, and integration with Lambda functions. It allows auto-generating routes based on the provided OpenAPI definition and provides methods to dynamically add custom routes and manage Lambda function integrations.

                          -
                          const api = new RestApi(this, 'MyRestApi', {
                            apiName: 'MyAPI',
                            stageName: 'dev',
                            definitionFileName: 'openapi.yaml',
                            authentication: myCognitoAuth,
                            singleTableDatastore: myDynamoDBTable,
                            autoGenerateRoutes: true,
                          });

                          // Add a custom REST resource
                          api.addRestResource('/items', 'get');

                          // Get the Lambda function for a specific operation
                          const lambdaFunction = api.getFunctionForOperation('getItems');
+
                          +
                          +
                          +
                          const api = new RestApi(this, 'MyRestApi', {
                            apiName: 'MyAPI',
                            stageName: 'dev',
                            definitionFileName: 'openapi.yaml',
                            authentication: myCognitoAuth,
                            singleTableDatastore: myDynamoDBTable,
                            autoGenerateRoutes: true,
                          });

                          // Add a custom REST resource
                          api.addRestResource('/items', 'get');

                          // Get the Lambda function for a specific operation
                          const lambdaFunction = api.getFunctionForOperation('getItems');
                          -

                          Type Parameters

                          • PATHS

                            The type definition for the API paths.

                            -
                          • OPS

                            The type definition for the API operations.

                            -

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor -

                          Properties

                          api +
                          +
                          +

                          Type Parameters

                          +
                            +
                          • PATHS +

                            The type definition for the API paths.

                            +
                            • +
                          • OPS +

                            The type definition for the API operations.

                            +
                          +
                          +

                          Hierarchy (View Summary)

                          +
                          +
                          +
                          +
                          +
                          Index
                           +
                          +
                          + +
                          constructor +
                          +
                          + +
                          api apiDomainName? apiFQDN? apiHostName? apiSpec hostedZone? node -

                          Methods

                          addCustomRestResource +
                          +
                          + +
                          addCustomRestResource addRestResource cleanupSpec getFunctionForOperation @@ -24,35 +67,219 @@ toString with isConstruct -

                          Constructors

                          • Creates an instance of RestApi.

                            -

                            Type Parameters

                            • PATHS

                              The type definition for the API paths.

                              -
                            • OPS

                              The type definition for the API operations.

                              -

                            Parameters

                            • scope: Construct

                              The scope in which this construct is defined.

                              -
                            • id: string

                              The scoped construct ID.

                              -
                            • props: RestApiProps<OPS>

                              The properties of the RestApi construct.

                              -

                            Returns RestApi<PATHS, OPS>

                          Properties

                          api: SpecRestApi

                          The AWS API Gateway REST API instance.

                          -
                          apiDomainName?: string
                          apiFQDN?: string
                          apiHostName?: string
                          apiSpec: OpenAPI3

                          The OpenAPI specification for the REST API.

                          -
                          hostedZone?: IHostedZone
                          node: Node

                          The tree node.

                          -

                          Methods

                          • Parameters

                            • operation: OperationObject
                            • method: string
                            • description: string
                            • additionalLambdaOptions: LambdaOptions = {}

                            Returns LambdaFunction | undefined

                          • Type Parameters

                            • P extends string | number | symbol

                            Parameters

                            Returns LambdaFunction | undefined

                          • Parameters

                            • spec: { [key: string]: any }

                            Returns { [key: string]: any }

                          • return the generated Lambda function for the specified API operation

                            -

                            Parameters

                            • operationId: keyof OPS

                            Returns LambdaFunction

                          • Visitor method to modify the given functions

                            -

                            Parameters

                            • operationIds: (keyof OPS)[]

                              the list of functions to visit

                              -
                            • op: (fn: LambdaFunction) => void

                              the function to call for every function

                              -

                            Returns void

                          • AWS does not properly apply the 'security' option to every single path-method. +

                          +
                          + +
                          +
                          + +
                            +
                          • + +
                            +

                            Creates an instance of RestApi.

                            +
                            +
                            +

                            Type Parameters

                            +
                              +
                            • PATHS +

                              The type definition for the API paths.

                              +
                              • +
                            • OPS +

                              The type definition for the API operations.

                              +
                            +
                            +

                            Parameters

                            +
                              +
                            • scope: Construct +

                              The scope in which this construct is defined.

                              +
                              • +
                            • id: string +

                              The scoped construct ID.

                              +
                              • +
                            • props: RestApiProps<OPS> +

                              The properties of the RestApi construct.

                              +
                            +

                            Returns RestApi<PATHS, OPS>

                          +
                          + +
                          +
                          + +
                          api: SpecRestApi
                          +

                          The AWS API Gateway REST API instance.

                          +
                          +
                          + +
                          apiDomainName?: string
                          +
                          + +
                          apiFQDN?: string
                          +
                          + +
                          apiHostName?: string
                          +
                          + +
                          apiSpec: OpenAPI3
                          +

                          The OpenAPI specification for the REST API.

                          +
                          +
                          + +
                          hostedZone?: IHostedZone
                          +
                          + +
                          node: Node
                          +

                          The tree node.

                          +
                          +
                          + +
                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Parameters

                            +
                              +
                            • operation: OperationObject
                              • +
                            • method: string
                              • +
                            • description: string
                              • +
                            • additionalLambdaOptions: LambdaOptions = {}
                            +

                            Returns LambdaFunction | undefined

                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Type Parameters

                            +
                              +
                            • P extends string | number | symbol
                            +
                            +

                            Parameters

                            +
                            +

                            Returns LambdaFunction | undefined

                          +
                          + +
                            +
                          • + +
                            +
                            +

                            Parameters

                            +
                              +
                            • spec: { [key: string]: any }
                            +

                            Returns { [key: string]: any }

                          +
                          + +
                            +
                          • + +
                            +

                            return the generated Lambda function for the specified API operation

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • operationId: keyof OPS
                            +

                            Returns LambdaFunction

                          +
                          + +
                          +
                          + +
                            +
                          • + +
                            +

                            Visitor method to modify the given functions

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • operationIds: (keyof OPS)[] +

                              the list of functions to visit

                              +
                              • +
                            • op: (fn: LambdaFunction) => void +

                              the function to call for every function

                              +
                            +

                            Returns void

                          +
                          + +
                            +
                          • + +
                            +

                            AWS does not properly apply the 'security' option to every single path-method. According to documentation, global security gets applied, if there is no security set for the particular path-method. If there is any, even empty, it will get precedence. THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!

                            'security applies [...] schemes globally to all API operations, unless overridden on the operation level'

                            -

                            Parameters

                            • spec: OpenAPI3

                            Returns void

                            https://swagger.io/docs/specification/authentication/

                            -

                          • Returns a string representation of this construct.

                            -

                            Returns string

                          +
                          + +
                            +
                          • + +
                            +

                            Returns a string representation of this construct.

                            +
                            +

                            Returns string

                          +
                          + +
                            +
                          • + +
                            +

                            Applies one or more mixins to this construct.

                            Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                            -

                            Parameters

                            • ...mixins: IMixin[]

                              The mixins to apply

                              -

                            Returns IConstruct

                            This construct for chaining

                            -

                          • Checks if x is a construct.

                            +
                            +
                            +

                            Parameters

                            +
                              +
                            • ...mixins: IMixin[] +

                              The mixins to apply

                              +
                            +

                            Returns IConstruct

                            This construct for chaining

                            +
                          +
                          + +
                            +
                          • + +
                            +

                            Checks if x is a construct.

                            Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                            Explanation: in JavaScript, multiple copies of the constructs library on @@ -65,6 +292,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                            -

                            Parameters

                            • x: any

                              Any object

                              -

                            Returns x is Construct

                            true if x is an object created from a class which extends Construct.

                            -

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          Methods
                          + +
                          +

                          Parameters

                          +
                            +
                          • x: any +

                            Any object

                            +
                          +

                          Returns x is Construct

                          true if x is an object created from a class which extends Construct.

                          + +
                          +
                          +
                          +
                          +

                          Settings

                           +
                          +
                          Member Visibility +
                            +
                            • +
                            • +
                          +
                          +
                          +

                          On This Page

                           +
                          +
                          Constructors +
                          +
                          Properties +
                          +
                          Methods +
                          +
                          +
                          +
                          diff --git a/docs/constructs/classes/SingleTableDatastore.html b/docs/constructs/classes/SingleTableDatastore.html index a96aa5b..86af78f 100644 --- a/docs/constructs/classes/SingleTableDatastore.html +++ b/docs/constructs/classes/SingleTableDatastore.html @@ -1,31 +1,151 @@ -SingleTableDatastore | cdk-serverless
                          cdk-serverless
                            Preparing search index...

                            Class SingleTableDatastore

                            The SingleTableDatastore construct sets up an AWS DynamoDB table with a single-table design. +SingleTableDatastore | cdk-serverless

                            +
                            cdk-serverless + +
                              +
                              +
                              Preparing search index...
                              +
                              +
                              +
                              + +

                              Class SingleTableDatastore

                              +
                              +

                              The SingleTableDatastore construct sets up an AWS DynamoDB table with a single-table design. This construct facilitates the creation of a DynamoDB table with various configurations, including primary key, sort key, global secondary indexes, local secondary indexes, and encryption. It also supports point-in-time recovery and time-to-live attributes.

                              -
                              const datastore = new SingleTableDatastore(this, 'MyDatastore', {
                                design: {
                                  primaryKey: {
                                    partitionKey: 'PK',
                                    sortKey: 'SK',
                                  },
                                  globalIndexes: [
                                    {
                                      indexName: 'GSI1',
                                      partitionKey: { name: 'GSI1PK', type: dynamodb.AttributeType.STRING },
                                      sortKey: { name: 'GSI1SK', type: dynamodb.AttributeType.STRING },
                                    },
                                  ],
                                  localIndexes: [
                                    {
                                      indexName: 'LSI1',
                                      sortKey: { name: 'LSI1SK', type: dynamodb.AttributeType.STRING },
                                    },
                                  ],
                                  timeToLiveAttribute: 'TTL',
                                },
                                encryption: dynamodb.TableEncryption.AWS_MANAGED,
                              });
+
                              +
                              +
                              +
                              const datastore = new SingleTableDatastore(this, 'MyDatastore', {
                                design: {
                                  primaryKey: {
                                    partitionKey: 'PK',
                                    sortKey: 'SK',
                                  },
                                  globalIndexes: [
                                    {
                                      indexName: 'GSI1',
                                      partitionKey: { name: 'GSI1PK', type: dynamodb.AttributeType.STRING },
                                      sortKey: { name: 'GSI1SK', type: dynamodb.AttributeType.STRING },
                                    },
                                  ],
                                  localIndexes: [
                                    {
                                      indexName: 'LSI1',
                                      sortKey: { name: 'LSI1SK', type: dynamodb.AttributeType.STRING },
                                    },
                                  ],
                                  timeToLiveAttribute: 'TTL',
                                },
                                encryption: dynamodb.TableEncryption.AWS_MANAGED,
                              });
                              -

                              Hierarchy

                              • Construct
                                • SingleTableDatastore

                              Implements

                              Index

                              Constructors

                              constructor -

                              Properties

                              node +
                              +
                              +

                              Hierarchy

                              +
                                +
                              • Construct +
                                  +
                                • SingleTableDatastore
                              +
                              +

                              Implements

                              +
                              +
                              +
                              +
                              +
                              Index
                               +
                              +
                              + +
                              constructor +
                              +
                              + +
                              node table -

                              Methods

                              toString +
                              +
                              + +
                              toString with fromTable isConstruct -

                              Constructors

                              Properties

                              node: Node

                              The tree node.

                              -
                              table: Table

                              The DynamoDB table instance.

                              -

                              Methods

                              • Returns a string representation of this construct.

                                -

                                Returns string

                              • Applies one or more mixins to this construct.

                                +
                              +
                              + +
                              +
                              + +
                                +
                              • + +
                                +

                                Creates an instance of SingleTableDatastore.

                                +
                                +
                                +

                                Parameters

                                +
                                  +
                                • scope: Construct +

                                  The scope in which this construct is defined.

                                  +
                                  • +
                                • id: string +

                                  The scoped construct ID.

                                  +
                                  • +
                                • props: SingleTableDatastoreProps +

                                  The properties of the SingleTableDatastore construct.

                                  +
                                +

                                Returns SingleTableDatastore

                              +
                              + +
                              +
                              + +
                              node: Node
                              +

                              The tree node.

                              +
                              +
                              + +
                              table: Table
                              +

                              The DynamoDB table instance.

                              +
                              +
                              + +
                              +
                              + +
                                +
                              • + +
                                +

                                Returns a string representation of this construct.

                                +
                                +

                                Returns string

                              +
                              + +
                                +
                              • + +
                                +

                                Applies one or more mixins to this construct.

                                Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                -

                                Parameters

                                • ...mixins: IMixin[]

                                  The mixins to apply

                                  -

                                Returns IConstruct

                                This construct for chaining

                                -

                              • Checks if x is a construct.

                                +
                                +
                                +

                                Parameters

                                +
                                  +
                                • ...mixins: IMixin[] +

                                  The mixins to apply

                                  +
                                +

                                Returns IConstruct

                                This construct for chaining

                                +
                              +
                              + +
                              +
                              + +
                                +
                              • + +
                                +

                                Checks if x is a construct.

                                Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                Explanation: in JavaScript, multiple copies of the constructs library on @@ -38,6 +158,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                -

                                Parameters

                                • x: any

                                  Any object

                                  -

                                Returns x is Construct

                                true if x is an object created from a class which extends Construct.

                                -

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              + +
                              +

                              Parameters

                              +
                                +
                              • x: any +

                                Any object

                                +
                              +

                              Returns x is Construct

                              true if x is an object created from a class which extends Construct.

                              + +
                              +
                              +
                              +
                              +

                              Settings

                               +
                              +
                              Member Visibility +
                                +
                                • +
                                • +
                              +
                              +
                              +

                              On This Page

                               +
                              +
                              Constructors +
                              +
                              Properties +
                              +
                              Methods +
                              +
                              +
                              +
                              diff --git a/docs/constructs/classes/Workflow.html b/docs/constructs/classes/Workflow.html index 9e6bc86..f120ffd 100644 --- a/docs/constructs/classes/Workflow.html +++ b/docs/constructs/classes/Workflow.html @@ -1,34 +1,149 @@ -Workflow | cdk-serverless
                              cdk-serverless
                                Preparing search index...

                                Class Workflow

                                The Workflow construct sets up an AWS Step Functions state machine with a specified definition file and IAM role. +Workflow | cdk-serverless

                                +
                                cdk-serverless + +
                                  +
                                  +
                                  Preparing search index...
                                  +
                                  +
                                  +
                                  + +

                                  Class Workflow

                                  +
                                  +

                                  The Workflow construct sets up an AWS Step Functions state machine with a specified definition file and IAM role. This construct facilitates the creation of a Step Functions workflow, including the definition from an S3 location and various configurations for logging and tracing. It implements the IGrantable interface for granting permissions.

                                  -
                                  const workflow = new Workflow(this, 'MyWorkflow', {
                                    definitionFileName: 'path/to/definition.asl.json',
                                    stateMachineType: sfn.StateMachineType.STANDARD,
                                    loggingConfiguration: {
                                      level: sfn.LogLevel.ALL,
                                      includeExecutionData: true,
                                      destinations: [new logs.LogGroup(this, 'LogGroup')],
                                    },
                                    tracingConfiguration: {
                                      enabled: true,
                                    },
                                    definitionSubstitutions: {
                                      '${MyVariable}': 'MyValue',
                                    },
                                  });

                                  const lambdaFunction = new lambda.Function(this, 'MyFunction', {
                                    runtime: lambda.Runtime.NODEJS_20_X,
                                    handler: 'index.handler',
                                    code: lambda.Code.fromAsset('lambda'),
                                  });

                                  workflow.grantPrincipal.grantInvoke(lambdaFunction);
+
                                  +
                                  +
                                  +
                                  const workflow = new Workflow(this, 'MyWorkflow', {
                                    definitionFileName: 'path/to/definition.asl.json',
                                    stateMachineType: sfn.StateMachineType.STANDARD,
                                    loggingConfiguration: {
                                      level: sfn.LogLevel.ALL,
                                      includeExecutionData: true,
                                      destinations: [new logs.LogGroup(this, 'LogGroup')],
                                    },
                                    tracingConfiguration: {
                                      enabled: true,
                                    },
                                    definitionSubstitutions: {
                                      '${MyVariable}': 'MyValue',
                                    },
                                  });

                                  const lambdaFunction = new lambda.Function(this, 'MyFunction', {
                                    runtime: lambda.Runtime.NODEJS_20_X,
                                    handler: 'index.handler',
                                    code: lambda.Code.fromAsset('lambda'),
                                  });

                                  workflow.grantPrincipal.grantInvoke(lambdaFunction);
                                  -

                                  Hierarchy

                                  • Construct
                                    • Workflow

                                  Implements

                                  • IGrantable
                                  Index

                                  Constructors

                                  constructor -

                                  Properties

                                  grantPrincipal +
                                  +
                                  +

                                  Hierarchy

                                  +
                                    +
                                  • Construct +
                                      +
                                    • Workflow
                                  +
                                  +

                                  Implements

                                  +
                                    +
                                  • IGrantable
                                  +
                                  +
                                  +
                                  +
                                  Index
                                   +
                                  +
                                  + +
                                  constructor +
                                  +
                                  + +
                                  grantPrincipal node role workflowArn -

                                  Methods

                                  toString +
                                  +
                                  + +
                                  toString with isConstruct -

                                  Constructors

                                  • Creates an instance of Workflow.

                                    -

                                    Parameters

                                    • scope: Construct

                                      The scope in which this construct is defined.

                                      -
                                    • id: string

                                      The scoped construct ID.

                                      -
                                    • props: WorkflowProps

                                      The properties of the Workflow construct.

                                      -

                                    Returns Workflow

                                  Properties

                                  grantPrincipal: IPrincipal

                                  The principal to which permissions can be granted.

                                  -
                                  node: Node

                                  The tree node.

                                  -
                                  role: IRole

                                  The IAM role assumed by the state machine.

                                  -
                                  workflowArn: string

                                  The ARN of the created state machine.

                                  -

                                  Methods

                                  • Returns a string representation of this construct.

                                    -

                                    Returns string

                                  • Applies one or more mixins to this construct.

                                    +
                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Creates an instance of Workflow.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • scope: Construct +

                                      The scope in which this construct is defined.

                                      +
                                      • +
                                    • id: string +

                                      The scoped construct ID.

                                      +
                                      • +
                                    • props: WorkflowProps +

                                      The properties of the Workflow construct.

                                      +
                                    +

                                    Returns Workflow

                                  +
                                  + +
                                  +
                                  + +
                                  grantPrincipal: IPrincipal
                                  +

                                  The principal to which permissions can be granted.

                                  +
                                  +
                                  + +
                                  node: Node
                                  +

                                  The tree node.

                                  +
                                  +
                                  + +
                                  role: IRole
                                  +

                                  The IAM role assumed by the state machine.

                                  +
                                  +
                                  + +
                                  workflowArn: string
                                  +

                                  The ARN of the created state machine.

                                  +
                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Returns a string representation of this construct.

                                    +
                                    +

                                    Returns string

                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Applies one or more mixins to this construct.

                                    Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                    -

                                    Parameters

                                    • ...mixins: IMixin[]

                                      The mixins to apply

                                      -

                                    Returns IConstruct

                                    This construct for chaining

                                    -

                                  • Checks if x is a construct.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • ...mixins: IMixin[] +

                                      The mixins to apply

                                      +
                                    +

                                    Returns IConstruct

                                    This construct for chaining

                                    +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Checks if x is a construct.

                                    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                    Explanation: in JavaScript, multiple copies of the constructs library on @@ -41,6 +156,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                    -

                                    Parameters

                                    • x: any

                                      Any object

                                      -

                                    Returns x is Construct

                                    true if x is an object created from a class which extends Construct.

                                    -

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  + +
                                  +

                                  Parameters

                                  +
                                    +
                                  • x: any +

                                    Any object

                                    +
                                  +

                                  Returns x is Construct

                                  true if x is an object created from a class which extends Construct.

                                  + +
                                  +
                                  +
                                  +
                                  +

                                  Settings

                                   +
                                  +
                                  Member Visibility +
                                    +
                                    • +
                                    • +
                                  +
                                  +
                                  +

                                  On This Page

                                   +
                                  +
                                  Constructors +
                                  +
                                  Properties +
                                  +
                                  Methods +
                                  +
                                  +
                                  +
                                  diff --git a/docs/constructs/hierarchy.html b/docs/constructs/hierarchy.html index 1df872f..c9e11e5 100644 --- a/docs/constructs/hierarchy.html +++ b/docs/constructs/hierarchy.html @@ -1 +1,47 @@ -cdk-serverless
                                  cdk-serverless
                                    Preparing search index...

                                    cdk-serverless

                                    Hierarchy Summary

                                    Settings

                                    Member Visibility
                                    +cdk-serverless
                                    +
                                    cdk-serverless + +
                                      +
                                      +
                                      Preparing search index...
                                      +
                                      +
                                      +
                                      +

                                      cdk-serverless

                                      +

                                      Hierarchy Summary

                                      + + + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Settings

                                       +
                                      +
                                      Member Visibility +
                                        +
                                        • +
                                        • +
                                      +
                                      +
                                      +
                                      +
                                      diff --git a/docs/constructs/index.html b/docs/constructs/index.html index 56722cd..b7a77e7 100644 --- a/docs/constructs/index.html +++ b/docs/constructs/index.html @@ -1,4 +1,14 @@ -cdk-serverless
                                      cdk-serverless
                                        Preparing search index...

                                        cdk-serverless

                                        CDK Serverless

                                        +cdk-serverless
                                        +
                                        cdk-serverless + +
                                          +
                                          +
                                          Preparing search index...
                                          +
                                          +
                                          +
                                          +

                                          cdk-serverless

                                          +

                                          CDK Serverless

                                          npm version

                                          CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

                                          Video introduction: https://www.youtube.com/watch?v=xhNJ0cXG3O8

                                          @@ -136,4 +146,60 @@

                                          Authors

                                          Brought to you by Taimos

                                          -

                                          Settings

                                          Member Visibility

                                          On This Page

                                          CDK Serverless
                                          +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Settings

                                           +
                                          +
                                          Member Visibility +
                                            +
                                            • +
                                            • +
                                          +
                                          +
                                          +

                                          On This Page

                                           +
                                          CDK Serverless +
                                          +
                                          +
                                          +
                                          diff --git a/docs/constructs/interfaces/AssetCdnProps.html b/docs/constructs/interfaces/AssetCdnProps.html index 98eaffd..9ea280b 100644 --- a/docs/constructs/interfaces/AssetCdnProps.html +++ b/docs/constructs/interfaces/AssetCdnProps.html @@ -1,6 +1,62 @@ -AssetCdnProps | cdk-serverless
                                          cdk-serverless
                                            Preparing search index...

                                            Interface AssetCdnProps

                                            Properties for AssetCdn L3 construct

                                            -
                                            interface AssetCdnProps {
                                                domainName: string;
                                                hostName: string;
                                            }
                                            Index

                                            Properties

                                            domainName +AssetCdnProps | cdk-serverless
                                            +
                                            cdk-serverless + +
                                              +
                                              +
                                              Preparing search index...
                                              +
                                              +
                                              +
                                              + +

                                              Interface AssetCdnProps

                                              +
                                              +

                                              Properties for AssetCdn L3 construct

                                              +
                                              +
                                              interface AssetCdnProps {
                                                  domainName: string;
                                                  hostName: string;
                                              }
                                              +
                                              +
                                              +
                                              +
                                              Index
                                               +
                                              +
                                              + +
                                              domainName hostName -

                                              Properties

                                              domainName: string

                                              Domain name of the asset content delivery network (e.g. example.com)

                                              -
                                              hostName: string

                                              Hostname of the asset content delivery network (e.g. cdn)

                                              -

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              +
                                              +
                                              + +
                                              +
                                              + +
                                              domainName: string
                                              +

                                              Domain name of the asset content delivery network (e.g. example.com)

                                              +
                                              +
                                              + +
                                              hostName: string
                                              +

                                              Hostname of the asset content delivery network (e.g. cdn)

                                              +
                                              +
                                              +
                                              +
                                              +
                                              +

                                              Settings

                                               +
                                              +
                                              Member Visibility +
                                                +
                                                • +
                                                • +
                                              +
                                              +
                                              +

                                              On This Page

                                               +
                                              +
                                              Properties +
                                              +
                                              +
                                              +
                                              diff --git a/docs/constructs/interfaces/BaseApiProps.html b/docs/constructs/interfaces/BaseApiProps.html index d6f5aab..0614619 100644 --- a/docs/constructs/interfaces/BaseApiProps.html +++ b/docs/constructs/interfaces/BaseApiProps.html @@ -1,4 +1,31 @@ -BaseApiProps | cdk-serverless
                                              cdk-serverless
                                                Preparing search index...

                                                Interface BaseApiProps

                                                interface BaseApiProps {
                                                    additionalEnv?: { [key: string]: string };
                                                    apiHostname?: string;
                                                    apiName: string;
                                                    assetCdn?: AssetCdn;
                                                    authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                    domainName?: string;
                                                    hostedZone?: IHostedZone;
                                                    lambdaOptions?: LambdaOptions;
                                                    lambdaTracing?: LambdaTracingOptions;
                                                    monitoring?: boolean;
                                                    singleTableDatastore?: ISingleTableDatastore;
                                                    stageName: string;
                                                }

                                                Hierarchy (View Summary)

                                                Index

                                                Properties

                                                additionalEnv? +BaseApiProps | cdk-serverless
                                                +
                                                cdk-serverless + +
                                                  +
                                                  +
                                                  Preparing search index...
                                                  +
                                                  +
                                                  +
                                                  + +

                                                  Interface BaseApiProps

                                                  +
                                                  interface BaseApiProps {
                                                      additionalEnv?: { [key: string]: string };
                                                      apiHostname?: string;
                                                      apiName: string;
                                                      assetCdn?: AssetCdn;
                                                      authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                      domainName?: string;
                                                      hostedZone?: IHostedZone;
                                                      lambdaOptions?: LambdaOptions;
                                                      lambdaTracing?: LambdaTracingOptions;
                                                      monitoring?: boolean;
                                                      singleTableDatastore?: ISingleTableDatastore;
                                                      stageName: string;
                                                  }
                                                  +
                                                  +

                                                  Hierarchy (View Summary)

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  Index
                                                   +
                                                  +
                                                  + +
                                                  additionalEnv? apiHostname? apiName assetCdn? @@ -10,40 +37,134 @@ monitoring? singleTableDatastore? stageName -

                                                  Properties

                                                  additionalEnv?: { [key: string]: string }

                                                  Additional environment variables of all Lambda functions

                                                  -
                                                  apiHostname?: string

                                                  Hostname of the API if a domain name is specified

                                                  -
                                                  api
+
                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  additionalEnv?: { [key: string]: string }
                                                  +

                                                  Additional environment variables of all Lambda functions

                                                  +
                                                  +
                                                  + +
                                                  apiHostname?: string
                                                  +

                                                  Hostname of the API if a domain name is specified

                                                  +
                                                  +
                                                  +
                                                  +
                                                  api
                                                  -
                                                  apiName: string

                                                  Name of the API

                                                  -
                                                  assetCdn?: AssetCdn

                                                  Configure a content delivery network for static assets

                                                  -
                                                  none
+
                                                  +
                                                  + +
                                                  apiName: string
                                                  +

                                                  Name of the API

                                                  +
                                                  +
                                                  + +
                                                  assetCdn?: AssetCdn
                                                  +

                                                  Configure a content delivery network for static assets

                                                  +
                                                  +
                                                  +
                                                  +
                                                  none
                                                  -
                                                  authentication?: IJwtAuthentication | ICognitoAuthentication

                                                  Use a Cognito user pool for authorization. +

                                                  +
                                                  + +
                                                  authentication?: IJwtAuthentication | ICognitoAuthentication
                                                  +

                                                  Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

                                                  -
                                                  none
+
                                                  +
                                                  +
                                                  +
                                                  none
                                                  -
                                                  domainName?: string

                                                  Domain name of the API (e.g. example.com)

                                                  +
                                                  +
                                                  + +
                                                  domainName?: string
                                                  +

                                                  Domain name of the API (e.g. example.com)

                                                  only one of hostedZone and domainName can be specified

                                                  -
                                                  - No custom domain is configured
+
                                                  +
                                                  +
                                                  +
                                                  - No custom domain is configured
                                                  -
                                                  hostedZone?: IHostedZone

                                                  Hosted Zone of the API (e.g. example.com)

                                                  +
                                                  +
                                                  + +
                                                  hostedZone?: IHostedZone
                                                  +

                                                  Hosted Zone of the API (e.g. example.com)

                                                  only one of hostedZone and domainName can be specified

                                                  -
                                                  - No custom domain is configured
+
                                                  +
                                                  +
                                                  +
                                                  - No custom domain is configured
                                                  -
                                                  lambdaOptions?: LambdaOptions

                                                  additional options for the underlying Lambda function construct

                                                  -
                                                  lambdaTracing?: LambdaTracingOptions

                                                  Tracing config for the generated Lambda functions

                                                  -
                                                  monitoring?: boolean

                                                  Configure CloudWatch Dashboard for the API and the Lambda functions

                                                  -
                                                  true
+
                                                  +
                                                  + +
                                                  lambdaOptions?: LambdaOptions
                                                  +

                                                  additional options for the underlying Lambda function construct

                                                  +
                                                  +
                                                  + +
                                                  lambdaTracing?: LambdaTracingOptions
                                                  +

                                                  Tracing config for the generated Lambda functions

                                                  +
                                                  +
                                                  + +
                                                  monitoring?: boolean
                                                  +

                                                  Configure CloudWatch Dashboard for the API and the Lambda functions

                                                  +
                                                  +
                                                  +
                                                  +
                                                  true
                                                  -
                                                  singleTableDatastore?: ISingleTableDatastore
                                                  none
+
                                                  +
                                                  + +
                                                  singleTableDatastore?: ISingleTableDatastore
                                                  +
                                                  +
                                                  +
                                                  none
                                                  -
                                                  stageName: string

                                                  Deployment stage (e.g. dev)

                                                  -

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Properties
                                                  + +
                                                  + +
                                                  stageName: string
                                                  +

                                                  Deployment stage (e.g. dev)

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Settings

                                                   +
                                                  +
                                                  Member Visibility +
                                                    +
                                                    • +
                                                    • +
                                                  +
                                                  +
                                                  +

                                                  On This Page

                                                   +
                                                  +
                                                  Properties +
                                                  +
                                                  +
                                                  +
                                                  diff --git a/docs/constructs/interfaces/CognitoAuthenticationProps.html b/docs/constructs/interfaces/CognitoAuthenticationProps.html index 1502e48..ad6fe01 100644 --- a/docs/constructs/interfaces/CognitoAuthenticationProps.html +++ b/docs/constructs/interfaces/CognitoAuthenticationProps.html @@ -1,42 +1,157 @@ -CognitoAuthenticationProps | cdk-serverless
                                                  cdk-serverless
                                                    Preparing search index...

                                                    Interface CognitoAuthenticationProps

                                                    interface CognitoAuthenticationProps {
                                                        groups?: { readonly [name: string]: string };
                                                        identityPool?: { poolConfig?: IdentityPoolProps };
                                                        sesEmailSender?: { email: string; name: string; region: string };
                                                        triggers?: {
                                                            customMessages?: boolean;
                                                            preSignUp?: boolean;
                                                            preTokenGeneration?: boolean;
                                                            preTokenGenerationv2?: boolean;
                                                        };
                                                        userPoolName: string;
                                                        userPoolProps?: UserPoolProps;
                                                    }
                                                    Index

                                                    Properties

                                                    groups? +CognitoAuthenticationProps | cdk-serverless
                                                    +
                                                    cdk-serverless + +
                                                      +
                                                      +
                                                      Preparing search index...
                                                      +
                                                      +
                                                      +
                                                      + +

                                                      Interface CognitoAuthenticationProps

                                                      +
                                                      interface CognitoAuthenticationProps {
                                                          groups?: { readonly [name: string]: string };
                                                          identityPool?: { poolConfig?: IdentityPoolProps };
                                                          sesEmailSender?: { email: string; name: string; region: string };
                                                          triggers?: {
                                                              customMessages?: boolean;
                                                              preSignUp?: boolean;
                                                              preTokenGeneration?: boolean;
                                                              preTokenGenerationv2?: boolean;
                                                          };
                                                          userPoolName: string;
                                                          userPoolProps?: UserPoolProps;
                                                      }
                                                      +
                                                      +
                                                      +
                                                      +
                                                      Index
                                                       +
                                                      +
                                                      + +
                                                      groups? identityPool? sesEmailSender? triggers? userPoolName userPoolProps? -

                                                      Properties

                                                      groups?: { readonly [name: string]: string }

                                                      Groups to create in Cognito user pool +

                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      groups?: { readonly [name: string]: string }
                                                      +

                                                      Groups to create in Cognito user pool Key: group name Value: group description

                                                      -
                                                      identityPool?: { poolConfig?: IdentityPoolProps }

                                                      Create a new Cognito Identity Pool for the User pool

                                                      -

                                                      Type Declaration

                                                      • Optional ReadonlypoolConfig?: IdentityPoolProps

                                                        configuration of the identity pool

                                                        -
                                                      sesEmailSender?: { email: string; name: string; region: string }

                                                      Configure SES mail sending

                                                      -

                                                      Type Declaration

                                                      • Readonlyemail: string

                                                        Sender email. Needs to be already verified in SES

                                                        -
                                                      • Readonlyname: string

                                                        Sender name

                                                        -
                                                      • Readonlyregion: string

                                                        AWS region to use for SES

                                                        -
                                                      triggers?: {
                                                          customMessages?: boolean;
                                                          preSignUp?: boolean;
                                                          preTokenGeneration?: boolean;
                                                          preTokenGenerationv2?: boolean;
                                                      }

                                                      Configure Cognito Lambda triggers

                                                      -

                                                      Type Declaration

                                                      • Optional ReadonlycustomMessages?: boolean

                                                        Attaches a lambda function to the custom message trigger

                                                        +
                                                      +
                                                      + +
                                                      identityPool?: { poolConfig?: IdentityPoolProps }
                                                      +

                                                      Create a new Cognito Identity Pool for the User pool

                                                      +
                                                      +
                                                      +

                                                      Type Declaration

                                                      +
                                                        +
                                                      • +
                                                        Optional ReadonlypoolConfig?: IdentityPoolProps
                                                        +

                                                        configuration of the identity pool

                                                        +
                                                      +
                                                      + +
                                                      sesEmailSender?: { email: string; name: string; region: string }
                                                      +

                                                      Configure SES mail sending

                                                      +
                                                      +
                                                      +

                                                      Type Declaration

                                                      +
                                                        +
                                                      • +
                                                        Readonlyemail: string
                                                        +

                                                        Sender email. Needs to be already verified in SES

                                                        +
                                                        • +
                                                      • +
                                                        Readonlyname: string
                                                        +

                                                        Sender name

                                                        +
                                                        • +
                                                      • +
                                                        Readonlyregion: string
                                                        +

                                                        AWS region to use for SES

                                                        +
                                                      +
                                                      + +
                                                      triggers?: {
                                                          customMessages?: boolean;
                                                          preSignUp?: boolean;
                                                          preTokenGeneration?: boolean;
                                                          preTokenGenerationv2?: boolean;
                                                      }
                                                      +

                                                      Configure Cognito Lambda triggers

                                                      +
                                                      +
                                                      +

                                                      Type Declaration

                                                      +
                                                        +
                                                      • +
                                                        Optional ReadonlycustomMessages?: boolean
                                                        +

                                                        Attaches a lambda function to the custom message trigger

                                                        Code has to reside in './src/lambda/cognito.custom-message.ts' with a method 'handler'

                                                        -
                                                        false
+
                                                        +
                                                        +
                                                        +
                                                        false
                                                        -
                                                      • Optional ReadonlypreSignUp?: boolean

                                                        Attaches a lambda function to the pre sign-up trigger

                                                        +
                                                      +
                                                    • +
                                                      Optional ReadonlypreSignUp?: boolean
                                                      +

                                                      Attaches a lambda function to the pre sign-up trigger

                                                      Code has to reside in './src/lambda/cognito.pre-signup.ts' with a method 'handler'

                                                      -
                                                      false
+
                                                      +
                                                      +
                                                      +
                                                      false
                                                      -
                                                    • Optional ReadonlypreTokenGeneration?: boolean

                                                      Attaches a lambda function to the pre token generation trigger

                                                      +
                                                      • +
                                                    • +
                                                      Optional ReadonlypreTokenGeneration?: boolean
                                                      +

                                                      Attaches a lambda function to the pre token generation trigger

                                                      Code has to reside in './src/lambda/cognito.pre-token-generation.ts' with a method 'handler'

                                                      You can only use preTokenGeneration or preTokenGenerationv2, not both.

                                                      -
                                                      false
+
                                                      +
                                                      +
                                                      +
                                                      false
                                                      -
                                                    • Optional ReadonlypreTokenGenerationv2?: boolean

                                                      Attaches a lambda function to the pre token generation trigger +

                                                      • +
                                                    • +
                                                      Optional ReadonlypreTokenGenerationv2?: boolean
                                                      +

                                                      Attaches a lambda function to the pre token generation trigger new version of the pre token generation trigger with AccessToken support

                                                      Code has to reside in './src/lambda/cognito.pre-token-generation.ts' with a method 'handler'

                                                      You can only use preTokenGeneration or preTokenGenerationv2, not both.

                                                      -
                                                      false
+
                                                      +
                                                      +
                                                      +
                                                      false
                                                      -
                                                      • userPoolName: string

                                                      Name for the Cognito user pool

                                                      -
                                                      userPoolProps?: UserPoolProps

                                                      Properties of the Cognito user pool

                                                      -

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Properties
                                                      + +
                                                      + +
                                                      userPoolName: string
                                                      +

                                                      Name for the Cognito user pool

                                                      +
                                                      +
                                                      + +
                                                      userPoolProps?: UserPoolProps
                                                      +

                                                      Properties of the Cognito user pool

                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Settings

                                                       +
                                                      +
                                                      Member Visibility +
                                                        +
                                                        • +
                                                        • +
                                                      +
                                                      +
                                                      +

                                                      On This Page

                                                       +
                                                      +
                                                      Properties +
                                                      +
                                                      +
                                                      +
                                                      diff --git a/docs/constructs/interfaces/GraphQlApiProps.html b/docs/constructs/interfaces/GraphQlApiProps.html index 1edaddd..2c9b866 100644 --- a/docs/constructs/interfaces/GraphQlApiProps.html +++ b/docs/constructs/interfaces/GraphQlApiProps.html @@ -1,4 +1,30 @@ -GraphQlApiProps | cdk-serverless
                                                      cdk-serverless
                                                        Preparing search index...

                                                        Interface GraphQlApiProps

                                                        interface GraphQlApiProps {
                                                            additionalEnv?: { [key: string]: string };
                                                            apiHostname?: string;
                                                            apiName: string;
                                                            assetCdn?: AssetCdn;
                                                            authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                            definitionFileName: string;
                                                            domainName?: string;
                                                            hostedZone?: IHostedZone;
                                                            lambdaOptions?: LambdaOptions;
                                                            lambdaTracing?: LambdaTracingOptions;
                                                            monitoring?: boolean;
                                                            singleTableDatastore?: ISingleTableDatastore;
                                                            stageName: string;
                                                            useNestedStacks?: boolean;
                                                        }

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Properties

                                                        additionalEnv? +GraphQlApiProps | cdk-serverless
                                                        +
                                                        cdk-serverless + +
                                                          +
                                                          +
                                                          Preparing search index...
                                                          +
                                                          +
                                                          +
                                                          + +

                                                          Interface GraphQlApiProps

                                                          +
                                                          interface GraphQlApiProps {
                                                              additionalEnv?: { [key: string]: string };
                                                              apiHostname?: string;
                                                              apiName: string;
                                                              assetCdn?: AssetCdn;
                                                              authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                              definitionFileName: string;
                                                              domainName?: string;
                                                              hostedZone?: IHostedZone;
                                                              lambdaOptions?: LambdaOptions;
                                                              lambdaTracing?: LambdaTracingOptions;
                                                              monitoring?: boolean;
                                                              singleTableDatastore?: ISingleTableDatastore;
                                                              stageName: string;
                                                              useNestedStacks?: boolean;
                                                          }
                                                          +
                                                          +

                                                          Hierarchy (View Summary)

                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          Index
                                                           +
                                                          +
                                                          + +
                                                          additionalEnv? apiHostname? apiName assetCdn? @@ -12,43 +38,133 @@ singleTableDatastore? stageName useNestedStacks? -

                                                          Properties

                                                          additionalEnv?: { [key: string]: string }

                                                          Additional environment variables of all Lambda functions

                                                          -
                                                          apiHostname?: string

                                                          Hostname of the API if a domain name is specified

                                                          -
                                                          api
+
                                                          +
                                                          + +
                                                          +
                                                          + +
                                                          additionalEnv?: { [key: string]: string }
                                                          +

                                                          Additional environment variables of all Lambda functions

                                                          +
                                                          +
                                                          + +
                                                          apiHostname?: string
                                                          +

                                                          Hostname of the API if a domain name is specified

                                                          +
                                                          +
                                                          +
                                                          +
                                                          api
                                                          -
                                                          apiName: string

                                                          Name of the API

                                                          -
                                                          assetCdn?: AssetCdn

                                                          Configure a content delivery network for static assets

                                                          -
                                                          none
+
                                                          +
                                                          + +
                                                          apiName: string
                                                          +

                                                          Name of the API

                                                          +
                                                          +
                                                          + +
                                                          assetCdn?: AssetCdn
                                                          +

                                                          Configure a content delivery network for static assets

                                                          +
                                                          +
                                                          +
                                                          +
                                                          none
                                                          -
                                                          authentication?: IJwtAuthentication | ICognitoAuthentication

                                                          Use a Cognito user pool for authorization. +

                                                          +
                                                          + +
                                                          authentication?: IJwtAuthentication | ICognitoAuthentication
                                                          +

                                                          Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

                                                          -
                                                          none
+
                                                          +
                                                          +
                                                          +
                                                          none
                                                          -
                                                          definitionFileName: string
                                                          domainName?: string

                                                          Domain name of the API (e.g. example.com)

                                                          +
                                                          +
                                                          + +
                                                          definitionFileName: string
                                                          +
                                                          + +
                                                          domainName?: string
                                                          +

                                                          Domain name of the API (e.g. example.com)

                                                          only one of hostedZone and domainName can be specified

                                                          -
                                                          - No custom domain is configured
+
                                                          +
                                                          +
                                                          +
                                                          - No custom domain is configured
                                                          -
                                                          hostedZone?: IHostedZone

                                                          Hosted Zone of the API (e.g. example.com)

                                                          +
                                                          +
                                                          + +
                                                          hostedZone?: IHostedZone
                                                          +

                                                          Hosted Zone of the API (e.g. example.com)

                                                          only one of hostedZone and domainName can be specified

                                                          -
                                                          - No custom domain is configured
+
                                                          +
                                                          +
                                                          +
                                                          - No custom domain is configured
                                                          -
                                                          lambdaOptions?: LambdaOptions

                                                          additional options for the underlying Lambda function construct

                                                          -
                                                          lambdaTracing?: LambdaTracingOptions

                                                          Tracing config for the generated Lambda functions

                                                          -
                                                          monitoring?: boolean

                                                          Configure CloudWatch Dashboard for the API and the Lambda functions

                                                          -
                                                          true
+
                                                          +
                                                          + +
                                                          lambdaOptions?: LambdaOptions
                                                          +

                                                          additional options for the underlying Lambda function construct

                                                          +
                                                          +
                                                          + +
                                                          lambdaTracing?: LambdaTracingOptions
                                                          +

                                                          Tracing config for the generated Lambda functions

                                                          +
                                                          +
                                                          + +
                                                          monitoring?: boolean
                                                          +

                                                          Configure CloudWatch Dashboard for the API and the Lambda functions

                                                          +
                                                          +
                                                          +
                                                          +
                                                          true
                                                          -
                                                          singleTableDatastore?: ISingleTableDatastore
                                                          none
+
                                                          +
                                                          + +
                                                          singleTableDatastore?: ISingleTableDatastore
                                                          +
                                                          +
                                                          +
                                                          none
                                                          -
                                                          stageName: string

                                                          Deployment stage (e.g. dev)

                                                          -
                                                          useNestedStacks?: boolean

                                                          If true, resolvers and Lambda functions will be created in nested stacks +

                                                          +
                                                          + +
                                                          stageName: string
                                                          +

                                                          Deployment stage (e.g. dev)

                                                          +
                                                          +
                                                          + +
                                                          useNestedStacks?: boolean
                                                          +

                                                          If true, resolvers and Lambda functions will be created in nested stacks grouped by type (Query, Mutation, Subscription, Field).

                                                          WARNING: Only enable this if you are approaching or hitting CloudFormation's 500 resource limit. Nested stacks have significant downsides:

                                                          @@ -61,7 +177,33 @@

                                                          WARNING: Changing this setting on an existing stack requires manual intervention. CloudFormation cannot automatically move resources between stacks. You may need to delete and recreate resolvers, or perform a two-step deployment.

                                                          -
                                                          false
+
                                                          +
                                                          +
                                                          +
                                                          false
                                                          -

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Properties
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Settings

                                                           +
                                                          +
                                                          Member Visibility +
                                                            +
                                                            • +
                                                            • +
                                                          +
                                                          +
                                                          +

                                                          On This Page

                                                           +
                                                          +
                                                          Properties +
                                                          +
                                                          +
                                                          +
                                                          diff --git a/docs/constructs/interfaces/ICognitoAuthentication.html b/docs/constructs/interfaces/ICognitoAuthentication.html index 8934b9e..2c2f90a 100644 --- a/docs/constructs/interfaces/ICognitoAuthentication.html +++ b/docs/constructs/interfaces/ICognitoAuthentication.html @@ -1,3 +1,57 @@ -ICognitoAuthentication | cdk-serverless
                                                          cdk-serverless
                                                            Preparing search index...

                                                            Interface ICognitoAuthentication

                                                            interface ICognitoAuthentication {
                                                                userpool: IUserPool;
                                                            }

                                                            Implemented by

                                                            Index

                                                            Properties

                                                            userpool -

                                                            Properties

                                                            userpool: IUserPool

                                                            The Cognito user pool that holds user information

                                                            -

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            +ICognitoAuthentication | cdk-serverless
                                                            +
                                                            cdk-serverless + +
                                                              +
                                                              +
                                                              Preparing search index...
                                                              +
                                                              +
                                                              +
                                                              + +

                                                              Interface ICognitoAuthentication

                                                              +
                                                              interface ICognitoAuthentication {
                                                                  userpool: IUserPool;
                                                              }
                                                              +
                                                              +

                                                              Implemented by

                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              Index
                                                               +
                                                              +
                                                              + +
                                                              userpool +
                                                              +
                                                              + +
                                                              +
                                                              + +
                                                              userpool: IUserPool
                                                              +

                                                              The Cognito user pool that holds user information

                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Settings

                                                               +
                                                              +
                                                              Member Visibility +
                                                                +
                                                                • +
                                                                • +
                                                              +
                                                              +
                                                              +

                                                              On This Page

                                                               +
                                                              +
                                                              Properties +
                                                              +
                                                              +
                                                              +
                                                              diff --git a/docs/constructs/interfaces/IJwtAuthentication.html b/docs/constructs/interfaces/IJwtAuthentication.html index 8e2faf3..ec31712 100644 --- a/docs/constructs/interfaces/IJwtAuthentication.html +++ b/docs/constructs/interfaces/IJwtAuthentication.html @@ -1,7 +1,65 @@ -IJwtAuthentication | cdk-serverless
                                                              cdk-serverless
                                                                Preparing search index...

                                                                Interface IJwtAuthentication

                                                                interface IJwtAuthentication {
                                                                    audience?: string[];
                                                                    issuerUrl: string;
                                                                    jwksUrl?: string;
                                                                }
                                                                Index

                                                                Properties

                                                                audience? +IJwtAuthentication | cdk-serverless
                                                                +
                                                                cdk-serverless + +
                                                                  +
                                                                  +
                                                                  Preparing search index...
                                                                  +
                                                                  +
                                                                  +
                                                                  + +

                                                                  Interface IJwtAuthentication

                                                                  +
                                                                  interface IJwtAuthentication {
                                                                      audience?: string[];
                                                                      issuerUrl: string;
                                                                      jwksUrl?: string;
                                                                  }
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  Index
                                                                   +
                                                                  +
                                                                  + +
                                                                  audience? issuerUrl jwksUrl? -

                                                                  Properties

                                                                  audience?: string[]

                                                                  The endpoint's audience. Will only be checked if present.

                                                                  -
                                                                  issuerUrl: string

                                                                  The JWT issuer endpoint URL

                                                                  -
                                                                  jwksUrl?: string

                                                                  The JWT endpoints JWKS store. Unless this is provided, OIDC discovery will be used to find this.

                                                                  -

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Properties
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  audience?: string[]
                                                                  +

                                                                  The endpoint's audience. Will only be checked if present.

                                                                  +
                                                                  +
                                                                  + +
                                                                  issuerUrl: string
                                                                  +

                                                                  The JWT issuer endpoint URL

                                                                  +
                                                                  +
                                                                  + +
                                                                  jwksUrl?: string
                                                                  +

                                                                  The JWT endpoints JWKS store. Unless this is provided, OIDC discovery will be used to find this.

                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Settings

                                                                   +
                                                                  +
                                                                  Member Visibility +
                                                                    +
                                                                    • +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +

                                                                  On This Page

                                                                   +
                                                                  +
                                                                  Properties +
                                                                  +
                                                                  +
                                                                  +
                                                                  diff --git a/docs/constructs/interfaces/ISingleTableDatastore.html b/docs/constructs/interfaces/ISingleTableDatastore.html index f27c13f..6c1c354 100644 --- a/docs/constructs/interfaces/ISingleTableDatastore.html +++ b/docs/constructs/interfaces/ISingleTableDatastore.html @@ -1,3 +1,57 @@ -ISingleTableDatastore | cdk-serverless
                                                                  cdk-serverless
                                                                    Preparing search index...

                                                                    Interface ISingleTableDatastore

                                                                    interface ISingleTableDatastore {
                                                                        table: Table;
                                                                    }

                                                                    Implemented by

                                                                    Index

                                                                    Properties

                                                                    table -

                                                                    Properties

                                                                    table: Table

                                                                    The DynamoDB table instance behind the SingleTableDatastore.

                                                                    -

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    +ISingleTableDatastore | cdk-serverless
                                                                    +
                                                                    cdk-serverless + +
                                                                      +
                                                                      +
                                                                      Preparing search index...
                                                                      +
                                                                      +
                                                                      +
                                                                      + +

                                                                      Interface ISingleTableDatastore

                                                                      +
                                                                      interface ISingleTableDatastore {
                                                                          table: Table;
                                                                      }
                                                                      +
                                                                      +

                                                                      Implemented by

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      Index
                                                                       +
                                                                      +
                                                                      + +
                                                                      table +
                                                                      +
                                                                      + +
                                                                      +
                                                                      + +
                                                                      table: Table
                                                                      +

                                                                      The DynamoDB table instance behind the SingleTableDatastore.

                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Settings

                                                                       +
                                                                      +
                                                                      Member Visibility +
                                                                        +
                                                                        • +
                                                                        • +
                                                                      +
                                                                      +
                                                                      +

                                                                      On This Page

                                                                       +
                                                                      +
                                                                      Properties +
                                                                      +
                                                                      +
                                                                      +
                                                                      diff --git a/docs/constructs/interfaces/JsResolverOptions.html b/docs/constructs/interfaces/JsResolverOptions.html index 3b475f3..737ffbb 100644 --- a/docs/constructs/interfaces/JsResolverOptions.html +++ b/docs/constructs/interfaces/JsResolverOptions.html @@ -1,11 +1,71 @@ -JsResolverOptions | cdk-serverless
                                                                      cdk-serverless
                                                                        Preparing search index...

                                                                        Interface JsResolverOptions

                                                                        interface JsResolverOptions {
                                                                            pipelineStepNames?: string[];
                                                                            stashValues?: { [key: string]: string };
                                                                        }
                                                                        Index

                                                                        Properties

                                                                        pipelineStepNames? +JsResolverOptions | cdk-serverless
                                                                        +
                                                                        cdk-serverless + +
                                                                          +
                                                                          +
                                                                          Preparing search index...
                                                                          +
                                                                          +
                                                                          +
                                                                          + +

                                                                          Interface JsResolverOptions

                                                                          +
                                                                          interface JsResolverOptions {
                                                                              pipelineStepNames?: string[];
                                                                              stashValues?: { [key: string]: string };
                                                                          }
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          Index
                                                                           +
                                                                          +
                                                                          + +
                                                                          pipelineStepNames? stashValues? -

                                                                          Properties

                                                                          pipelineStepNames?: string[]

                                                                          name of the pipeline steps to create

                                                                          -
                                                                          - only a default step will be created
+
                                                                          +
                                                                          + +
                                                                          +
                                                                          + +
                                                                          pipelineStepNames?: string[]
                                                                          +

                                                                          name of the pipeline steps to create

                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          - only a default step will be created
                                                                          -
                                                                          stashValues?: { [key: string]: string }

                                                                          Variables that will be put into the "stash" of the resolver pipeline

                                                                          -
                                                                          none
+
                                                                          +
                                                                          + +
                                                                          stashValues?: { [key: string]: string }
                                                                          +

                                                                          Variables that will be put into the "stash" of the resolver pipeline

                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          none
                                                                          -

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Settings

                                                                           +
                                                                          +
                                                                          Member Visibility +
                                                                            +
                                                                            • +
                                                                            • +
                                                                          +
                                                                          +
                                                                          +

                                                                          On This Page

                                                                           +
                                                                          +
                                                                          Properties +
                                                                          +
                                                                          +
                                                                          +
                                                                          diff --git a/docs/constructs/interfaces/LambdaFunctionProps.html b/docs/constructs/interfaces/LambdaFunctionProps.html index 120faba..ab175b0 100644 --- a/docs/constructs/interfaces/LambdaFunctionProps.html +++ b/docs/constructs/interfaces/LambdaFunctionProps.html @@ -1,4 +1,24 @@ -LambdaFunctionProps | cdk-serverless
                                                                          cdk-serverless
                                                                            Preparing search index...

                                                                            Interface LambdaFunctionProps

                                                                            interface LambdaFunctionProps {
                                                                                additionalEnv?: { [key: string]: string };
                                                                                assetBucket?: Bucket;
                                                                                assetDomainName?: string;
                                                                                description?: string;
                                                                                entry: string;
                                                                                handler?: string;
                                                                                includeSDK?: boolean;
                                                                                jwt?: IJwtAuthentication;
                                                                                lambdaOptions?: LambdaOptions;
                                                                                lambdaTracing?: LambdaTracingOptions;
                                                                                stageName?: string;
                                                                                table?: ITable;
                                                                                tableWrites?: boolean;
                                                                                userPool?: IUserPool;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            additionalEnv? +LambdaFunctionProps | cdk-serverless
                                                                            +
                                                                            cdk-serverless + +
                                                                              +
                                                                              +
                                                                              Preparing search index...
                                                                              +
                                                                              +
                                                                              +
                                                                              + +

                                                                              Interface LambdaFunctionProps

                                                                              +
                                                                              interface LambdaFunctionProps {
                                                                                  additionalEnv?: { [key: string]: string };
                                                                                  assetBucket?: Bucket;
                                                                                  assetDomainName?: string;
                                                                                  description?: string;
                                                                                  entry: string;
                                                                                  handler?: string;
                                                                                  includeSDK?: boolean;
                                                                                  jwt?: IJwtAuthentication;
                                                                                  lambdaOptions?: LambdaOptions;
                                                                                  lambdaTracing?: LambdaTracingOptions;
                                                                                  stageName?: string;
                                                                                  table?: ITable;
                                                                                  tableWrites?: boolean;
                                                                                  userPool?: IUserPool;
                                                                              }
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              Index
                                                                               +
                                                                              +
                                                                              + +
                                                                              additionalEnv? assetBucket? assetDomainName? description? @@ -12,29 +32,117 @@ table? tableWrites? userPool? -

                                                                              Properties

                                                                              additionalEnv?: { [key: string]: string }

                                                                              additional environment variables of the Lambda function

                                                                              -
                                                                              assetBucket?: Bucket

                                                                              Bucket that is used for assets and published using the asset CDN +

                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                              additionalEnv?: { [key: string]: string }
                                                                              +

                                                                              additional environment variables of the Lambda function

                                                                              +
                                                                              +
                                                                              + +
                                                                              assetBucket?: Bucket
                                                                              +

                                                                              Bucket that is used for assets and published using the asset CDN The name of the bucket is available as process.env.ASSET_BUCKET

                                                                              -
                                                                              assetDomainName?: string

                                                                              Fully qualified domain name of the asset CDN +

                                                                              +
                                                                              + +
                                                                              assetDomainName?: string
                                                                              +

                                                                              Fully qualified domain name of the asset CDN It is available as process.env.ASSET_DOMAIN_NAME

                                                                              -
                                                                              description?: string

                                                                              description of the Lambda function

                                                                              -

                                                                              entry

                                                                              entry: string

                                                                              entry file name

                                                                              -
                                                                              handler?: string

                                                                              name of the exported handler function

                                                                              -
                                                                              handler
+
                                                                              +
                                                                              + +
                                                                              description?: string
                                                                              +

                                                                              description of the Lambda function

                                                                              +
                                                                              +
                                                                              +

                                                                              entry

                                                                              +
                                                                              entry: string
                                                                              +

                                                                              entry file name

                                                                              +
                                                                              +
                                                                              + +
                                                                              handler?: string
                                                                              +

                                                                              name of the exported handler function

                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              handler
                                                                              -
                                                                              includeSDK?: boolean

                                                                              Should the AWS-SDK be packaged with the Lambda code or excluded

                                                                              -
                                                                              false (exclude SDK and use runtime provided one)
+
                                                                              +
                                                                              + +
                                                                              includeSDK?: boolean
                                                                              +

                                                                              Should the AWS-SDK be packaged with the Lambda code or excluded

                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              false (exclude SDK and use runtime provided one)
                                                                              -
                                                                              jwt?: IJwtAuthentication

                                                                              JwtAuthentication settings

                                                                              -
                                                                              lambdaOptions?: LambdaOptions

                                                                              additional options for the underlying Lambda function construct

                                                                              -
                                                                              lambdaTracing?: LambdaTracingOptions

                                                                              Tracing config

                                                                              -
                                                                              stageName?: string

                                                                              Deployment stage (e.g. dev)

                                                                              -
                                                                              table?: ITable

                                                                              DynamoDB that is used as datastore +

                                                                              +
                                                                              + +
                                                                              jwt?: IJwtAuthentication
                                                                              +

                                                                              JwtAuthentication settings

                                                                              +
                                                                              +
                                                                              + +
                                                                              lambdaOptions?: LambdaOptions
                                                                              +

                                                                              additional options for the underlying Lambda function construct

                                                                              +
                                                                              +
                                                                              + +
                                                                              lambdaTracing?: LambdaTracingOptions
                                                                              +

                                                                              Tracing config

                                                                              +
                                                                              +
                                                                              + +
                                                                              stageName?: string
                                                                              +

                                                                              Deployment stage (e.g. dev)

                                                                              +
                                                                              +
                                                                              + +
                                                                              table?: ITable
                                                                              +

                                                                              DynamoDB that is used as datastore The Lambda function will have read access to this table automatically The name of the table is available as process.env.TABLE

                                                                              -
                                                                              tableWrites?: boolean

                                                                              Activate write permissions to the DynamoDB table

                                                                              -
                                                                              userPool?: IUserPool

                                                                              Cognito user pool +

                                                                              +
                                                                              + +
                                                                              tableWrites?: boolean
                                                                              +

                                                                              Activate write permissions to the DynamoDB table

                                                                              +
                                                                              +
                                                                              + +
                                                                              userPool?: IUserPool
                                                                              +

                                                                              Cognito user pool The name of the pool is available as process.env.USER_POOL_ID

                                                                              -

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Properties
                                                                              + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Settings

                                                                               +
                                                                              +
                                                                              Member Visibility +
                                                                                +
                                                                                • +
                                                                                • +
                                                                              +
                                                                              +
                                                                              +

                                                                              On This Page

                                                                               +
                                                                              +
                                                                              Properties +
                                                                              +
                                                                              +
                                                                              +
                                                                              diff --git a/docs/constructs/interfaces/LambdaTracingOptions.html b/docs/constructs/interfaces/LambdaTracingOptions.html index 2042914..351c321 100644 --- a/docs/constructs/interfaces/LambdaTracingOptions.html +++ b/docs/constructs/interfaces/LambdaTracingOptions.html @@ -1,6 +1,59 @@ -LambdaTracingOptions | cdk-serverless
                                                                              cdk-serverless
                                                                                Preparing search index...

                                                                                Interface LambdaTracingOptions

                                                                                interface LambdaTracingOptions {
                                                                                    xRayTracing?: Tracing;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                xRayTracing? -

                                                                                Properties

                                                                                xRayTracing?: Tracing

                                                                                Activate tracing with X-Ray

                                                                                -
                                                                                lambda.Tracing.DISABLED
+LambdaTracingOptions | cdk-serverless
                                                                                
+
                                                                                cdk-serverless
+
+
                                                                                  
+
                                                                                  
+
                                                                                  Preparing search index...
                                                                                  
+
                                                                                  
+
                                                                                  
+
                                                                                  
+
+
                                                                                  Interface LambdaTracingOptions
                                                                                  
+
                                                                                  interface LambdaTracingOptions {
                                                                                      xRayTracing?: Tracing;
                                                                                  }
                                                                                  
+
                                                                                  
+
                                                                                  
+
                                                                                  
+
                                                                                  Index
                                                                                  
+
                                                                                  
+
                                                                                  
+
+
                                                                                  xRayTracing?
+
                                                                                  
+
                                                                                  
+
+
                                                                                  
+
                                                                                  
+
+
                                                                                  xRayTracing?: Tracing
                                                                                  
+
                                                                                  Activate tracing with X-Ray
                                                                                  
+
                                                                                  
+
                                                                                  
+
                                                                                  
+
                                                                                  lambda.Tracing.DISABLED
 
                                                                                  
 
-
                                                                                  Settings
                                                                                  Member Visibility
                                                                                  On This Page
                                                                                  Properties
                                                                                  
+
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Settings

                                                                                   +
                                                                                  +
                                                                                  Member Visibility +
                                                                                    +
                                                                                    • +
                                                                                    • +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  On This Page

                                                                                   +
                                                                                  +
                                                                                  Properties +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  diff --git a/docs/constructs/interfaces/RestApiProps.html b/docs/constructs/interfaces/RestApiProps.html index a644f35..75d1e0e 100644 --- a/docs/constructs/interfaces/RestApiProps.html +++ b/docs/constructs/interfaces/RestApiProps.html @@ -1,4 +1,34 @@ -RestApiProps | cdk-serverless
                                                                                  cdk-serverless
                                                                                    Preparing search index...

                                                                                    Interface RestApiProps<OPS>

                                                                                    interface RestApiProps<OPS> {
                                                                                        additionalEnv?: { [key: string]: string };
                                                                                        apiHostname?: string;
                                                                                        apiName: string;
                                                                                        assetCdn?: AssetCdn;
                                                                                        authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                                                        autoGenerateRoutes?: boolean;
                                                                                        cors: boolean;
                                                                                        definitionFileName: string;
                                                                                        domainName?: string;
                                                                                        hostedZone?: IHostedZone;
                                                                                        lambdaOptions?: LambdaOptions;
                                                                                        lambdaOptionsByOperation?: {
                                                                                            [operationId in string | number | symbol]?: LambdaOptions
                                                                                        };
                                                                                        lambdaTracing?: LambdaTracingOptions;
                                                                                        monitoring?: boolean;
                                                                                        restApiProps?: RestApiBaseProps;
                                                                                        singleTableDatastore?: ISingleTableDatastore;
                                                                                        stageName: string;
                                                                                    }

                                                                                    Type Parameters

                                                                                    • OPS

                                                                                    Hierarchy (View Summary)

                                                                                    Index

                                                                                    Properties

                                                                                    additionalEnv? +RestApiProps | cdk-serverless
                                                                                    +
                                                                                    cdk-serverless + +
                                                                                      +
                                                                                      +
                                                                                      Preparing search index...
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +

                                                                                      Interface RestApiProps<OPS>

                                                                                      +
                                                                                      interface RestApiProps<OPS> {
                                                                                          additionalEnv?: { [key: string]: string };
                                                                                          apiHostname?: string;
                                                                                          apiName: string;
                                                                                          assetCdn?: AssetCdn;
                                                                                          authentication?: IJwtAuthentication | ICognitoAuthentication;
                                                                                          autoGenerateRoutes?: boolean;
                                                                                          cors: boolean;
                                                                                          definitionFileName: string;
                                                                                          domainName?: string;
                                                                                          hostedZone?: IHostedZone;
                                                                                          lambdaOptions?: LambdaOptions;
                                                                                          lambdaOptionsByOperation?: {
                                                                                              [operationId in string | number | symbol]?: LambdaOptions
                                                                                          };
                                                                                          lambdaTracing?: LambdaTracingOptions;
                                                                                          monitoring?: boolean;
                                                                                          restApiProps?: RestApiBaseProps;
                                                                                          singleTableDatastore?: ISingleTableDatastore;
                                                                                          stageName: string;
                                                                                      }
                                                                                      +
                                                                                      +

                                                                                      Type Parameters

                                                                                      +
                                                                                        +
                                                                                      • OPS
                                                                                      +
                                                                                      +

                                                                                      Hierarchy (View Summary)

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      Index
                                                                                       +
                                                                                      +
                                                                                      + +
                                                                                      additionalEnv? apiHostname? apiName assetCdn? @@ -15,52 +45,185 @@ restApiProps? singleTableDatastore? stageName -

                                                                                      Properties

                                                                                      additionalEnv?: { [key: string]: string }

                                                                                      Additional environment variables of all Lambda functions

                                                                                      -
                                                                                      apiHostname?: string

                                                                                      Hostname of the API if a domain name is specified

                                                                                      -
                                                                                      api
+
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      additionalEnv?: { [key: string]: string }
                                                                                      +

                                                                                      Additional environment variables of all Lambda functions

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      apiHostname?: string
                                                                                      +

                                                                                      Hostname of the API if a domain name is specified

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      api
                                                                                      -
                                                                                      apiName: string

                                                                                      Name of the API

                                                                                      -
                                                                                      assetCdn?: AssetCdn

                                                                                      Configure a content delivery network for static assets

                                                                                      -
                                                                                      none
+
                                                                                      +
                                                                                      + +
                                                                                      apiName: string
                                                                                      +

                                                                                      Name of the API

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      assetCdn?: AssetCdn
                                                                                      +

                                                                                      Configure a content delivery network for static assets

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      none
                                                                                      -
                                                                                      authentication?: IJwtAuthentication | ICognitoAuthentication

                                                                                      Use a Cognito user pool for authorization. +

                                                                                      +
                                                                                      + +
                                                                                      authentication?: IJwtAuthentication | ICognitoAuthentication
                                                                                      +

                                                                                      Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

                                                                                      -
                                                                                      none
+
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      none
                                                                                      -
                                                                                      autoGenerateRoutes?: boolean

                                                                                      Generate routes for all endpoints configured in the openapi.yaml file

                                                                                      -
                                                                                      true
+
                                                                                      +
                                                                                      + +
                                                                                      autoGenerateRoutes?: boolean
                                                                                      +

                                                                                      Generate routes for all endpoints configured in the openapi.yaml file

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      true
                                                                                      -
                                                                                      cors: boolean
                                                                                      definitionFileName: string
                                                                                      domainName?: string

                                                                                      Domain name of the API (e.g. example.com)

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      cors: boolean
                                                                                      +
                                                                                      + +
                                                                                      definitionFileName: string
                                                                                      +
                                                                                      + +
                                                                                      domainName?: string
                                                                                      +

                                                                                      Domain name of the API (e.g. example.com)

                                                                                      only one of hostedZone and domainName can be specified

                                                                                      -
                                                                                      - No custom domain is configured
+
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      - No custom domain is configured
                                                                                      -
                                                                                      hostedZone?: IHostedZone

                                                                                      Hosted Zone of the API (e.g. example.com)

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      hostedZone?: IHostedZone
                                                                                      +

                                                                                      Hosted Zone of the API (e.g. example.com)

                                                                                      only one of hostedZone and domainName can be specified

                                                                                      -
                                                                                      - No custom domain is configured
+
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      - No custom domain is configured
                                                                                      -
                                                                                      lambdaOptions?: LambdaOptions

                                                                                      additional options for the underlying Lambda function construct

                                                                                      -
                                                                                      lambdaOptionsByOperation?: {
                                                                                          [operationId in string | number | symbol]?: LambdaOptions
                                                                                      }

                                                                                      additional options for the underlying Lambda function construct per operationId

                                                                                      -
                                                                                      -
+
                                                                                      +
                                                                                      + +
                                                                                      lambdaOptions?: LambdaOptions
                                                                                      +

                                                                                      additional options for the underlying Lambda function construct

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      lambdaOptionsByOperation?: {
                                                                                          [operationId in string | number | symbol]?: LambdaOptions
                                                                                      }
                                                                                      +

                                                                                      additional options for the underlying Lambda function construct per operationId

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      -
                                                                                      -
                                                                                      lambdaTracing?: LambdaTracingOptions

                                                                                      Tracing config for the generated Lambda functions

                                                                                      -
                                                                                      monitoring?: boolean

                                                                                      Configure CloudWatch Dashboard for the API and the Lambda functions

                                                                                      -
                                                                                      true
+
                                                                                      +
                                                                                      + +
                                                                                      lambdaTracing?: LambdaTracingOptions
                                                                                      +

                                                                                      Tracing config for the generated Lambda functions

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      monitoring?: boolean
                                                                                      +

                                                                                      Configure CloudWatch Dashboard for the API and the Lambda functions

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      true
                                                                                      -
                                                                                      restApiProps?: RestApiBaseProps

                                                                                      custom options for the created HttpApi

                                                                                      -
                                                                                      -
+
                                                                                      +
                                                                                      + +
                                                                                      restApiProps?: RestApiBaseProps
                                                                                      +

                                                                                      custom options for the created HttpApi

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      -
                                                                                      -
                                                                                      singleTableDatastore?: ISingleTableDatastore
                                                                                      none
+
                                                                                      +
                                                                                      + +
                                                                                      singleTableDatastore?: ISingleTableDatastore
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      none
                                                                                      -
                                                                                      stageName: string

                                                                                      Deployment stage (e.g. dev)

                                                                                      -

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Properties
                                                                                      + +
                                                                                      + +
                                                                                      stageName: string
                                                                                      +

                                                                                      Deployment stage (e.g. dev)

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Settings

                                                                                       +
                                                                                      +
                                                                                      Member Visibility +
                                                                                        +
                                                                                        • +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      On This Page

                                                                                       +
                                                                                      +
                                                                                      Properties +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      diff --git a/docs/constructs/interfaces/SingleTableDatastoreProps.html b/docs/constructs/interfaces/SingleTableDatastoreProps.html index 3682f5b..0c3a384 100644 --- a/docs/constructs/interfaces/SingleTableDatastoreProps.html +++ b/docs/constructs/interfaces/SingleTableDatastoreProps.html @@ -1,17 +1,85 @@ -SingleTableDatastoreProps | cdk-serverless
                                                                                      cdk-serverless
                                                                                        Preparing search index...

                                                                                        Interface SingleTableDatastoreProps

                                                                                        interface SingleTableDatastoreProps {
                                                                                            design: SingleTableDesign;
                                                                                            encryption?: TableEncryption;
                                                                                            encryptionKey?: IKey;
                                                                                        }
                                                                                        Index

                                                                                        Properties

                                                                                        design +SingleTableDatastoreProps | cdk-serverless
                                                                                        +
                                                                                        cdk-serverless + +
                                                                                          +
                                                                                          +
                                                                                          Preparing search index...
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + +

                                                                                          Interface SingleTableDatastoreProps

                                                                                          +
                                                                                          interface SingleTableDatastoreProps {
                                                                                              design: SingleTableDesign;
                                                                                              encryption?: TableEncryption;
                                                                                              encryptionKey?: IKey;
                                                                                          }
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          Index
                                                                                           +
                                                                                          +
                                                                                          + +
                                                                                          design encryption? encryptionKey? -

                                                                                          Properties

                                                                                          design: SingleTableDesign

                                                                                          Table design

                                                                                          -
                                                                                          encryption?: TableEncryption

                                                                                          Whether server-side encryption with an AWS managed customer master key is enabled.

                                                                                          -
                                                                                          - server-side encryption is enabled with an AWS owned customer master key
+
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + +
                                                                                          design: SingleTableDesign
                                                                                          +

                                                                                          Table design

                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          encryption?: TableEncryption
                                                                                          +

                                                                                          Whether server-side encryption with an AWS managed customer master key is enabled.

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          - server-side encryption is enabled with an AWS owned customer master key
                                                                                          -

                                                                                          stable

                                                                                          -
                                                                                          encryptionKey?: IKey

                                                                                          External KMS key to use for table encryption.

                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          stable

                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          encryptionKey?: IKey
                                                                                          +

                                                                                          External KMS key to use for table encryption.

                                                                                          This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

                                                                                          -
                                                                                            +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          • If encryption is set to TableEncryption.CUSTOMER_MANAGED and this property is undefined, a new KMS key will be created and associated with this table.
                                                                                          -

                                                                                          stable

                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Properties
                                                                                          + +
                                                                                          +

                                                                                          stable

                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Settings

                                                                                           +
                                                                                          +
                                                                                          Member Visibility +
                                                                                            +
                                                                                            • +
                                                                                            • +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          On This Page

                                                                                           +
                                                                                          +
                                                                                          Properties +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          diff --git a/docs/constructs/interfaces/SingleTableDesign.html b/docs/constructs/interfaces/SingleTableDesign.html index 63fce31..3a91152 100644 --- a/docs/constructs/interfaces/SingleTableDesign.html +++ b/docs/constructs/interfaces/SingleTableDesign.html @@ -1,12 +1,77 @@ -SingleTableDesign | cdk-serverless
                                                                                          cdk-serverless
                                                                                            Preparing search index...

                                                                                            Interface SingleTableDesign

                                                                                            interface SingleTableDesign {
                                                                                                globalIndexes?: GlobalSecondaryIndexProps[];
                                                                                                localIndexes?: LocalSecondaryIndexProps[];
                                                                                                primaryKey: { partitionKey: string; sortKey?: string };
                                                                                                timeToLiveAttribute?: string;
                                                                                            }
                                                                                            Index

                                                                                            Properties

                                                                                            globalIndexes? +SingleTableDesign | cdk-serverless
                                                                                            +
                                                                                            cdk-serverless + +
                                                                                              +
                                                                                              +
                                                                                              Preparing search index...
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + +

                                                                                              Interface SingleTableDesign

                                                                                              +
                                                                                              interface SingleTableDesign {
                                                                                                  globalIndexes?: GlobalSecondaryIndexProps[];
                                                                                                  localIndexes?: LocalSecondaryIndexProps[];
                                                                                                  primaryKey: { partitionKey: string; sortKey?: string };
                                                                                                  timeToLiveAttribute?: string;
                                                                                              }
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              Index
                                                                                               +
                                                                                              +
                                                                                              + +
                                                                                              globalIndexes? localIndexes? primaryKey timeToLiveAttribute? -

                                                                                              Properties

                                                                                              globalIndexes?: GlobalSecondaryIndexProps[]

                                                                                              global secondary indexes

                                                                                              -
                                                                                              localIndexes?: LocalSecondaryIndexProps[]

                                                                                              local secondary indexes

                                                                                              -
                                                                                              primaryKey: { partitionKey: string; sortKey?: string }

                                                                                              structure of the primary key

                                                                                              -
                                                                                              timeToLiveAttribute?: string

                                                                                              The name of TTL attribute.

                                                                                              -
                                                                                              - TTL is disabled
+
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              globalIndexes?: GlobalSecondaryIndexProps[]
                                                                                              +

                                                                                              global secondary indexes

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              localIndexes?: LocalSecondaryIndexProps[]
                                                                                              +

                                                                                              local secondary indexes

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              primaryKey: { partitionKey: string; sortKey?: string }
                                                                                              +

                                                                                              structure of the primary key

                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              timeToLiveAttribute?: string
                                                                                              +

                                                                                              The name of TTL attribute.

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              - TTL is disabled
                                                                                              -

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Settings

                                                                                               +
                                                                                              +
                                                                                              Member Visibility +
                                                                                                +
                                                                                                • +
                                                                                                • +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              On This Page

                                                                                               +
                                                                                              +
                                                                                              Properties +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              diff --git a/docs/constructs/interfaces/VtlResolverOptions.html b/docs/constructs/interfaces/VtlResolverOptions.html index 8929fa3..dc3a826 100644 --- a/docs/constructs/interfaces/VtlResolverOptions.html +++ b/docs/constructs/interfaces/VtlResolverOptions.html @@ -1,8 +1,65 @@ -VtlResolverOptions | cdk-serverless
                                                                                              cdk-serverless
                                                                                                Preparing search index...

                                                                                                Interface VtlResolverOptions

                                                                                                interface VtlResolverOptions {
                                                                                                    dataSource: BaseDataSource;
                                                                                                    variables?: { [name: string]: string };
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                dataSource +VtlResolverOptions | cdk-serverless
                                                                                                +
                                                                                                cdk-serverless + +
                                                                                                  +
                                                                                                  +
                                                                                                  Preparing search index...
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + +

                                                                                                  Interface VtlResolverOptions

                                                                                                  +
                                                                                                  interface VtlResolverOptions {
                                                                                                      dataSource: BaseDataSource;
                                                                                                      variables?: { [name: string]: string };
                                                                                                  }
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Index
                                                                                                   +
                                                                                                  +
                                                                                                  + +
                                                                                                  dataSource variables? -

                                                                                                  Properties

                                                                                                  dataSource: BaseDataSource

                                                                                                  The datasource the VTL resolver targets

                                                                                                  -
                                                                                                  variables?: { [name: string]: string }

                                                                                                  string replacements to process on the VTL

                                                                                                  -
                                                                                                  no variable expansions
+
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                  dataSource: BaseDataSource
                                                                                                  +

                                                                                                  The datasource the VTL resolver targets

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  variables?: { [name: string]: string }
                                                                                                  +

                                                                                                  string replacements to process on the VTL

                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  no variable expansions
                                                                                                  -

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Settings

                                                                                                   +
                                                                                                  +
                                                                                                  Member Visibility +
                                                                                                    +
                                                                                                    • +
                                                                                                    • +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  On This Page

                                                                                                   +
                                                                                                  +
                                                                                                  Properties +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  diff --git a/docs/constructs/interfaces/WorkflowProps.html b/docs/constructs/interfaces/WorkflowProps.html index de3f981..9f2bd09 100644 --- a/docs/constructs/interfaces/WorkflowProps.html +++ b/docs/constructs/interfaces/WorkflowProps.html @@ -1,6 +1,67 @@ -WorkflowProps | cdk-serverless
                                                                                                  cdk-serverless
                                                                                                    Preparing search index...

                                                                                                    Interface WorkflowProps

                                                                                                    interface WorkflowProps {
                                                                                                        definitionFileName: string;
                                                                                                        definitionSubstitutions?: { [key: string]: string };
                                                                                                        loggingConfiguration?: LoggingConfigurationProperty;
                                                                                                        stateMachineType?: StateMachineType;
                                                                                                        tracingConfiguration?: TracingConfigurationProperty;
                                                                                                    }
                                                                                                    Index

                                                                                                    Properties

                                                                                                    definitionFileName +WorkflowProps | cdk-serverless
                                                                                                    +
                                                                                                    cdk-serverless + +
                                                                                                      +
                                                                                                      +
                                                                                                      Preparing search index...
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + +

                                                                                                      Interface WorkflowProps

                                                                                                      +
                                                                                                      interface WorkflowProps {
                                                                                                          definitionFileName: string;
                                                                                                          definitionSubstitutions?: { [key: string]: string };
                                                                                                          loggingConfiguration?: LoggingConfigurationProperty;
                                                                                                          stateMachineType?: StateMachineType;
                                                                                                          tracingConfiguration?: TracingConfigurationProperty;
                                                                                                      }
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      Index
                                                                                                       +
                                                                                                      +
                                                                                                      + +
                                                                                                      definitionFileName definitionSubstitutions? loggingConfiguration? stateMachineType? tracingConfiguration? -

                                                                                                      Properties

                                                                                                      definitionFileName: string
                                                                                                      definitionSubstitutions?: { [key: string]: string }
                                                                                                      loggingConfiguration?: LoggingConfigurationProperty
                                                                                                      stateMachineType?: StateMachineType
                                                                                                      tracingConfiguration?: TracingConfigurationProperty

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Properties
                                                                                                      +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      + +
                                                                                                      definitionFileName: string
                                                                                                      +
                                                                                                      + +
                                                                                                      definitionSubstitutions?: { [key: string]: string }
                                                                                                      +
                                                                                                      + +
                                                                                                      loggingConfiguration?: LoggingConfigurationProperty
                                                                                                      +
                                                                                                      + +
                                                                                                      stateMachineType?: StateMachineType
                                                                                                      +
                                                                                                      + +
                                                                                                      tracingConfiguration?: TracingConfigurationProperty
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Settings

                                                                                                       +
                                                                                                      +
                                                                                                      Member Visibility +
                                                                                                        +
                                                                                                        • +
                                                                                                        • +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      On This Page

                                                                                                       +
                                                                                                      +
                                                                                                      Properties +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      diff --git a/docs/constructs/modules.html b/docs/constructs/modules.html index 10f2443..514b0de 100644 --- a/docs/constructs/modules.html +++ b/docs/constructs/modules.html @@ -1 +1,44 @@ -cdk-serverless
                                                                                                      cdk-serverless
                                                                                                        Preparing search index...

                                                                                                          cdk-serverless

                                                                                                          Classes

                                                                                                          AssetCdn
                                                                                                          BaseApi
                                                                                                          CognitoAuthentication
                                                                                                          GraphQlApi
                                                                                                          LambdaFunction
                                                                                                          RestApi
                                                                                                          SingleTableDatastore
                                                                                                          Workflow

                                                                                                          Interfaces

                                                                                                          AssetCdnProps
                                                                                                          BaseApiProps
                                                                                                          CognitoAuthenticationProps
                                                                                                          GraphQlApiProps
                                                                                                          ICognitoAuthentication
                                                                                                          IJwtAuthentication
                                                                                                          ISingleTableDatastore
                                                                                                          JsResolverOptions
                                                                                                          LambdaFunctionProps
                                                                                                          LambdaTracingOptions
                                                                                                          RestApiProps
                                                                                                          SingleTableDatastoreProps
                                                                                                          SingleTableDesign
                                                                                                          VtlResolverOptions
                                                                                                          WorkflowProps

                                                                                                          Type Aliases

                                                                                                          LambdaOptions

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Classes
                                                                                                          Interfaces
                                                                                                          Type Aliases
                                                                                                          +cdk-serverless
                                                                                                          +
                                                                                                          cdk-serverless + +
                                                                                                            +
                                                                                                            +
                                                                                                            Preparing search index...
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                              +

                                                                                                              cdk-serverless

                                                                                                              +
                                                                                                              +
                                                                                                              AssetCdn
                                                                                                              BaseApi
                                                                                                              CognitoAuthentication
                                                                                                              GraphQlApi
                                                                                                              LambdaFunction
                                                                                                              RestApi
                                                                                                              SingleTableDatastore
                                                                                                              Workflow
                                                                                                              +
                                                                                                              +
                                                                                                              AssetCdnProps
                                                                                                              BaseApiProps
                                                                                                              CognitoAuthenticationProps
                                                                                                              GraphQlApiProps
                                                                                                              ICognitoAuthentication
                                                                                                              IJwtAuthentication
                                                                                                              ISingleTableDatastore
                                                                                                              JsResolverOptions
                                                                                                              LambdaFunctionProps
                                                                                                              LambdaTracingOptions
                                                                                                              RestApiProps
                                                                                                              SingleTableDatastoreProps
                                                                                                              SingleTableDesign
                                                                                                              VtlResolverOptions
                                                                                                              WorkflowProps
                                                                                                              +
                                                                                                              +
                                                                                                              LambdaOptions
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Settings

                                                                                                               +
                                                                                                              +
                                                                                                              Member Visibility +
                                                                                                                +
                                                                                                                • +
                                                                                                                • +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              On This Page

                                                                                                               +
                                                                                                              +
                                                                                                              Classes +
                                                                                                              +
                                                                                                              Interfaces +
                                                                                                              +
                                                                                                              Type Aliases +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              diff --git a/docs/constructs/types/LambdaOptions.html b/docs/constructs/types/LambdaOptions.html index 1d040b3..9253b37 100644 --- a/docs/constructs/types/LambdaOptions.html +++ b/docs/constructs/types/LambdaOptions.html @@ -1 +1,31 @@ -LambdaOptions | cdk-serverless
                                                                                                              cdk-serverless
                                                                                                                Preparing search index...

                                                                                                                Type Alias LambdaOptions

                                                                                                                LambdaOptions: Omit<
                                                                                                                    lambdaNodejs.NodejsFunctionProps,
                                                                                                                    "entry"
                                                                                                                    | "handler"
                                                                                                                    | "description",
                                                                                                                >

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                +LambdaOptions | cdk-serverless
                                                                                                                +
                                                                                                                cdk-serverless + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Preparing search index...
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +

                                                                                                                  Type Alias LambdaOptions

                                                                                                                  +
                                                                                                                  LambdaOptions: Omit<
                                                                                                                      lambdaNodejs.NodejsFunctionProps,
                                                                                                                      "entry"
                                                                                                                      | "handler"
                                                                                                                      | "description",
                                                                                                                  >
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Settings

                                                                                                                   +
                                                                                                                  +
                                                                                                                  Member Visibility +
                                                                                                                    +
                                                                                                                    • +
                                                                                                                    • +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  diff --git a/docs/lambda/assets/highlight.css b/docs/lambda/assets/highlight.css index 72a5329..e12b856 100644 --- a/docs/lambda/assets/highlight.css +++ b/docs/lambda/assets/highlight.css @@ -89,4 +89,4 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } -pre, code { background: var(--code-background); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/lambda/assets/main.js b/docs/lambda/assets/main.js index 8182cee..b0eda9e 100644 --- a/docs/lambda/assets/main.js +++ b/docs/lambda/assets/main.js @@ -1,6 +1,6 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>{try{return e||t((e={exports:{}}).exports,e),e.exports}catch(n){throw e=0,n}};var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
                                                                                                                  ${e}
                                                                                                                  `:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); diff --git a/docs/lambda/assets/style.css b/docs/lambda/assets/style.css index 44328e9..ec257d5 100644 --- a/docs/lambda/assets/style.css +++ b/docs/lambda/assets/style.css @@ -504,8 +504,15 @@ body { background: var(--color-background); font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -531,6 +538,14 @@ scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); } + math[display="block"] { + position: relative; + padding: 10px; + border: 1px solid var(--color-accent); + border-radius: 0.8em; + margin-bottom: 8px; + } + code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; @@ -1047,7 +1062,7 @@ cursor: pointer; } - .tsd-accordion-summary a { + .tsd-accordion-summary > a { width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { diff --git a/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html index 04efcfb..bdf577f 100644 --- a/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html @@ -1,14 +1,48 @@ -ApiGatewayv1CognitoAuthorizer | cdk-serverless
                                                                                                                  cdk-serverless
                                                                                                                    Preparing search index...

                                                                                                                    Class ApiGatewayv1CognitoAuthorizer

                                                                                                                    ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer +ApiGatewayv1CognitoAuthorizer | cdk-serverless

                                                                                                                    +
                                                                                                                    cdk-serverless + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Preparing search index...
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      Class ApiGatewayv1CognitoAuthorizer

                                                                                                                      +
                                                                                                                      +

                                                                                                                      ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer and implements authentication logic for API Gateway v1 requests when using Cognito..

                                                                                                                      -

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      constructor -

                                                                                                                      Properties

                                                                                                                      _logger +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Index
                                                                                                                       +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      constructor +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      _logger adminClaim claims? event groupClaim issuerUrl jwksUrl? -

                                                                                                                      Methods

                                                                                                                      assertAdmin +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      assertAdmin assertAuthenticated assertGroup authenticate @@ -19,24 +53,217 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                      Constructors

                                                                                                                      Properties

                                                                                                                      Protected_logger

                                                                                                                      _logger: LambdaLog
                                                                                                                      adminClaim: string
                                                                                                                      claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                      The claims of the authenticated user.

                                                                                                                      -
                                                                                                                      event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                      groupClaim: string
                                                                                                                      issuerUrl: string
                                                                                                                      jwksUrl?: string

                                                                                                                      Methods

                                                                                                                      • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Protected_logger

                                                                                                                      +
                                                                                                                      _logger: LambdaLog
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      adminClaim: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                      +

                                                                                                                      The claims of the authenticated user.

                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      groupClaim: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      issuerUrl: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      jwksUrl?: string
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                        -

                                                                                                                        Parameters

                                                                                                                        • group: string

                                                                                                                          The name of the group to check.

                                                                                                                          -

                                                                                                                        Returns void

                                                                                                                      • Authenticates the user using the claims provided by the API Gateway event or +

                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

                                                                                                                        +
                                                                                                                          +
                                                                                                                        • group: string +

                                                                                                                          The name of the group to check.

                                                                                                                          +
                                                                                                                        +

                                                                                                                        Returns void

                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

                                                                                                                        -

                                                                                                                        Returns Promise<void>

                                                                                                                      • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                        +

                                                                                                                        Returns Promise<void>

                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                        -

                                                                                                                        Parameters

                                                                                                                        • name: string

                                                                                                                          The name of the claim to retrieve.

                                                                                                                          -

                                                                                                                        Returns string | number | boolean | string[] | undefined

                                                                                                                      • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

                                                                                                                        +
                                                                                                                          +
                                                                                                                        • name: string +

                                                                                                                          The name of the claim to retrieve.

                                                                                                                          +
                                                                                                                        +

                                                                                                                        Returns string | number | boolean | string[] | undefined

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                        -

                                                                                                                        Returns string[]

                                                                                                                      • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                        -

                                                                                                                        Parameters

                                                                                                                        • group: string

                                                                                                                          The name of the group to check.

                                                                                                                          -

                                                                                                                        Returns boolean

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Constructors
                                                                                                                      Properties
                                                                                                                      Methods
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Returns string[]

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                        +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

                                                                                                                        +
                                                                                                                          +
                                                                                                                        • group: string +

                                                                                                                          The name of the group to check.

                                                                                                                          +
                                                                                                                        +

                                                                                                                        Returns boolean

                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +

                                                                                                                        Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                        +
                                                                                                                        +

                                                                                                                        Returns boolean

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Settings

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Member Visibility +
                                                                                                                        +
                                                                                                                        • +
                                                                                                                        • +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      On This Page

                                                                                                                       +
                                                                                                                      +
                                                                                                                      Constructors +
                                                                                                                      +
                                                                                                                      Properties +
                                                                                                                      +
                                                                                                                      Methods +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      diff --git a/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html index 4a0eb27..ec77bae 100644 --- a/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html @@ -1,13 +1,49 @@ -ApiGatewayv1JwtAuthorizer | cdk-serverless
                                                                                                                      cdk-serverless
                                                                                                                        Preparing search index...

                                                                                                                        Class ApiGatewayv1JwtAuthorizer

                                                                                                                        Implements authorization on API Gateway v1 (Rest API) using JWT.

                                                                                                                        -

                                                                                                                        Hierarchy (View Summary)

                                                                                                                        Index

                                                                                                                        Constructors

                                                                                                                        constructor -

                                                                                                                        Properties

                                                                                                                        _logger +ApiGatewayv1JwtAuthorizer | cdk-serverless
                                                                                                                        +
                                                                                                                        cdk-serverless + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Preparing search index...
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +

                                                                                                                          Class ApiGatewayv1JwtAuthorizer

                                                                                                                          +
                                                                                                                          +

                                                                                                                          Implements authorization on API Gateway v1 (Rest API) using JWT.

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Index
                                                                                                                           +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          constructor +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          _logger adminClaim claims? event groupClaim issuerUrl jwksUrl? -

                                                                                                                          Methods

                                                                                                                          assertAdmin +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          assertAdmin assertAuthenticated assertGroup authenticate @@ -18,23 +54,214 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                          Constructors

                                                                                                                          Properties

                                                                                                                          Protected_logger

                                                                                                                          _logger: LambdaLog
                                                                                                                          adminClaim: string
                                                                                                                          claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                          The claims of the authenticated user.

                                                                                                                          -
                                                                                                                          event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                          groupClaim: string
                                                                                                                          issuerUrl: string
                                                                                                                          jwksUrl?: string

                                                                                                                          Methods

                                                                                                                          • Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                            -

                                                                                                                            Returns void

                                                                                                                          • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Protected_logger

                                                                                                                          +
                                                                                                                          _logger: LambdaLog
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          adminClaim: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                          +

                                                                                                                          The claims of the authenticated user.

                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          groupClaim: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          issuerUrl: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          jwksUrl?: string
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns void

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Throws an UnauthenticatedError if the user is not authenticated.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns void

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                            -

                                                                                                                            Parameters

                                                                                                                            • group: string

                                                                                                                              The name of the group to check.

                                                                                                                              -

                                                                                                                            Returns void

                                                                                                                          • Authenticates the user using the claims provided by the API Gateway event or +

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

                                                                                                                            +
                                                                                                                              +
                                                                                                                            • group: string +

                                                                                                                              The name of the group to check.

                                                                                                                              +
                                                                                                                            +

                                                                                                                            Returns void

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

                                                                                                                            -

                                                                                                                            Returns Promise<void>

                                                                                                                          • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                            +

                                                                                                                            Returns Promise<void>

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                            -

                                                                                                                            Parameters

                                                                                                                            • name: string

                                                                                                                              The name of the claim to retrieve.

                                                                                                                              -

                                                                                                                            Returns string | number | boolean | string[] | undefined

                                                                                                                          • Returns the email of the authenticated user.

                                                                                                                            -

                                                                                                                            Returns string

                                                                                                                          • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

                                                                                                                            +
                                                                                                                              +
                                                                                                                            • name: string +

                                                                                                                              The name of the claim to retrieve.

                                                                                                                              +
                                                                                                                            +

                                                                                                                            Returns string | number | boolean | string[] | undefined

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns the email of the authenticated user.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns string

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                            -

                                                                                                                            Returns string[]

                                                                                                                          • Returns the subject of the authenticated user.

                                                                                                                            -

                                                                                                                            Returns string

                                                                                                                          • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                            -

                                                                                                                            Parameters

                                                                                                                            • group: string

                                                                                                                              The name of the group to check.

                                                                                                                              -

                                                                                                                            Returns boolean

                                                                                                                          • Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                            -

                                                                                                                            Returns boolean

                                                                                                                          • Returns true if the user is authenticated, false otherwise.

                                                                                                                            -

                                                                                                                            Returns boolean

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Constructors
                                                                                                                          Properties
                                                                                                                          Methods
                                                                                                                          + +

                                                                                                                          Returns string[]

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns the subject of the authenticated user.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns string

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

                                                                                                                            +
                                                                                                                              +
                                                                                                                            • group: string +

                                                                                                                              The name of the group to check.

                                                                                                                              +
                                                                                                                            +

                                                                                                                            Returns boolean

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns boolean

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +

                                                                                                                            Returns true if the user is authenticated, false otherwise.

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Returns boolean

                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Settings

                                                                                                                           +
                                                                                                                          +
                                                                                                                          Member Visibility +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                            • +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          On This Page

                                                                                                                           +
                                                                                                                          +
                                                                                                                          Constructors +
                                                                                                                          +
                                                                                                                          Properties +
                                                                                                                          +
                                                                                                                          Methods +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          diff --git a/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html index 6222d10..822d18f 100644 --- a/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html @@ -1,15 +1,49 @@ -ApiGatewayv2CognitoAuthorizer | cdk-serverless
                                                                                                                          cdk-serverless
                                                                                                                            Preparing search index...

                                                                                                                            Class ApiGatewayv2CognitoAuthorizer

                                                                                                                            ApiGatewayv2CognitoAuthorizer is a class that extends CognitoAuthorizer +ApiGatewayv2CognitoAuthorizer | cdk-serverless

                                                                                                                            +
                                                                                                                            cdk-serverless + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Preparing search index...
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +

                                                                                                                              Class ApiGatewayv2CognitoAuthorizer

                                                                                                                              +
                                                                                                                              +

                                                                                                                              ApiGatewayv2CognitoAuthorizer is a class that extends CognitoAuthorizer and implements authentication logic for API Gateway v2 requests with a JWT authorizer.

                                                                                                                              -

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              constructor -

                                                                                                                              Properties

                                                                                                                              _logger +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Index
                                                                                                                               +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              constructor +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              _logger adminClaim claims? event groupClaim issuerUrl jwksUrl? -

                                                                                                                              Methods

                                                                                                                              assertAdmin +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              assertAdmin assertAuthenticated assertGroup authenticate @@ -20,24 +54,217 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              Protected_logger

                                                                                                                              _logger: LambdaLog
                                                                                                                              adminClaim: string
                                                                                                                              claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                              The claims of the authenticated user.

                                                                                                                              -
                                                                                                                              event: APIGatewayProxyEventV2WithJWTAuthorizer
                                                                                                                              groupClaim: string
                                                                                                                              issuerUrl: string
                                                                                                                              jwksUrl?: string

                                                                                                                              Methods

                                                                                                                              • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Protected_logger

                                                                                                                              +
                                                                                                                              _logger: LambdaLog
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              adminClaim: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                              +

                                                                                                                              The claims of the authenticated user.

                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              event: APIGatewayProxyEventV2WithJWTAuthorizer
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              groupClaim: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              issuerUrl: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              jwksUrl?: string
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                                -

                                                                                                                                Parameters

                                                                                                                                • group: string

                                                                                                                                  The name of the group to check.

                                                                                                                                  -

                                                                                                                                Returns void

                                                                                                                              • Authenticates the user using the claims provided by the API Gateway event or +

                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • group: string +

                                                                                                                                  The name of the group to check.

                                                                                                                                  +
                                                                                                                                +

                                                                                                                                Returns void

                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

                                                                                                                                -

                                                                                                                                Returns Promise<void>

                                                                                                                              • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                                +

                                                                                                                                Returns Promise<void>

                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                                -

                                                                                                                                Parameters

                                                                                                                                • name: string

                                                                                                                                  The name of the claim to retrieve.

                                                                                                                                  -

                                                                                                                                Returns string | number | boolean | string[] | undefined

                                                                                                                              • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • name: string +

                                                                                                                                  The name of the claim to retrieve.

                                                                                                                                  +
                                                                                                                                +

                                                                                                                                Returns string | number | boolean | string[] | undefined

                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                                -

                                                                                                                                Returns string[]

                                                                                                                              • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                -

                                                                                                                                Parameters

                                                                                                                                • group: string

                                                                                                                                  The name of the group to check.

                                                                                                                                  -

                                                                                                                                Returns boolean

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Constructors
                                                                                                                              Properties
                                                                                                                              Methods
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Returns string[]

                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

                                                                                                                                +
                                                                                                                                  +
                                                                                                                                • group: string +

                                                                                                                                  The name of the group to check.

                                                                                                                                  +
                                                                                                                                +

                                                                                                                                Returns boolean

                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +

                                                                                                                                Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                +
                                                                                                                                +

                                                                                                                                Returns boolean

                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Settings

                                                                                                                               +
                                                                                                                              +
                                                                                                                              Member Visibility +
                                                                                                                                +
                                                                                                                                • +
                                                                                                                                • +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +

                                                                                                                              On This Page

                                                                                                                               +
                                                                                                                              +
                                                                                                                              Constructors +
                                                                                                                              +
                                                                                                                              Properties +
                                                                                                                              +
                                                                                                                              Methods +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              diff --git a/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html index 60678c7..4b61c0a 100644 --- a/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html @@ -1,13 +1,49 @@ -ApiGatewayv2JwtAuthorizer | cdk-serverless
                                                                                                                              cdk-serverless
                                                                                                                                Preparing search index...

                                                                                                                                Class ApiGatewayv2JwtAuthorizer

                                                                                                                                Implements JWT Authorization on API Gateway v2 (HTTP API).

                                                                                                                                -

                                                                                                                                Hierarchy (View Summary)

                                                                                                                                Index

                                                                                                                                Constructors

                                                                                                                                constructor -

                                                                                                                                Properties

                                                                                                                                _logger +ApiGatewayv2JwtAuthorizer | cdk-serverless
                                                                                                                                +
                                                                                                                                cdk-serverless + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  Preparing search index...
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +

                                                                                                                                  Class ApiGatewayv2JwtAuthorizer

                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Implements JWT Authorization on API Gateway v2 (HTTP API).

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  Index
                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  constructor +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  _logger adminClaim claims? event groupClaim issuerUrl jwksUrl? -

                                                                                                                                  Methods

                                                                                                                                  assertAdmin +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  assertAdmin assertAuthenticated assertGroup authenticate @@ -18,23 +54,213 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  Protected_logger

                                                                                                                                  _logger: LambdaLog
                                                                                                                                  adminClaim: string
                                                                                                                                  claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                                  The claims of the authenticated user.

                                                                                                                                  -
                                                                                                                                  event: APIGatewayProxyEventV2WithJWTAuthorizer
                                                                                                                                  groupClaim: string
                                                                                                                                  issuerUrl: string
                                                                                                                                  jwksUrl?: string

                                                                                                                                  Methods

                                                                                                                                  • Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                    -

                                                                                                                                    Returns void

                                                                                                                                  • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Protected_logger

                                                                                                                                  +
                                                                                                                                  _logger: LambdaLog
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  adminClaim: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                                  +

                                                                                                                                  The claims of the authenticated user.

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  event: APIGatewayProxyEventV2WithJWTAuthorizer
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  groupClaim: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  issuerUrl: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  jwksUrl?: string
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns void

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Throws an UnauthenticatedError if the user is not authenticated.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns void

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • group: string

                                                                                                                                      The name of the group to check.

                                                                                                                                      -

                                                                                                                                    Returns void

                                                                                                                                  • Authenticates the user using the claims provided by the API Gateway event or +

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • group: string +

                                                                                                                                      The name of the group to check.

                                                                                                                                      +
                                                                                                                                    +

                                                                                                                                    Returns void

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

                                                                                                                                    -

                                                                                                                                    Returns Promise<void>

                                                                                                                                  • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                                    +

                                                                                                                                    Returns Promise<void>

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • name: string

                                                                                                                                      The name of the claim to retrieve.

                                                                                                                                      -

                                                                                                                                    Returns string | number | boolean | string[] | undefined

                                                                                                                                  • Returns the email of the authenticated user.

                                                                                                                                    -

                                                                                                                                    Returns string

                                                                                                                                  • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • name: string +

                                                                                                                                      The name of the claim to retrieve.

                                                                                                                                      +
                                                                                                                                    +

                                                                                                                                    Returns string | number | boolean | string[] | undefined

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns the email of the authenticated user.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns string

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                                    -

                                                                                                                                    Returns string[]

                                                                                                                                  • Returns the subject of the authenticated user.

                                                                                                                                    -

                                                                                                                                    Returns string

                                                                                                                                  • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                    -

                                                                                                                                    Parameters

                                                                                                                                    • group: string

                                                                                                                                      The name of the group to check.

                                                                                                                                      -

                                                                                                                                    Returns boolean

                                                                                                                                  • Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                    -

                                                                                                                                    Returns boolean

                                                                                                                                  • Returns true if the user is authenticated, false otherwise.

                                                                                                                                    -

                                                                                                                                    Returns boolean

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Constructors
                                                                                                                                  Properties
                                                                                                                                  Methods
                                                                                                                                  + +

                                                                                                                                  Returns string[]

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns the subject of the authenticated user.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns string

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • group: string +

                                                                                                                                      The name of the group to check.

                                                                                                                                      +
                                                                                                                                    +

                                                                                                                                    Returns boolean

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns boolean

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +

                                                                                                                                    Returns true if the user is authenticated, false otherwise.

                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Returns boolean

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Settings

                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  Member Visibility +
                                                                                                                                    +
                                                                                                                                    • +
                                                                                                                                    • +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  On This Page

                                                                                                                                   +
                                                                                                                                  +
                                                                                                                                  Constructors +
                                                                                                                                  +
                                                                                                                                  Properties +
                                                                                                                                  +
                                                                                                                                  Methods +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  diff --git a/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html b/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html index 58d8626..29fe575 100644 --- a/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +++ b/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html @@ -1,14 +1,48 @@ -AppSyncCognitoAuthorizer | cdk-serverless
                                                                                                                                  cdk-serverless
                                                                                                                                    Preparing search index...

                                                                                                                                    Class AppSyncCognitoAuthorizer

                                                                                                                                    AppSyncCognitoAuthorizer is a class that extends CognitoAuthorizer +AppSyncCognitoAuthorizer | cdk-serverless

                                                                                                                                    +
                                                                                                                                    cdk-serverless + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Preparing search index...
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +

                                                                                                                                      Class AppSyncCognitoAuthorizer

                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      AppSyncCognitoAuthorizer is a class that extends CognitoAuthorizer and implements authentication logic for AppSync resolver events with a Cognito authorizer.

                                                                                                                                      -

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      constructor -

                                                                                                                                      Properties

                                                                                                                                      adminClaim +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Index
                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      constructor +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      adminClaim claims? event groupClaim issuerUrl jwksUrl? -

                                                                                                                                      Methods

                                                                                                                                      assertAdmin +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      assertAdmin assertAuthenticated assertGroup authenticate @@ -19,23 +53,210 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      adminClaim: string
                                                                                                                                      claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                                      The claims of the authenticated user.

                                                                                                                                      -
                                                                                                                                      event: AppSyncResolverEvent<any>
                                                                                                                                      groupClaim: string
                                                                                                                                      issuerUrl: string
                                                                                                                                      jwksUrl?: string

                                                                                                                                      Methods

                                                                                                                                      • Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                        -

                                                                                                                                        Returns void

                                                                                                                                      • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      adminClaim: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                                      +

                                                                                                                                      The claims of the authenticated user.

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      event: AppSyncResolverEvent<any>
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      groupClaim: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      issuerUrl: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      jwksUrl?: string
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns void

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                                        -

                                                                                                                                        Parameters

                                                                                                                                        • group: string

                                                                                                                                          The name of the group to check.

                                                                                                                                          -

                                                                                                                                        Returns void

                                                                                                                                      • Authenticates the user using the claims provided by the AppSync event.

                                                                                                                                        -

                                                                                                                                        Returns Promise<void>

                                                                                                                                      • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Parameters

                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • group: string +

                                                                                                                                          The name of the group to check.

                                                                                                                                          +
                                                                                                                                        +

                                                                                                                                        Returns void

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Authenticates the user using the claims provided by the AppSync event.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns Promise<void>

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                                        -

                                                                                                                                        Parameters

                                                                                                                                        • name: string

                                                                                                                                          The name of the claim to retrieve.

                                                                                                                                          -

                                                                                                                                        Returns string | number | boolean | string[] | undefined

                                                                                                                                      • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Parameters

                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • name: string +

                                                                                                                                          The name of the claim to retrieve.

                                                                                                                                          +
                                                                                                                                        +

                                                                                                                                        Returns string | number | boolean | string[] | undefined

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns the email of the authenticated user.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns string

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                                        -

                                                                                                                                        Returns string[]

                                                                                                                                      • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                        -

                                                                                                                                        Parameters

                                                                                                                                        • group: string

                                                                                                                                          The name of the group to check.

                                                                                                                                          -

                                                                                                                                        Returns boolean

                                                                                                                                      • Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                        -

                                                                                                                                        Returns boolean

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Constructors
                                                                                                                                      Properties
                                                                                                                                      Methods
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Returns string[]

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns the subject of the authenticated user.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns string

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Parameters

                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                        • group: string +

                                                                                                                                          The name of the group to check.

                                                                                                                                          +
                                                                                                                                        +

                                                                                                                                        Returns boolean

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns boolean

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +

                                                                                                                                        Returns true if the user is authenticated, false otherwise.

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Returns boolean

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Settings

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Member Visibility +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                        • +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      On This Page

                                                                                                                                       +
                                                                                                                                      +
                                                                                                                                      Constructors +
                                                                                                                                      +
                                                                                                                                      Properties +
                                                                                                                                      +
                                                                                                                                      Methods +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      diff --git a/docs/lambda/classes/auth.CognitoAuthorizer.html b/docs/lambda/classes/auth.CognitoAuthorizer.html index 68ddebc..d97cc4c 100644 --- a/docs/lambda/classes/auth.CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.CognitoAuthorizer.html @@ -1,12 +1,48 @@ -CognitoAuthorizer | cdk-serverless
                                                                                                                                      cdk-serverless
                                                                                                                                        Preparing search index...

                                                                                                                                        Class CognitoAuthorizerAbstract

                                                                                                                                        CognitoAuthorizer is an abstract class representing an authorizer +CognitoAuthorizer | cdk-serverless

                                                                                                                                        +
                                                                                                                                        cdk-serverless + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Preparing search index...
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +

                                                                                                                                          Class CognitoAuthorizerAbstract

                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          CognitoAuthorizer is an abstract class representing an authorizer that can be used to authenticate and authorize a user through Cognito.

                                                                                                                                          -

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor -

                                                                                                                                          Properties

                                                                                                                                          adminClaim +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Index
                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          constructor +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          adminClaim claims? groupClaim issuerUrl jwksUrl? -

                                                                                                                                          Methods

                                                                                                                                          assertAdmin +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          assertAdmin assertAuthenticated assertGroup authenticate @@ -17,22 +53,201 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                                          Constructors

                                                                                                                                          Properties

                                                                                                                                          adminClaim: string
                                                                                                                                          claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                                          The claims of the authenticated user.

                                                                                                                                          -
                                                                                                                                          groupClaim: string
                                                                                                                                          issuerUrl: string
                                                                                                                                          jwksUrl?: string

                                                                                                                                          Methods

                                                                                                                                          • Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                            -

                                                                                                                                            Returns void

                                                                                                                                          • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          adminClaim: string
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                                          +

                                                                                                                                          The claims of the authenticated user.

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          groupClaim: string
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          issuerUrl: string
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          jwksUrl?: string
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns void

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Throws an UnauthenticatedError if the user is not authenticated.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns void

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • group: string

                                                                                                                                              The name of the group to check.

                                                                                                                                              -

                                                                                                                                            Returns void

                                                                                                                                          • Authenticates the user and sets the claims.

                                                                                                                                            -

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                            • group: string +

                                                                                                                                              The name of the group to check.

                                                                                                                                              +
                                                                                                                                            +

                                                                                                                                            Returns void

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Authenticates the user and sets the claims.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns Promise<void>

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • name: string

                                                                                                                                              The name of the claim to retrieve.

                                                                                                                                              -

                                                                                                                                            Returns string | number | boolean | string[] | undefined

                                                                                                                                          • Returns the email of the authenticated user.

                                                                                                                                            -

                                                                                                                                            Returns string

                                                                                                                                          • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                            • name: string +

                                                                                                                                              The name of the claim to retrieve.

                                                                                                                                              +
                                                                                                                                            +

                                                                                                                                            Returns string | number | boolean | string[] | undefined

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns the email of the authenticated user.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns string

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                                            -

                                                                                                                                            Returns string[]

                                                                                                                                          • Returns the subject of the authenticated user.

                                                                                                                                            -

                                                                                                                                            Returns string

                                                                                                                                          • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • group: string

                                                                                                                                              The name of the group to check.

                                                                                                                                              -

                                                                                                                                            Returns boolean

                                                                                                                                          • Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                            -

                                                                                                                                            Returns boolean

                                                                                                                                          • Returns true if the user is authenticated, false otherwise.

                                                                                                                                            -

                                                                                                                                            Returns boolean

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Constructors
                                                                                                                                          Properties
                                                                                                                                          Methods
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Returns string[]

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns the subject of the authenticated user.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns string

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                            • group: string +

                                                                                                                                              The name of the group to check.

                                                                                                                                              +
                                                                                                                                            +

                                                                                                                                            Returns boolean

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns boolean

                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                            +
                                                                                                                                          • + +
                                                                                                                                            +

                                                                                                                                            Returns true if the user is authenticated, false otherwise.

                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            Returns boolean

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Member Visibility +
                                                                                                                                            +
                                                                                                                                            • +
                                                                                                                                            • +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          On This Page

                                                                                                                                           +
                                                                                                                                          +
                                                                                                                                          Constructors +
                                                                                                                                          +
                                                                                                                                          Properties +
                                                                                                                                          +
                                                                                                                                          Methods +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/lambda/classes/auth.JwtAuthorizer.html b/docs/lambda/classes/auth.JwtAuthorizer.html index 483f5b6..5cdcc12 100644 --- a/docs/lambda/classes/auth.JwtAuthorizer.html +++ b/docs/lambda/classes/auth.JwtAuthorizer.html @@ -1,13 +1,49 @@ -JwtAuthorizer | cdk-serverless
                                                                                                                                          cdk-serverless
                                                                                                                                            Preparing search index...

                                                                                                                                            Class JwtAuthorizerAbstract

                                                                                                                                            A generic JWT authorizer base class, presupposing the presence of an issuer, a number of authorization claims, an +JwtAuthorizer | cdk-serverless

                                                                                                                                            +
                                                                                                                                            cdk-serverless + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Preparing search index...
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +

                                                                                                                                              Class JwtAuthorizerAbstract

                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              A generic JWT authorizer base class, presupposing the presence of an issuer, a number of authorization claims, an admin permission claim and optionally a separate URL to a JWKS to use if the issuers well-known URL does not point to it in its metadata.

                                                                                                                                              -

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              Index

                                                                                                                                              Constructors

                                                                                                                                              constructor -

                                                                                                                                              Properties

                                                                                                                                              adminClaim +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Index
                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              constructor +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              adminClaim claims? groupClaim issuerUrl jwksUrl? -

                                                                                                                                              Methods

                                                                                                                                              assertAdmin +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              assertAdmin assertAuthenticated assertGroup authenticate @@ -18,22 +54,191 @@ hasGroup isAdmin isAuthenticated -

                                                                                                                                              Constructors

                                                                                                                                              • Parameters

                                                                                                                                                • issuerUrl: string
                                                                                                                                                • groupClaim: string
                                                                                                                                                • adminClaim: string
                                                                                                                                                • OptionaljwksUrl: string

                                                                                                                                                Returns JwtAuthorizer

                                                                                                                                              Properties

                                                                                                                                              adminClaim: string
                                                                                                                                              claims?: { [name: string]: string | number | boolean | string[] }

                                                                                                                                              The claims of the authenticated user.

                                                                                                                                              -
                                                                                                                                              groupClaim: string
                                                                                                                                              issuerUrl: string
                                                                                                                                              jwksUrl?: string

                                                                                                                                              Methods

                                                                                                                                              • Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                                -

                                                                                                                                                Returns void

                                                                                                                                              • Throws an UnauthenticatedError if the user is not authenticated.

                                                                                                                                                -

                                                                                                                                                Returns void

                                                                                                                                              • Throws a ForbiddenError if the user is not authenticated or does not belong +

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Parameters

                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                • issuerUrl: string
                                                                                                                                                  • +
                                                                                                                                                • groupClaim: string
                                                                                                                                                  • +
                                                                                                                                                • adminClaim: string
                                                                                                                                                  • +
                                                                                                                                                • OptionaljwksUrl: string
                                                                                                                                                +

                                                                                                                                                Returns JwtAuthorizer

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              adminClaim: string
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              claims?: { [name: string]: string | number | boolean | string[] }
                                                                                                                                              +

                                                                                                                                              The claims of the authenticated user.

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              groupClaim: string
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              issuerUrl: string
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              jwksUrl?: string
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Throws a ForbiddenError if the user is not authenticated or is not an admin.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns void

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Throws an UnauthenticatedError if the user is not authenticated.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns void

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                • group: string

                                                                                                                                                  The name of the group to check.

                                                                                                                                                  -

                                                                                                                                                Returns void

                                                                                                                                              • Authenticates the user and sets the claims.

                                                                                                                                                -

                                                                                                                                                Returns Promise<void>

                                                                                                                                              • Returns the value of the claim with the specified name, or undefined if the +

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Parameters

                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                • group: string +

                                                                                                                                                  The name of the group to check.

                                                                                                                                                  +
                                                                                                                                                +

                                                                                                                                                Returns void

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Authenticates the user and sets the claims.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns Promise<void>

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns the value of the claim with the specified name, or undefined if the claim does not exist.

                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                • name: string

                                                                                                                                                  The name of the claim to retrieve.

                                                                                                                                                  -

                                                                                                                                                Returns string | number | boolean | string[] | undefined

                                                                                                                                              • Returns the email of the authenticated user.

                                                                                                                                                -

                                                                                                                                                Returns string

                                                                                                                                              • Returns an array of groups the user belongs to, or an empty array if the user +

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Parameters

                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                • name: string +

                                                                                                                                                  The name of the claim to retrieve.

                                                                                                                                                  +
                                                                                                                                                +

                                                                                                                                                Returns string | number | boolean | string[] | undefined

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns the email of the authenticated user.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns string

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

                                                                                                                                                -

                                                                                                                                                Returns string[]

                                                                                                                                              • Returns the subject of the authenticated user.

                                                                                                                                                -

                                                                                                                                                Returns string

                                                                                                                                              • Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                • group: string

                                                                                                                                                  The name of the group to check.

                                                                                                                                                  -

                                                                                                                                                Returns boolean

                                                                                                                                              • Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                                -

                                                                                                                                                Returns boolean

                                                                                                                                              • Returns true if the user is authenticated, false otherwise.

                                                                                                                                                -

                                                                                                                                                Returns boolean

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Constructors
                                                                                                                                              Properties
                                                                                                                                              Methods
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Returns string[]

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns the subject of the authenticated user.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns string

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns true if the user belongs to the specified group, false otherwise.

                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Parameters

                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                • group: string +

                                                                                                                                                  The name of the group to check.

                                                                                                                                                  +
                                                                                                                                                +

                                                                                                                                                Returns boolean

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns true if the user belongs to the 'admin' group, false otherwise.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns boolean

                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                                +
                                                                                                                                              • + +
                                                                                                                                                +

                                                                                                                                                Returns true if the user is authenticated, false otherwise.

                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Returns boolean

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Member Visibility +
                                                                                                                                                +
                                                                                                                                                • +
                                                                                                                                                • +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              On This Page

                                                                                                                                               +
                                                                                                                                              +
                                                                                                                                              Constructors +
                                                                                                                                              +
                                                                                                                                              Properties +
                                                                                                                                              +
                                                                                                                                              Methods +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              diff --git a/docs/lambda/classes/errors.BadRequestError.html b/docs/lambda/classes/errors.BadRequestError.html index 76bf61b..48db485 100644 --- a/docs/lambda/classes/errors.BadRequestError.html +++ b/docs/lambda/classes/errors.BadRequestError.html @@ -1,23 +1,109 @@ -BadRequestError | cdk-serverless
                                                                                                                                              cdk-serverless
                                                                                                                                                Preparing search index...

                                                                                                                                                Class BadRequestError

                                                                                                                                                Represents a 400 Bad Request error.

                                                                                                                                                -

                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                Index

                                                                                                                                                Constructors

                                                                                                                                                constructor -

                                                                                                                                                Properties

                                                                                                                                                message +BadRequestError | cdk-serverless
                                                                                                                                                +
                                                                                                                                                cdk-serverless + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Preparing search index...
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  Class BadRequestError

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Represents a 400 Bad Request error.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Index
                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  constructor +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  message name stack? statusCode stackTraceLimit -

                                                                                                                                                  Methods

                                                                                                                                                  captureStackTrace +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  captureStackTrace prepareStackTrace -

                                                                                                                                                  Constructors

                                                                                                                                                  Properties

                                                                                                                                                  message: string
                                                                                                                                                  name: string
                                                                                                                                                  stack?: string
                                                                                                                                                  statusCode: number

                                                                                                                                                  The HTTP status code for the error.

                                                                                                                                                  -
                                                                                                                                                  stackTraceLimit: number

                                                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  message: string
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  name: string
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  stack?: string
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  statusCode: number
                                                                                                                                                  +

                                                                                                                                                  The HTTP status code for the error.

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  stackTraceLimit: number
                                                                                                                                                  +

                                                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                                                                  -

                                                                                                                                                  Methods

                                                                                                                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                    +
                                                                                                                                                  • + +
                                                                                                                                                    +

                                                                                                                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                                                                    const myObject = {};
                                                                                                                                                    Error.captureStackTrace(myObject);
                                                                                                                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +119,55 @@
 
                                                                                                                                                    function a() {
                                                                                                                                                      b();
                                                                                                                                                    }

                                                                                                                                                    function b() {
                                                                                                                                                      c();
                                                                                                                                                    }

                                                                                                                                                    function c() {
                                                                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                                      const { stackTraceLimit } = Error;
                                                                                                                                                      Error.stackTraceLimit = 0;
                                                                                                                                                      const error = new Error();
                                                                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                                      // Capture the stack trace above function b
                                                                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                                      throw error;
                                                                                                                                                    }

                                                                                                                                                    a();
 
                                                                                                                                                    
 
-

                                                                                                                                                    Parameters

                                                                                                                                                    • targetObject: object
                                                                                                                                                    • OptionalconstructorOpt: Function

                                                                                                                                                    Returns void

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Constructors
                                                                                                                                                  Properties
                                                                                                                                                  Methods
                                                                                                                                                  + +
                                                                                                                                                  +

                                                                                                                                                  Parameters

                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                  • targetObject: object
                                                                                                                                                    • +
                                                                                                                                                  • OptionalconstructorOpt: Function
                                                                                                                                                  +

                                                                                                                                                  Returns void

                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  Member Visibility +
                                                                                                                                                    +
                                                                                                                                                    • +
                                                                                                                                                    • +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  On This Page

                                                                                                                                                   +
                                                                                                                                                  +
                                                                                                                                                  Constructors +
                                                                                                                                                  +
                                                                                                                                                  Properties +
                                                                                                                                                  +
                                                                                                                                                  Methods +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/lambda/classes/errors.ForbiddenError.html b/docs/lambda/classes/errors.ForbiddenError.html index 2e86e61..5e271f9 100644 --- a/docs/lambda/classes/errors.ForbiddenError.html +++ b/docs/lambda/classes/errors.ForbiddenError.html @@ -1,23 +1,109 @@ -ForbiddenError | cdk-serverless
                                                                                                                                                  cdk-serverless
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Class ForbiddenError

                                                                                                                                                    Represents a 403 Forbidden error.

                                                                                                                                                    -

                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                    Index

                                                                                                                                                    Constructors

                                                                                                                                                    constructor -

                                                                                                                                                    Properties

                                                                                                                                                    message +ForbiddenError | cdk-serverless
                                                                                                                                                    +
                                                                                                                                                    cdk-serverless + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Preparing search index...
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +

                                                                                                                                                      Class ForbiddenError

                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Represents a 403 Forbidden error.

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Index
                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      constructor +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      message name stack? statusCode stackTraceLimit -

                                                                                                                                                      Methods

                                                                                                                                                      captureStackTrace +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      captureStackTrace prepareStackTrace -

                                                                                                                                                      Constructors

                                                                                                                                                      Properties

                                                                                                                                                      message: string
                                                                                                                                                      name: string
                                                                                                                                                      stack?: string
                                                                                                                                                      statusCode: number

                                                                                                                                                      The HTTP status code for the error.

                                                                                                                                                      -
                                                                                                                                                      stackTraceLimit: number

                                                                                                                                                      The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      message: string
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      name: string
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      stack?: string
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      statusCode: number
                                                                                                                                                      +

                                                                                                                                                      The HTTP status code for the error.

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      stackTraceLimit: number
                                                                                                                                                      +

                                                                                                                                                      The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                                                                      If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                                                                      -

                                                                                                                                                      Methods

                                                                                                                                                      • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                        +
                                                                                                                                                      • + +
                                                                                                                                                        +

                                                                                                                                                        Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                                                                        const myObject = {};
                                                                                                                                                        Error.captureStackTrace(myObject);
                                                                                                                                                        myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +119,55 @@
 
                                                                                                                                                        function a() {
                                                                                                                                                          b();
                                                                                                                                                        }

                                                                                                                                                        function b() {
                                                                                                                                                          c();
                                                                                                                                                        }

                                                                                                                                                        function c() {
                                                                                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                                          const { stackTraceLimit } = Error;
                                                                                                                                                          Error.stackTraceLimit = 0;
                                                                                                                                                          const error = new Error();
                                                                                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                                          // Capture the stack trace above function b
                                                                                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                                          throw error;
                                                                                                                                                        }

                                                                                                                                                        a();
 
                                                                                                                                                        
 
-

                                                                                                                                                        Parameters

                                                                                                                                                        • targetObject: object
                                                                                                                                                        • OptionalconstructorOpt: Function

                                                                                                                                                        Returns void

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Constructors
                                                                                                                                                      Properties
                                                                                                                                                      Methods
                                                                                                                                                      + +
                                                                                                                                                      +

                                                                                                                                                      Parameters

                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • targetObject: object
                                                                                                                                                        • +
                                                                                                                                                      • OptionalconstructorOpt: Function
                                                                                                                                                      +

                                                                                                                                                      Returns void

                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Settings

                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      Member Visibility +
                                                                                                                                                        +
                                                                                                                                                        • +
                                                                                                                                                        • +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      On This Page

                                                                                                                                                       +
                                                                                                                                                      +
                                                                                                                                                      Constructors +
                                                                                                                                                      +
                                                                                                                                                      Properties +
                                                                                                                                                      +
                                                                                                                                                      Methods +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      diff --git a/docs/lambda/classes/errors.HttpError.html b/docs/lambda/classes/errors.HttpError.html index 54d51b9..e844056 100644 --- a/docs/lambda/classes/errors.HttpError.html +++ b/docs/lambda/classes/errors.HttpError.html @@ -1,24 +1,116 @@ -HttpError | cdk-serverless
                                                                                                                                                      cdk-serverless
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Class HttpError

                                                                                                                                                        A base class for HTTP errors.

                                                                                                                                                        -

                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                        Index

                                                                                                                                                        Constructors

                                                                                                                                                        constructor -

                                                                                                                                                        Properties

                                                                                                                                                        message +HttpError | cdk-serverless
                                                                                                                                                        +
                                                                                                                                                        cdk-serverless + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Preparing search index...
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +

                                                                                                                                                          Class HttpError

                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          A base class for HTTP errors.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Index
                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          constructor +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          message name stack? statusCode stackTraceLimit -

                                                                                                                                                          Methods

                                                                                                                                                          captureStackTrace +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          captureStackTrace prepareStackTrace -

                                                                                                                                                          Constructors

                                                                                                                                                          • Creates an instance of HttpError.

                                                                                                                                                            -

                                                                                                                                                            Parameters

                                                                                                                                                            • statusCode: number

                                                                                                                                                              The HTTP status code for the error.

                                                                                                                                                              -
                                                                                                                                                            • Optionalmessage: string

                                                                                                                                                              The error message.

                                                                                                                                                              -

                                                                                                                                                            Returns HttpError

                                                                                                                                                          Properties

                                                                                                                                                          message: string
                                                                                                                                                          name: string
                                                                                                                                                          stack?: string
                                                                                                                                                          statusCode: number

                                                                                                                                                          The HTTP status code for the error.

                                                                                                                                                          -
                                                                                                                                                          stackTraceLimit: number

                                                                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                            +
                                                                                                                                                          • + +
                                                                                                                                                            +

                                                                                                                                                            Creates an instance of HttpError.

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Parameters

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • statusCode: number +

                                                                                                                                                              The HTTP status code for the error.

                                                                                                                                                              +
                                                                                                                                                              • +
                                                                                                                                                            • Optionalmessage: string +

                                                                                                                                                              The error message.

                                                                                                                                                              +
                                                                                                                                                            +

                                                                                                                                                            Returns HttpError

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          message: string
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          name: string
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          stack?: string
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          statusCode: number
                                                                                                                                                          +

                                                                                                                                                          The HTTP status code for the error.

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          stackTraceLimit: number
                                                                                                                                                          +

                                                                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                                                                          If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                                                                          -

                                                                                                                                                          Methods

                                                                                                                                                          • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                            +
                                                                                                                                                          • + +
                                                                                                                                                            +

                                                                                                                                                            Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                                                                            const myObject = {};
                                                                                                                                                            Error.captureStackTrace(myObject);
                                                                                                                                                            myObject.stack;  // Similar to `new Error().stack`
@@ -34,5 +126,55 @@
 
                                                                                                                                                            function a() {
                                                                                                                                                              b();
                                                                                                                                                            }

                                                                                                                                                            function b() {
                                                                                                                                                              c();
                                                                                                                                                            }

                                                                                                                                                            function c() {
                                                                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                                              const { stackTraceLimit } = Error;
                                                                                                                                                              Error.stackTraceLimit = 0;
                                                                                                                                                              const error = new Error();
                                                                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                                              // Capture the stack trace above function b
                                                                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                                              throw error;
                                                                                                                                                            }

                                                                                                                                                            a();
 
                                                                                                                                                            
 
-

                                                                                                                                                            Parameters

                                                                                                                                                            • targetObject: object
                                                                                                                                                            • OptionalconstructorOpt: Function

                                                                                                                                                            Returns void

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Constructors
                                                                                                                                                          Properties
                                                                                                                                                          Methods
                                                                                                                                                          + +
                                                                                                                                                          +

                                                                                                                                                          Parameters

                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                          • targetObject: object
                                                                                                                                                            • +
                                                                                                                                                          • OptionalconstructorOpt: Function
                                                                                                                                                          +

                                                                                                                                                          Returns void

                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          Member Visibility +
                                                                                                                                                            +
                                                                                                                                                            • +
                                                                                                                                                            • +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          On This Page

                                                                                                                                                           +
                                                                                                                                                          +
                                                                                                                                                          Constructors +
                                                                                                                                                          +
                                                                                                                                                          Properties +
                                                                                                                                                          +
                                                                                                                                                          Methods +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/lambda/classes/errors.NotFoundError.html b/docs/lambda/classes/errors.NotFoundError.html index 7f34c72..57300d4 100644 --- a/docs/lambda/classes/errors.NotFoundError.html +++ b/docs/lambda/classes/errors.NotFoundError.html @@ -1,23 +1,109 @@ -NotFoundError | cdk-serverless
                                                                                                                                                          cdk-serverless
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Class NotFoundError

                                                                                                                                                            Represents a 404 Not Found error.

                                                                                                                                                            -

                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                            Index

                                                                                                                                                            Constructors

                                                                                                                                                            constructor -

                                                                                                                                                            Properties

                                                                                                                                                            message +NotFoundError | cdk-serverless
                                                                                                                                                            +
                                                                                                                                                            cdk-serverless + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Preparing search index...
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +

                                                                                                                                                              Class NotFoundError

                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Represents a 404 Not Found error.

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Index
                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              constructor +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              message name stack? statusCode stackTraceLimit -

                                                                                                                                                              Methods

                                                                                                                                                              captureStackTrace +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              captureStackTrace prepareStackTrace -

                                                                                                                                                              Constructors

                                                                                                                                                              Properties

                                                                                                                                                              message: string
                                                                                                                                                              name: string
                                                                                                                                                              stack?: string
                                                                                                                                                              statusCode: number

                                                                                                                                                              The HTTP status code for the error.

                                                                                                                                                              -
                                                                                                                                                              stackTraceLimit: number

                                                                                                                                                              The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              message: string
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              name: string
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              stack?: string
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              statusCode: number
                                                                                                                                                              +

                                                                                                                                                              The HTTP status code for the error.

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              stackTraceLimit: number
                                                                                                                                                              +

                                                                                                                                                              The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                                                                              If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                                                                              -

                                                                                                                                                              Methods

                                                                                                                                                              • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                                +
                                                                                                                                                              • + +
                                                                                                                                                                +

                                                                                                                                                                Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                                                                                const myObject = {};
                                                                                                                                                                Error.captureStackTrace(myObject);
                                                                                                                                                                myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +119,55 @@
 
                                                                                                                                                                function a() {
                                                                                                                                                                  b();
                                                                                                                                                                }

                                                                                                                                                                function b() {
                                                                                                                                                                  c();
                                                                                                                                                                }

                                                                                                                                                                function c() {
                                                                                                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                                                  const { stackTraceLimit } = Error;
                                                                                                                                                                  Error.stackTraceLimit = 0;
                                                                                                                                                                  const error = new Error();
                                                                                                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                                                  // Capture the stack trace above function b
                                                                                                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                                                  throw error;
                                                                                                                                                                }

                                                                                                                                                                a();
 
                                                                                                                                                                
 
-

                                                                                                                                                                Parameters

                                                                                                                                                                • targetObject: object
                                                                                                                                                                • OptionalconstructorOpt: Function

                                                                                                                                                                Returns void

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Constructors
                                                                                                                                                              Properties
                                                                                                                                                              Methods
                                                                                                                                                              + +
                                                                                                                                                              +

                                                                                                                                                              Parameters

                                                                                                                                                              +
                                                                                                                                                                +
                                                                                                                                                              • targetObject: object
                                                                                                                                                                • +
                                                                                                                                                              • OptionalconstructorOpt: Function
                                                                                                                                                              +

                                                                                                                                                              Returns void

                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              Member Visibility +
                                                                                                                                                                +
                                                                                                                                                                • +
                                                                                                                                                                • +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              On This Page

                                                                                                                                                               +
                                                                                                                                                              +
                                                                                                                                                              Constructors +
                                                                                                                                                              +
                                                                                                                                                              Properties +
                                                                                                                                                              +
                                                                                                                                                              Methods +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              diff --git a/docs/lambda/classes/errors.UnauthenticatedError.html b/docs/lambda/classes/errors.UnauthenticatedError.html index 787dfc8..be7f165 100644 --- a/docs/lambda/classes/errors.UnauthenticatedError.html +++ b/docs/lambda/classes/errors.UnauthenticatedError.html @@ -1,23 +1,109 @@ -UnauthenticatedError | cdk-serverless
                                                                                                                                                              cdk-serverless
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Class UnauthenticatedError

                                                                                                                                                                Represents a 401 Unauthenticated error.

                                                                                                                                                                -

                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                Index

                                                                                                                                                                Constructors

                                                                                                                                                                constructor -

                                                                                                                                                                Properties

                                                                                                                                                                message +UnauthenticatedError | cdk-serverless
                                                                                                                                                                +
                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Preparing search index...
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +

                                                                                                                                                                  Class UnauthenticatedError

                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Represents a 401 Unauthenticated error.

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Index
                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  constructor +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  message name stack? statusCode stackTraceLimit -

                                                                                                                                                                  Methods

                                                                                                                                                                  captureStackTrace +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  captureStackTrace prepareStackTrace -

                                                                                                                                                                  Constructors

                                                                                                                                                                  Properties

                                                                                                                                                                  message: string
                                                                                                                                                                  name: string
                                                                                                                                                                  stack?: string
                                                                                                                                                                  statusCode: number

                                                                                                                                                                  The HTTP status code for the error.

                                                                                                                                                                  -
                                                                                                                                                                  stackTraceLimit: number

                                                                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +

                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  message: string
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  name: string
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  stack?: string
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  statusCode: number
                                                                                                                                                                  +

                                                                                                                                                                  The HTTP status code for the error.

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  stackTraceLimit: number
                                                                                                                                                                  +

                                                                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

                                                                                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

                                                                                                                                                                  If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

                                                                                                                                                                  -

                                                                                                                                                                  Methods

                                                                                                                                                                  • Creates a .stack property on targetObject, which when accessed returns +

                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                    +
                                                                                                                                                                  • + +
                                                                                                                                                                    +

                                                                                                                                                                    Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

                                                                                                                                                                    const myObject = {};
                                                                                                                                                                    Error.captureStackTrace(myObject);
                                                                                                                                                                    myObject.stack;  // Similar to `new Error().stack`
@@ -33,5 +119,55 @@
 
                                                                                                                                                                    function a() {
                                                                                                                                                                      b();
                                                                                                                                                                    }

                                                                                                                                                                    function b() {
                                                                                                                                                                      c();
                                                                                                                                                                    }

                                                                                                                                                                    function c() {
                                                                                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                                                      const { stackTraceLimit } = Error;
                                                                                                                                                                      Error.stackTraceLimit = 0;
                                                                                                                                                                      const error = new Error();
                                                                                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                                                      // Capture the stack trace above function b
                                                                                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                                                      throw error;
                                                                                                                                                                    }

                                                                                                                                                                    a();
 
                                                                                                                                                                    
 
-

                                                                                                                                                                    Parameters

                                                                                                                                                                    • targetObject: object
                                                                                                                                                                    • OptionalconstructorOpt: Function

                                                                                                                                                                    Returns void

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Constructors
                                                                                                                                                                  Properties
                                                                                                                                                                  Methods
                                                                                                                                                                  + +
                                                                                                                                                                  +

                                                                                                                                                                  Parameters

                                                                                                                                                                  +
                                                                                                                                                                    +
                                                                                                                                                                  • targetObject: object
                                                                                                                                                                    • +
                                                                                                                                                                  • OptionalconstructorOpt: Function
                                                                                                                                                                  +

                                                                                                                                                                  Returns void

                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  Settings

                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  Member Visibility +
                                                                                                                                                                    +
                                                                                                                                                                    • +
                                                                                                                                                                    • +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  On This Page

                                                                                                                                                                   +
                                                                                                                                                                  +
                                                                                                                                                                  Constructors +
                                                                                                                                                                  +
                                                                                                                                                                  Properties +
                                                                                                                                                                  +
                                                                                                                                                                  Methods +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  diff --git a/docs/lambda/functions/api.createAppSyncHandler.html b/docs/lambda/functions/api.createAppSyncHandler.html index 83e709b..87de56c 100644 --- a/docs/lambda/functions/api.createAppSyncHandler.html +++ b/docs/lambda/functions/api.createAppSyncHandler.html @@ -1,4 +1,51 @@ -createAppSyncHandler | cdk-serverless
                                                                                                                                                                  cdk-serverless
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Function createAppSyncHandler

                                                                                                                                                                    • Creates an AppSync resolver handler from the given AppSyncHandler. +createAppSyncHandler | cdk-serverless

                                                                                                                                                                      +
                                                                                                                                                                      cdk-serverless + +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Preparing search index...
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + +

                                                                                                                                                                        Function createAppSyncHandler

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                          +
                                                                                                                                                                        • + +
                                                                                                                                                                          +

                                                                                                                                                                          Creates an AppSync resolver handler from the given AppSyncHandler. Returns a function that can be used as an AppSync resolver.

                                                                                                                                                                          -

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          • T
                                                                                                                                                                          • R

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns AppSyncResolverHandler<T, R>

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Type Parameters

                                                                                                                                                                        +
                                                                                                                                                                          +
                                                                                                                                                                        • T
                                                                                                                                                                          • +
                                                                                                                                                                        • R
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Parameters

                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Returns AppSyncResolverHandler<T, R>

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                       +
                                                                                                                                                                      +
                                                                                                                                                                      Member Visibility +
                                                                                                                                                                        +
                                                                                                                                                                        • +
                                                                                                                                                                        • +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      diff --git a/docs/lambda/functions/api.createHttpHandler.html b/docs/lambda/functions/api.createHttpHandler.html index 9ba2180..1b0c789 100644 --- a/docs/lambda/functions/api.createHttpHandler.html +++ b/docs/lambda/functions/api.createHttpHandler.html @@ -1,2 +1,48 @@ -createHttpHandler | cdk-serverless
                                                                                                                                                                      cdk-serverless
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function createHttpHandler

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        +createHttpHandler | cdk-serverless
                                                                                                                                                                        +
                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +

                                                                                                                                                                          Function createHttpHandler

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          Settings

                                                                                                                                                                           +
                                                                                                                                                                          +
                                                                                                                                                                          Member Visibility +
                                                                                                                                                                            +
                                                                                                                                                                            • +
                                                                                                                                                                            • +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          diff --git a/docs/lambda/functions/api.createOpenApiHandler.html b/docs/lambda/functions/api.createOpenApiHandler.html index a268dd6..140fc85 100644 --- a/docs/lambda/functions/api.createOpenApiHandler.html +++ b/docs/lambda/functions/api.createOpenApiHandler.html @@ -1,2 +1,48 @@ -createOpenApiHandler | cdk-serverless
                                                                                                                                                                          cdk-serverless
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function createOpenApiHandler

                                                                                                                                                                            • A factory function that creates an HTTP request handler for an OpenAPI operation.

                                                                                                                                                                              -

                                                                                                                                                                              Type Parameters

                                                                                                                                                                              Parameters

                                                                                                                                                                              • handler: HttpHandler<any, OP["responses"][SC]["content"]["application/json"]>

                                                                                                                                                                              Returns APIGatewayv1Handler

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility
                                                                                                                                                                            +createOpenApiHandler | cdk-serverless
                                                                                                                                                                            +
                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +

                                                                                                                                                                              Function createOpenApiHandler

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                              • + +
                                                                                                                                                                                +

                                                                                                                                                                                A factory function that creates an HTTP request handler for an OpenAPI operation.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Type Parameters

                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                • OP extends Operation
                                                                                                                                                                                  • +
                                                                                                                                                                                • SC extends number = 200
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                • handler: HttpHandler<any, OP["responses"][SC]["content"]["application/json"]>
                                                                                                                                                                                +

                                                                                                                                                                                Returns APIGatewayv1Handler

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Settings

                                                                                                                                                                               +
                                                                                                                                                                              +
                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html index eb2ac18..013b6c5 100644 --- a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +++ b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html @@ -1,2 +1,48 @@ -createOpenApiHandlerWithRequestBody | cdk-serverless
                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function createOpenApiHandlerWithRequestBody

                                                                                                                                                                                • A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.

                                                                                                                                                                                  -

                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  • handler: HttpHandler<
                                                                                                                                                                                        OP["requestBody"]["content"]["application/json"],
                                                                                                                                                                                        OP["responses"][SC]["content"]["application/json"],
                                                                                                                                                                                    >

                                                                                                                                                                                  Returns APIGatewayv1Handler

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                +createOpenApiHandlerWithRequestBody | cdk-serverless
                                                                                                                                                                                +
                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +

                                                                                                                                                                                  Function createOpenApiHandlerWithRequestBody

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • + +
                                                                                                                                                                                    +

                                                                                                                                                                                    A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    +
                                                                                                                                                                                      +
                                                                                                                                                                                    • handler: HttpHandler<
                                                                                                                                                                                          OP["requestBody"]["content"]["application/json"],
                                                                                                                                                                                          OP["responses"][SC]["content"]["application/json"],
                                                                                                                                                                                      >
                                                                                                                                                                                    +

                                                                                                                                                                                    Returns APIGatewayv1Handler

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Settings

                                                                                                                                                                                   +
                                                                                                                                                                                  +
                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                    +
                                                                                                                                                                                    • +
                                                                                                                                                                                    • +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  diff --git a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html index dae88f0..25be1c4 100644 --- a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +++ b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html @@ -1,2 +1,47 @@ -createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless
                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function createOpenApiHandlerWithRequestBodyNoResponse

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    +createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless
                                                                                                                                                                                    +
                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +

                                                                                                                                                                                      Function createOpenApiHandlerWithRequestBodyNoResponse

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Settings

                                                                                                                                                                                       +
                                                                                                                                                                                      +
                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                        +
                                                                                                                                                                                        • +
                                                                                                                                                                                        • +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      diff --git a/docs/lambda/hierarchy.html b/docs/lambda/hierarchy.html index 8b0f6fc..1a9c391 100644 --- a/docs/lambda/hierarchy.html +++ b/docs/lambda/hierarchy.html @@ -1 +1,52 @@ -cdk-serverless
                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        cdk-serverless

                                                                                                                                                                                        Hierarchy Summary

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        +cdk-serverless
                                                                                                                                                                                        +
                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          cdk-serverless

                                                                                                                                                                                          +

                                                                                                                                                                                          Hierarchy Summary

                                                                                                                                                                                          + + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                           +
                                                                                                                                                                                          +
                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                            +
                                                                                                                                                                                            • +
                                                                                                                                                                                            • +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          diff --git a/docs/lambda/index.html b/docs/lambda/index.html index 56722cd..b7a77e7 100644 --- a/docs/lambda/index.html +++ b/docs/lambda/index.html @@ -1,4 +1,14 @@ -cdk-serverless
                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            cdk-serverless

                                                                                                                                                                                            CDK Serverless

                                                                                                                                                                                            +cdk-serverless
                                                                                                                                                                                            +
                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              cdk-serverless

                                                                                                                                                                                              +

                                                                                                                                                                                              CDK Serverless

                                                                                                                                                                                              npm version

                                                                                                                                                                                              CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

                                                                                                                                                                                              Video introduction: https://www.youtube.com/watch?v=xhNJ0cXG3O8

                                                                                                                                                                                              @@ -136,4 +146,60 @@

                                                                                                                                                                                              Authors

                                                                                                                                                                                              Brought to you by Taimos

                                                                                                                                                                                              -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              CDK Serverless
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                               +
                                                                                                                                                                                              +
                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                +
                                                                                                                                                                                                • +
                                                                                                                                                                                                • +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              On This Page

                                                                                                                                                                                               +
                                                                                                                                                                                              CDK Serverless +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              diff --git a/docs/lambda/interfaces/api.AppSyncHandlerContext.html b/docs/lambda/interfaces/api.AppSyncHandlerContext.html index 7aa32fb..c7ce601 100644 --- a/docs/lambda/interfaces/api.AppSyncHandlerContext.html +++ b/docs/lambda/interfaces/api.AppSyncHandlerContext.html @@ -1,7 +1,72 @@ -AppSyncHandlerContext | cdk-serverless
                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface AppSyncHandlerContext<T>

                                                                                                                                                                                                The context for the AppSync resolver function. +AppSyncHandlerContext | cdk-serverless

                                                                                                                                                                                                +
                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  Interface AppSyncHandlerContext<T>

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  The context for the AppSync resolver function. Contains information about the event, lambda context, logger, and Cognito authorizer.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  interface AppSyncHandlerContext<T> {
                                                                                                                                                                                                      cognitoAuth: CognitoAuthorizer;
                                                                                                                                                                                                      event: AppSyncResolverEvent<T>;
                                                                                                                                                                                                      lambdaContext: Context;
                                                                                                                                                                                                      logger: LambdaLog;
                                                                                                                                                                                                  }

                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                  • T
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  cognitoAuth +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  interface AppSyncHandlerContext<T> {
                                                                                                                                                                                                      cognitoAuth: CognitoAuthorizer;
                                                                                                                                                                                                      event: AppSyncResolverEvent<T>;
                                                                                                                                                                                                      lambdaContext: Context;
                                                                                                                                                                                                      logger: LambdaLog;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                  +
                                                                                                                                                                                                    +
                                                                                                                                                                                                  • T
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Index
                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  cognitoAuth event lambdaContext logger -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  cognitoAuth: CognitoAuthorizer
                                                                                                                                                                                                  event: AppSyncResolverEvent<T>
                                                                                                                                                                                                  lambdaContext: Context
                                                                                                                                                                                                  logger: LambdaLog

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  cognitoAuth: CognitoAuthorizer
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  event: AppSyncResolverEvent<T>
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  lambdaContext: Context
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  logger: LambdaLog
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                   +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  diff --git a/docs/lambda/interfaces/api.HttpHandlerContext.html b/docs/lambda/interfaces/api.HttpHandlerContext.html index 583f809..647f171 100644 --- a/docs/lambda/interfaces/api.HttpHandlerContext.html +++ b/docs/lambda/interfaces/api.HttpHandlerContext.html @@ -1,7 +1,71 @@ -HttpHandlerContext | cdk-serverless
                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface HttpHandlerContext

                                                                                                                                                                                                    An object containing the properties for an HTTP request handler.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    interface HttpHandlerContext {
                                                                                                                                                                                                        auth: JwtAuthorizer;
                                                                                                                                                                                                        event: APIGatewayProxyWithCognitoAuthorizerEvent;
                                                                                                                                                                                                        lambdaContext: Context;
                                                                                                                                                                                                        logger: LambdaLog;
                                                                                                                                                                                                        response: HttpResponseContext;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    auth +HttpHandlerContext | cdk-serverless
                                                                                                                                                                                                    +
                                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      Interface HttpHandlerContext

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      An object containing the properties for an HTTP request handler.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface HttpHandlerContext {
                                                                                                                                                                                                          auth: JwtAuthorizer;
                                                                                                                                                                                                          event: APIGatewayProxyWithCognitoAuthorizerEvent;
                                                                                                                                                                                                          lambdaContext: Context;
                                                                                                                                                                                                          logger: LambdaLog;
                                                                                                                                                                                                          response: HttpResponseContext;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Index
                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      auth event lambdaContext logger response -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      auth: JwtAuthorizer
                                                                                                                                                                                                      event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                                                                                                      lambdaContext: Context
                                                                                                                                                                                                      logger: LambdaLog
                                                                                                                                                                                                      response: HttpResponseContext

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      auth: JwtAuthorizer
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      event: APIGatewayProxyWithCognitoAuthorizerEvent
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      lambdaContext: Context
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      logger: LambdaLog
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      response: HttpResponseContext
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                       +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      diff --git a/docs/lambda/interfaces/api.HttpResponseContext.html b/docs/lambda/interfaces/api.HttpResponseContext.html index e12884c..ed42ea0 100644 --- a/docs/lambda/interfaces/api.HttpResponseContext.html +++ b/docs/lambda/interfaces/api.HttpResponseContext.html @@ -1,5 +1,63 @@ -HttpResponseContext | cdk-serverless
                                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface HttpResponseContext

                                                                                                                                                                                                        An object containing the properties for an HTTP response.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        interface HttpResponseContext {
                                                                                                                                                                                                            headers: { [name: string]: string };
                                                                                                                                                                                                            json: boolean;
                                                                                                                                                                                                            statusCode?: number;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        headers +HttpResponseContext | cdk-serverless
                                                                                                                                                                                                        +
                                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Interface HttpResponseContext

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          An object containing the properties for an HTTP response.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface HttpResponseContext {
                                                                                                                                                                                                              headers: { [name: string]: string };
                                                                                                                                                                                                              json: boolean;
                                                                                                                                                                                                              statusCode?: number;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Index
                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          headers json statusCode? -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          headers: { [name: string]: string }
                                                                                                                                                                                                          json: boolean
                                                                                                                                                                                                          statusCode?: number

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          headers: { [name: string]: string }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          json: boolean
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          statusCode?: number
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                           +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          diff --git a/docs/lambda/interfaces/api.Operation.html b/docs/lambda/interfaces/api.Operation.html index fe296a8..f75e9ef 100644 --- a/docs/lambda/interfaces/api.Operation.html +++ b/docs/lambda/interfaces/api.Operation.html @@ -1,3 +1,61 @@ -Operation | cdk-serverless
                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface Operation

                                                                                                                                                                                                            An object containing the properties for an OpenAPI operation.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            interface Operation {
                                                                                                                                                                                                                responses: { [statusCode: number]: any };
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            responses -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            responses: { [statusCode: number]: any }

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            +Operation | cdk-serverless
                                                                                                                                                                                                            +
                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Interface Operation

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              An object containing the properties for an OpenAPI operation.

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              interface Operation {
                                                                                                                                                                                                                  responses: { [statusCode: number]: any };
                                                                                                                                                                                                              }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Index
                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              responses +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              responses: { [statusCode: number]: any }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                                • +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                               +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              diff --git a/docs/lambda/interfaces/api.OperationWithRequestBody.html b/docs/lambda/interfaces/api.OperationWithRequestBody.html index 06e2f1d..1cb71d7 100644 --- a/docs/lambda/interfaces/api.OperationWithRequestBody.html +++ b/docs/lambda/interfaces/api.OperationWithRequestBody.html @@ -1,4 +1,66 @@ -OperationWithRequestBody | cdk-serverless
                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface OperationWithRequestBody

                                                                                                                                                                                                                An object containing the properties for an OpenAPI operation with a request body.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                interface OperationWithRequestBody {
                                                                                                                                                                                                                    requestBody: { content: { "application/json": any } };
                                                                                                                                                                                                                    responses: { [statusCode: number]: any };
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                requestBody +OperationWithRequestBody | cdk-serverless
                                                                                                                                                                                                                +
                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Interface OperationWithRequestBody

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  An object containing the properties for an OpenAPI operation with a request body.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface OperationWithRequestBody {
                                                                                                                                                                                                                      requestBody: { content: { "application/json": any } };
                                                                                                                                                                                                                      responses: { [statusCode: number]: any };
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  requestBody responses -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  requestBody: { content: { "application/json": any } }
                                                                                                                                                                                                                  responses: { [statusCode: number]: any }

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  requestBody: { content: { "application/json": any } }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  responses: { [statusCode: number]: any }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                   +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  diff --git a/docs/lambda/modules.html b/docs/lambda/modules.html index 0aa78cf..4db9689 100644 --- a/docs/lambda/modules.html +++ b/docs/lambda/modules.html @@ -1 +1,36 @@ -cdk-serverless
                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                      cdk-serverless

                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                      api
                                                                                                                                                                                                                      auth
                                                                                                                                                                                                                      errors

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Namespaces
                                                                                                                                                                                                                      +cdk-serverless
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      cdk-serverless + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          cdk-serverless

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          api
                                                                                                                                                                                                                          auth
                                                                                                                                                                                                                          errors
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                           +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Namespaces +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          diff --git a/docs/lambda/modules/api.html b/docs/lambda/modules/api.html index bac3f14..91c006c 100644 --- a/docs/lambda/modules/api.html +++ b/docs/lambda/modules/api.html @@ -1 +1,45 @@ -api | cdk-serverless
                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Namespace api

                                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                                            AppSyncHandlerContext
                                                                                                                                                                                                                            HttpHandlerContext
                                                                                                                                                                                                                            HttpResponseContext
                                                                                                                                                                                                                            Operation
                                                                                                                                                                                                                            OperationWithRequestBody

                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                            APIGatewayv1Handler
                                                                                                                                                                                                                            AppSyncHandler
                                                                                                                                                                                                                            HttpHandler

                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                            createAppSyncHandler
                                                                                                                                                                                                                            createHttpHandler
                                                                                                                                                                                                                            createOpenApiHandler
                                                                                                                                                                                                                            createOpenApiHandlerWithRequestBody
                                                                                                                                                                                                                            createOpenApiHandlerWithRequestBodyNoResponse

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Interfaces
                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                            Functions
                                                                                                                                                                                                                            +api | cdk-serverless
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                              Namespace api

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              AppSyncHandlerContext
                                                                                                                                                                                                                              HttpHandlerContext
                                                                                                                                                                                                                              HttpResponseContext
                                                                                                                                                                                                                              Operation
                                                                                                                                                                                                                              OperationWithRequestBody
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              APIGatewayv1Handler
                                                                                                                                                                                                                              AppSyncHandler
                                                                                                                                                                                                                              HttpHandler
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              createAppSyncHandler
                                                                                                                                                                                                                              createHttpHandler
                                                                                                                                                                                                                              createOpenApiHandler
                                                                                                                                                                                                                              createOpenApiHandlerWithRequestBody
                                                                                                                                                                                                                              createOpenApiHandlerWithRequestBodyNoResponse
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                               +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Interfaces +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Type Aliases +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Functions +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              diff --git a/docs/lambda/modules/auth.html b/docs/lambda/modules/auth.html index 422ad42..f324901 100644 --- a/docs/lambda/modules/auth.html +++ b/docs/lambda/modules/auth.html @@ -1 +1,37 @@ -auth | cdk-serverless
                                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Namespace auth

                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                ApiGatewayv1CognitoAuthorizer
                                                                                                                                                                                                                                ApiGatewayv1JwtAuthorizer
                                                                                                                                                                                                                                ApiGatewayv2CognitoAuthorizer
                                                                                                                                                                                                                                ApiGatewayv2JwtAuthorizer
                                                                                                                                                                                                                                AppSyncCognitoAuthorizer
                                                                                                                                                                                                                                CognitoAuthorizer
                                                                                                                                                                                                                                JwtAuthorizer

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                +auth | cdk-serverless
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  Namespace auth

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  ApiGatewayv1CognitoAuthorizer
                                                                                                                                                                                                                                  ApiGatewayv1JwtAuthorizer
                                                                                                                                                                                                                                  ApiGatewayv2CognitoAuthorizer
                                                                                                                                                                                                                                  ApiGatewayv2JwtAuthorizer
                                                                                                                                                                                                                                  AppSyncCognitoAuthorizer
                                                                                                                                                                                                                                  CognitoAuthorizer
                                                                                                                                                                                                                                  JwtAuthorizer
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Classes +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  diff --git a/docs/lambda/modules/errors.html b/docs/lambda/modules/errors.html index 3a887fa..7d41bed 100644 --- a/docs/lambda/modules/errors.html +++ b/docs/lambda/modules/errors.html @@ -1 +1,37 @@ -errors | cdk-serverless
                                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Namespace errors

                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                    BadRequestError
                                                                                                                                                                                                                                    ForbiddenError
                                                                                                                                                                                                                                    HttpError
                                                                                                                                                                                                                                    NotFoundError
                                                                                                                                                                                                                                    UnauthenticatedError

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Classes
                                                                                                                                                                                                                                    +errors | cdk-serverless
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      Namespace errors

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      BadRequestError
                                                                                                                                                                                                                                      ForbiddenError
                                                                                                                                                                                                                                      HttpError
                                                                                                                                                                                                                                      NotFoundError
                                                                                                                                                                                                                                      UnauthenticatedError
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Classes +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      diff --git a/docs/lambda/types/api.APIGatewayv1Handler.html b/docs/lambda/types/api.APIGatewayv1Handler.html index 32fa313..37054c0 100644 --- a/docs/lambda/types/api.APIGatewayv1Handler.html +++ b/docs/lambda/types/api.APIGatewayv1Handler.html @@ -1,2 +1,34 @@ -APIGatewayv1Handler | cdk-serverless
                                                                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Type Alias APIGatewayv1Handler

                                                                                                                                                                                                                                        APIGatewayv1Handler: AWSLambda.Handler<
                                                                                                                                                                                                                                            AWSLambda.APIGatewayProxyWithCognitoAuthorizerEvent,
                                                                                                                                                                                                                                            AWSLambda.APIGatewayProxyResult
                                                                                                                                                                                                                                            | undefined,
                                                                                                                                                                                                                                        >

                                                                                                                                                                                                                                        A type definition for an API Gateway v1 request handler.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        +APIGatewayv1Handler | cdk-serverless
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          Type Alias APIGatewayv1Handler

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          APIGatewayv1Handler: AWSLambda.Handler<
                                                                                                                                                                                                                                              AWSLambda.APIGatewayProxyWithCognitoAuthorizerEvent,
                                                                                                                                                                                                                                              AWSLambda.APIGatewayProxyResult
                                                                                                                                                                                                                                              | undefined,
                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          A type definition for an API Gateway v1 request handler.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/lambda/types/api.AppSyncHandler.html b/docs/lambda/types/api.AppSyncHandler.html index 26c76a7..52ed749 100644 --- a/docs/lambda/types/api.AppSyncHandler.html +++ b/docs/lambda/types/api.AppSyncHandler.html @@ -1,3 +1,52 @@ -AppSyncHandler | cdk-serverless
                                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Type Alias AppSyncHandler<T, R>

                                                                                                                                                                                                                                            AppSyncHandler: (context: AppSyncHandlerContext<T>) => Promise<R>

                                                                                                                                                                                                                                            A function that handles an AppSync resolver event. +AppSyncHandler | cdk-serverless

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                              Type Alias AppSyncHandler<T, R>

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              AppSyncHandler: (context: AppSyncHandlerContext<T>) => Promise<R>
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              A function that handles an AppSync resolver event. Receives the context object and returns the response.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                              • R

                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              • R
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              diff --git a/docs/lambda/types/api.HttpHandler.html b/docs/lambda/types/api.HttpHandler.html index 3335d51..ab5205f 100644 --- a/docs/lambda/types/api.HttpHandler.html +++ b/docs/lambda/types/api.HttpHandler.html @@ -1,2 +1,52 @@ -HttpHandler | cdk-serverless
                                                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Type Alias HttpHandler<T, R>

                                                                                                                                                                                                                                                HttpHandler: (context: HttpHandlerContext, body: T) => Promise<R>

                                                                                                                                                                                                                                                A type definition for an HTTP handler.

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                • T
                                                                                                                                                                                                                                                • R

                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                +HttpHandler | cdk-serverless
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                  Type Alias HttpHandler<T, R>

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  HttpHandler: (context: HttpHandlerContext, body: T) => Promise<R>
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  A type definition for an HTTP handler.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  • R
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/projen/assets/highlight.css b/docs/projen/assets/highlight.css index 4399cff..253a6c2 100644 --- a/docs/projen/assets/highlight.css +++ b/docs/projen/assets/highlight.css @@ -103,4 +103,4 @@ .hl-9 { color: var(--hl-9); } .hl-10 { color: var(--hl-10); } .hl-11 { color: var(--hl-11); } -pre, code { background: var(--code-background); } +pre, code, math[display='block'] { background: var(--code-background); } diff --git a/docs/projen/assets/main.js b/docs/projen/assets/main.js index 8182cee..b0eda9e 100644 --- a/docs/projen/assets/main.js +++ b/docs/projen/assets/main.js @@ -1,6 +1,6 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; -"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>{try{return e||t((e={exports:{}}).exports,e),e.exports}catch(n){throw e=0,n}};var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
                                                                                                                                                                                                                                                  ${e}
                                                                                                                                                                                                                                                  `:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); diff --git a/docs/projen/assets/style.css b/docs/projen/assets/style.css index 44328e9..ec257d5 100644 --- a/docs/projen/assets/style.css +++ b/docs/projen/assets/style.css @@ -504,8 +504,15 @@ body { background: var(--color-background); font-family: - -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + "Noto Sans", + Helvetica, + Arial, + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); margin: 0; @@ -531,6 +538,14 @@ scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); } + math[display="block"] { + position: relative; + padding: 10px; + border: 1px solid var(--color-accent); + border-radius: 0.8em; + margin-bottom: 8px; + } + code, pre { font-family: Menlo, Monaco, Consolas, "Courier New", monospace; @@ -1047,7 +1062,7 @@ cursor: pointer; } - .tsd-accordion-summary a { + .tsd-accordion-summary > a { width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { diff --git a/docs/projen/classes/Datastore.html b/docs/projen/classes/Datastore.html index ad9c6d6..dce54a8 100644 --- a/docs/projen/classes/Datastore.html +++ b/docs/projen/classes/Datastore.html @@ -1,14 +1,50 @@ -Datastore | cdk-serverless
                                                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Class Datastore

                                                                                                                                                                                                                                                    The Datastore construct sets up a DynamoDB single-table design for a serverless project using projen. +Datastore | cdk-serverless

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      Class Datastore

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      The Datastore construct sets up a DynamoDB single-table design for a serverless project using projen. This construct extends the projen Component to include dependencies and development dependencies required for DynamoDB and provides methods to generate model and construct files based on a schema definition file.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      const datastore = new Datastore(app, {
                                                                                                                                                                                                                                                        modelName: 'User',
                                                                                                                                                                                                                                                        definitionFile: 'src/models/user.schema.json',
                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      const datastore = new Datastore(app, {
                                                                                                                                                                                                                                                        modelName: 'User',
                                                                                                                                                                                                                                                        definitionFile: 'src/models/user.schema.json',
                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      • Component
                                                                                                                                                                                                                                                        • Datastore
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                      constructor -

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      node +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • Component +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • Datastore
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      constructor +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      node options project -

                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                      createConstructFile +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      createConstructFile createModelFile postSynthesize preSynthesize @@ -17,20 +53,146 @@ with isComponent isConstruct -

                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      options: DatastoreOptions
                                                                                                                                                                                                                                                      project: Project

                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                        • file: FileBase

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                        • file: FileBase

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      • Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      • Called before synthesis.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      • Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      • Returns a string representation of this construct.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      • Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      node: Node
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      options: DatastoreOptions
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      project: Project
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • file: FileBase
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • file: FileBase
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Called before synthesis.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns a string representation of this construct.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                        Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • ...mixins: IMixin[]

                                                                                                                                                                                                                                                          The mixins to apply

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                        Returns IConstruct

                                                                                                                                                                                                                                                        This construct for chaining

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                      • Test whether the given construct is a component.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • x: any

                                                                                                                                                                                                                                                        Returns x is Component

                                                                                                                                                                                                                                                      • Checks if x is a construct.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • ...mixins: IMixin[] +

                                                                                                                                                                                                                                                          The mixins to apply

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns IConstruct

                                                                                                                                                                                                                                                        This construct for chaining

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Test whether the given construct is a component.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • x: any
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Returns x is Component

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Checks if x is a construct.

                                                                                                                                                                                                                                                        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                        Explanation: in JavaScript, multiple copies of the constructs library on @@ -43,6 +205,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • x: any

                                                                                                                                                                                                                                                          Any object

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                        Returns x is Construct

                                                                                                                                                                                                                                                        true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • x: any +

                                                                                                                                                                                                                                                        Any object

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Returns x is Construct

                                                                                                                                                                                                                                                      true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Constructors +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Methods +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/projen/classes/GraphQlApi.html b/docs/projen/classes/GraphQlApi.html index dad1859..e757234 100644 --- a/docs/projen/classes/GraphQlApi.html +++ b/docs/projen/classes/GraphQlApi.html @@ -1,36 +1,182 @@ -GraphQlApi | cdk-serverless
                                                                                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Class GraphQlApi

                                                                                                                                                                                                                                                        The GraphQlApi construct sets up a GraphQL API for a serverless project using projen. +GraphQlApi | cdk-serverless

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Class GraphQlApi

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          The GraphQlApi construct sets up a GraphQL API for a serverless project using projen. This construct extends the projen Component to include dependencies and development dependencies required for GraphQL and provides methods to generate TypeScript types and resolvers from a GraphQL schema definition file.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          const graphQlApi = new GraphQlApi(app, {
                                                                                                                                                                                                                                                            apiName: 'MyGraphQlApi',
                                                                                                                                                                                                                                                            definitionFile: 'src/graphql/schema.graphql',
                                                                                                                                                                                                                                                          });
+
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          const graphQlApi = new GraphQlApi(app, {
                                                                                                                                                                                                                                                            apiName: 'MyGraphQlApi',
                                                                                                                                                                                                                                                            definitionFile: 'src/graphql/schema.graphql',
                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          • Component
                                                                                                                                                                                                                                                            • GraphQlApi
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          constructor -

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codegenConfigFile +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • Component +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            • GraphQlApi
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          constructor +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          codegenConfigFile codegenConfigFileName node options project -

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          postSynthesize +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          postSynthesize preSynthesize synthesize toString with isComponent isConstruct -

                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          codegenConfigFile: YamlFile
                                                                                                                                                                                                                                                          codegenConfigFileName: string
                                                                                                                                                                                                                                                          node: Node

                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          options: GraphQlApiOptions
                                                                                                                                                                                                                                                          project: Project

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          • Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          • Called before synthesis.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          • Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          • Returns a string representation of this construct.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                          • Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          codegenConfigFile: YamlFile
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          codegenConfigFileName: string
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          node: Node
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          The tree node.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          options: GraphQlApiOptions
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          project: Project
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Called before synthesis.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns a string representation of this construct.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                            Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • ...mixins: IMixin[]

                                                                                                                                                                                                                                                              The mixins to apply

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                            Returns IConstruct

                                                                                                                                                                                                                                                            This construct for chaining

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                          • Test whether the given construct is a component.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • x: any

                                                                                                                                                                                                                                                            Returns x is Component

                                                                                                                                                                                                                                                          • Checks if x is a construct.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            • ...mixins: IMixin[] +

                                                                                                                                                                                                                                                              The mixins to apply

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns IConstruct

                                                                                                                                                                                                                                                            This construct for chaining

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Test whether the given construct is a component.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            • x: any
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Returns x is Component

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • + +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Checks if x is a construct.

                                                                                                                                                                                                                                                            Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                            Explanation: in JavaScript, multiple copies of the constructs library on @@ -43,6 +189,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • x: any

                                                                                                                                                                                                                                                              Any object

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                            Returns x is Construct

                                                                                                                                                                                                                                                            true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          • x: any +

                                                                                                                                                                                                                                                            Any object

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Returns x is Construct

                                                                                                                                                                                                                                                          true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Constructors +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Methods +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/projen/classes/RestApi.html b/docs/projen/classes/RestApi.html index 1db273d..56c2406 100644 --- a/docs/projen/classes/RestApi.html +++ b/docs/projen/classes/RestApi.html @@ -1,14 +1,50 @@ -RestApi | cdk-serverless
                                                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Class RestApi

                                                                                                                                                                                                                                                            The RestApi construct sets up an OpenAPI-based REST API for a serverless project using projen. +RestApi | cdk-serverless

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Class RestApi

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The RestApi construct sets up an OpenAPI-based REST API for a serverless project using projen. This construct extends the projen Component to include dependencies and development dependencies required for OpenAPI and AWS Lambda, and provides methods to generate TypeScript types from the OpenAPI definition file. It also generates sample handler files for the API endpoints.

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              const restApi = new RestApi(app, {
                                                                                                                                                                                                                                                                apiName: 'MyRestApi',
                                                                                                                                                                                                                                                                definitionFile: 'src/openapi/schema.yaml',
                                                                                                                                                                                                                                                              });
+
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              const restApi = new RestApi(app, {
                                                                                                                                                                                                                                                                apiName: 'MyRestApi',
                                                                                                                                                                                                                                                                definitionFile: 'src/openapi/schema.yaml',
                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                              • Component
                                                                                                                                                                                                                                                                • RestApi
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                              constructor -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              node +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • Component +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • RestApi
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              constructor +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              node options project -

                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                              addRestResourceHandlerSample +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              addRestResourceHandlerSample createConstructFile createEntryFile postSynthesize @@ -19,42 +55,217 @@ with isComponent isConstruct -

                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                              • Creates an instance of RestApi.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • app: AwsCdkTypeScriptApp

                                                                                                                                                                                                                                                                  The AWS CDK TypeScript app.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • options: RestApiOptions

                                                                                                                                                                                                                                                                  The options for configuring the RestApi.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns RestApi

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              node: Node

                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              options: RestApiOptions

                                                                                                                                                                                                                                                              The options for configuring the RestApi.

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              project: Project

                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                              • Adds a sample handler file for a REST API resource.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • files: { [fileName: string]: () => string }

                                                                                                                                                                                                                                                                  The collection of file generators.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • apiSpec: OpenAPI3

                                                                                                                                                                                                                                                                  The OpenAPI specification object.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • path: string

                                                                                                                                                                                                                                                                  The path of the API resource.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • method: string

                                                                                                                                                                                                                                                                  The HTTP method of the API resource.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              • Creates the construct file content for the generated REST API.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • file: FileBase

                                                                                                                                                                                                                                                                  The file object to create content for.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                The content of the construct file.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              • Creates the entry file content for a REST API handler.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • method: string

                                                                                                                                                                                                                                                                  The HTTP method of the API resource.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • operationId: string

                                                                                                                                                                                                                                                                  The operation ID of the API resource.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                The content of the entry file.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              • Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              • Called before synthesis.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              • Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                              • Validates a path reference in the OpenAPI specification.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • apiSpec: OpenAPI3

                                                                                                                                                                                                                                                                  The OpenAPI specification object.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • path: string

                                                                                                                                                                                                                                                                  The path reference to validate.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                • visited: string[] = []

                                                                                                                                                                                                                                                                  The list of visited paths to detect cycles.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                True if the path reference is valid, otherwise false.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                If the path reference is invalid or cyclical.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              • Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Creates an instance of RestApi.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • app: AwsCdkTypeScriptApp +

                                                                                                                                                                                                                                                                  The AWS CDK TypeScript app.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • options: RestApiOptions +

                                                                                                                                                                                                                                                                  The options for configuring the RestApi.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns RestApi

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              node: Node
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The tree node.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              options: RestApiOptions
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The options for configuring the RestApi.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              project: Project
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Adds a sample handler file for a REST API resource.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • files: { [fileName: string]: () => string } +

                                                                                                                                                                                                                                                                  The collection of file generators.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • apiSpec: OpenAPI3 +

                                                                                                                                                                                                                                                                  The OpenAPI specification object.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • path: string +

                                                                                                                                                                                                                                                                  The path of the API resource.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • method: string +

                                                                                                                                                                                                                                                                  The HTTP method of the API resource.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Creates the construct file content for the generated REST API.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • file: FileBase +

                                                                                                                                                                                                                                                                  The file object to create content for.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                The content of the construct file.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Creates the entry file content for a REST API handler.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • method: string +

                                                                                                                                                                                                                                                                  The HTTP method of the API resource.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • operationId: string +

                                                                                                                                                                                                                                                                  The operation ID of the API resource.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                The content of the entry file.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Called before synthesis.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns a string representation of this construct.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Validates a path reference in the OpenAPI specification.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • apiSpec: OpenAPI3 +

                                                                                                                                                                                                                                                                  The OpenAPI specification object.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • path: string +

                                                                                                                                                                                                                                                                  The path reference to validate.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • visited: string[] = [] +

                                                                                                                                                                                                                                                                  The list of visited paths to detect cycles.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                True if the path reference is valid, otherwise false.

                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                If the path reference is invalid or cyclical.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • ...mixins: IMixin[]

                                                                                                                                                                                                                                                                  The mixins to apply

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns IConstruct

                                                                                                                                                                                                                                                                This construct for chaining

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              • Test whether the given construct is a component.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • x: any

                                                                                                                                                                                                                                                                Returns x is Component

                                                                                                                                                                                                                                                              • Checks if x is a construct.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • ...mixins: IMixin[] +

                                                                                                                                                                                                                                                                  The mixins to apply

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns IConstruct

                                                                                                                                                                                                                                                                This construct for chaining

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Test whether the given construct is a component.

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • x: any
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Returns x is Component

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • + +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Checks if x is a construct.

                                                                                                                                                                                                                                                                Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                Explanation: in JavaScript, multiple copies of the constructs library on @@ -67,6 +278,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • x: any

                                                                                                                                                                                                                                                                  Any object

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns x is Construct

                                                                                                                                                                                                                                                                true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              • x: any +

                                                                                                                                                                                                                                                                Any object

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Returns x is Construct

                                                                                                                                                                                                                                                              true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Constructors +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Methods +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              diff --git a/docs/projen/classes/ServerlessProject.html b/docs/projen/classes/ServerlessProject.html index 56f50b8..4641511 100644 --- a/docs/projen/classes/ServerlessProject.html +++ b/docs/projen/classes/ServerlessProject.html @@ -1,11 +1,44 @@ -ServerlessProject | cdk-serverless
                                                                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Class ServerlessProject

                                                                                                                                                                                                                                                                The ServerlessProject construct sets up an AWS CDK TypeScript project with serverless application dependencies and configurations. +ServerlessProject | cdk-serverless

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                  Class ServerlessProject

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The ServerlessProject construct sets up an AWS CDK TypeScript project with serverless application dependencies and configurations. This construct extends the projen AwsCdkTypeScriptApp to include additional dependencies and development dependencies required for serverless applications. It also enables TypeScript projen configuration (projenrcTs).

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  const project = new ServerlessProject({
                                                                                                                                                                                                                                                                    name: 'MyServerlessApp',
                                                                                                                                                                                                                                                                    defaultReleaseBranch: 'main',
                                                                                                                                                                                                                                                                    cdkVersion: '2.140.0',
                                                                                                                                                                                                                                                                    deps: ['additional-dependency'],
                                                                                                                                                                                                                                                                    devDeps: ['additional-dev-dependency'],
                                                                                                                                                                                                                                                                  });
+
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  const project = new ServerlessProject({
                                                                                                                                                                                                                                                                    name: 'MyServerlessApp',
                                                                                                                                                                                                                                                                    defaultReleaseBranch: 'main',
                                                                                                                                                                                                                                                                    cdkVersion: '2.140.0',
                                                                                                                                                                                                                                                                    deps: ['additional-dependency'],
                                                                                                                                                                                                                                                                    devDeps: ['additional-dev-dependency'],
                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  • AwsCdkTypeScriptApp
                                                                                                                                                                                                                                                                    • ServerlessProject
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  constructor -

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  appEntrypoint +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • AwsCdkTypeScriptApp +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ServerlessProject
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  constructor +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  appEntrypoint artifactsDirectory artifactsJavascriptDirectory autoApprove? @@ -57,7 +90,10 @@ workflowPackageCache DEFAULT_TASK DEFAULT_TS_JEST_TRANFORM_PATTERN -

                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                  allowLibraryDependencies +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  allowLibraryDependencies buildTask buildWorkflowJobId cdkVersion @@ -78,7 +114,10 @@ root subprojects testTask -

                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                  addBins +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  addBins addBundledDeps addCdkDependency addCompileCommand @@ -114,157 +153,998 @@ isConstruct isProject of -

                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  appEntrypoint: string

                                                                                                                                                                                                                                                                  The CDK app entrypoint

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  artifactsDirectory: string

                                                                                                                                                                                                                                                                  The build output directory. An npm tarball will be created under the js +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  appEntrypoint: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The CDK app entrypoint

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  artifactsDirectory: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The build output directory. An npm tarball will be created under the js subdirectory. For example, if this is set to dist (the default), the npm tarball will be placed under dist/js/boom-boom-1.2.3.tg.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  artifactsJavascriptDirectory: string

                                                                                                                                                                                                                                                                  The location of the npm tarball after build (${artifactsDirectory}/js).

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  autoApprove?: AutoApprove

                                                                                                                                                                                                                                                                  Auto approve set up for this project.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  autoMerge?: AutoMerge

                                                                                                                                                                                                                                                                  Component that sets up mergify for merging approved pull requests.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  biome?: Biome
                                                                                                                                                                                                                                                                  buildWorkflow?: BuildWorkflow

                                                                                                                                                                                                                                                                  The PR build GitHub workflow. undefined if buildWorkflow is disabled.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  bundler: Bundler
                                                                                                                                                                                                                                                                  cdkConfig: CdkConfig

                                                                                                                                                                                                                                                                  cdk.json configuration.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  cdkDeps: AwsCdkDeps
                                                                                                                                                                                                                                                                  cdkTasks: CdkTasks

                                                                                                                                                                                                                                                                  Common CDK tasks.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  commitGenerated: boolean

                                                                                                                                                                                                                                                                  Whether to commit the managed files by default.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  defaultTask?: Task

                                                                                                                                                                                                                                                                  This is the "default" task, the one that executes "projen". Undefined if +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  artifactsJavascriptDirectory: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The location of the npm tarball after build (${artifactsDirectory}/js).

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  autoApprove?: AutoApprove
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Auto approve set up for this project.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  autoMerge?: AutoMerge
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Component that sets up mergify for merging approved pull requests.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  biome?: Biome
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  buildWorkflow?: BuildWorkflow
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The PR build GitHub workflow. undefined if buildWorkflow is disabled.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  bundler: Bundler
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  cdkConfig: CdkConfig
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  cdk.json configuration.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  cdkDeps: AwsCdkDeps
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  cdkTasks: CdkTasks
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Common CDK tasks.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  commitGenerated: boolean
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Whether to commit the managed files by default.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  defaultTask?: Task
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  This is the "default" task, the one that executes "projen". Undefined if the project is being ejected.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  deps: Dependencies

                                                                                                                                                                                                                                                                  Project dependencies.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  devContainer: DevContainer | undefined

                                                                                                                                                                                                                                                                  Access for .devcontainer.json (used for GitHub Codespaces)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  deps: Dependencies
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Project dependencies.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  devContainer: DevContainer | undefined
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Access for .devcontainer.json (used for GitHub Codespaces)

                                                                                                                                                                                                                                                                  This will be undefined if devContainer boolean is false

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  docgen?: boolean
                                                                                                                                                                                                                                                                  docsDirectory: string
                                                                                                                                                                                                                                                                  eslint?: Eslint
                                                                                                                                                                                                                                                                  gitattributes: GitAttributesFile

                                                                                                                                                                                                                                                                  The .gitattributes file for this repository.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  github: GitHub | undefined

                                                                                                                                                                                                                                                                  Access all github components.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  docgen?: boolean
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  docsDirectory: string
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  eslint?: Eslint
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  gitattributes: GitAttributesFile
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The .gitattributes file for this repository.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  github: GitHub | undefined
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Access all github components.

                                                                                                                                                                                                                                                                  This will be undefined for subprojects.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  gitignore: IgnoreFile

                                                                                                                                                                                                                                                                  .gitignore

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  gitpod: Gitpod | undefined

                                                                                                                                                                                                                                                                  Access for Gitpod

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  gitignore: IgnoreFile
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  .gitignore

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  gitpod: Gitpod | undefined
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Access for Gitpod

                                                                                                                                                                                                                                                                  This will be undefined if gitpod boolean is false

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  initProject?: InitProject

                                                                                                                                                                                                                                                                  The options used when this project is bootstrapped via projen new. It +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  initProject?: InitProject
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The options used when this project is bootstrapped via projen new. It includes the original set of options passed to the CLI and also the JSII FQN of the project type.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  jest?: Jest

                                                                                                                                                                                                                                                                  The Jest configuration (if enabled)

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  libdir: string

                                                                                                                                                                                                                                                                  The directory in which compiled .js files reside.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  logger: Logger

                                                                                                                                                                                                                                                                  Logging utilities.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  name: string

                                                                                                                                                                                                                                                                  Project name.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  node: Node

                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  nodeVersion?: string
                                                                                                                                                                                                                                                                  npmignore?: IgnoreFile

                                                                                                                                                                                                                                                                  The .npmignore file.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  outdir: string

                                                                                                                                                                                                                                                                  Absolute output directory of this project.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  package: NodePackage

                                                                                                                                                                                                                                                                  API for managing the node package.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  parent?: Project

                                                                                                                                                                                                                                                                  A parent project. If undefined, this is the root project.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  prettier?: Prettier
                                                                                                                                                                                                                                                                  projectBuild: ProjectBuild

                                                                                                                                                                                                                                                                  Manages the build process of the project.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  projectType: ProjectType
                                                                                                                                                                                                                                                                  publisher?: Publisher

                                                                                                                                                                                                                                                                  Package publisher. This will be undefined if the project does not have a +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  jest?: Jest
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The Jest configuration (if enabled)

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  libdir: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The directory in which compiled .js files reside.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  logger: Logger
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Logging utilities.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Project name.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  node: Node
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The tree node.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  nodeVersion?: string
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  npmignore?: IgnoreFile
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The .npmignore file.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  outdir: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Absolute output directory of this project.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  package: NodePackage
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  API for managing the node package.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  parent?: Project
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  A parent project. If undefined, this is the root project.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  prettier?: Prettier
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  projectBuild: ProjectBuild
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Manages the build process of the project.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  projectType: ProjectType
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  publisher?: Publisher
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Package publisher. This will be undefined if the project does not have a release workflow.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  use release.publisher.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  release?: Release

                                                                                                                                                                                                                                                                  Release management.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  runScriptCommand: string

                                                                                                                                                                                                                                                                  The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  srcdir: string

                                                                                                                                                                                                                                                                  The directory in which the .ts sources reside.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  tasks: Tasks

                                                                                                                                                                                                                                                                  Project tasks.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  testdir: string

                                                                                                                                                                                                                                                                  The directory in which tests reside.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  tsconfig?: TypescriptConfig
                                                                                                                                                                                                                                                                  tsconfigDev: TypescriptConfig

                                                                                                                                                                                                                                                                  A typescript configuration file which covers all files (sources, tests, projen).

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  tsconfigEslint?: TypescriptConfig
                                                                                                                                                                                                                                                                  upgradeWorkflow?: UpgradeDependencies

                                                                                                                                                                                                                                                                  The upgrade workflow.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  vscode: VsCode | undefined

                                                                                                                                                                                                                                                                  Access all VSCode components.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  use release.publisher.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  release?: Release
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Release management.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  runScriptCommand: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  srcdir: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The directory in which the .ts sources reside.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  tasks: Tasks
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Project tasks.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  testdir: string
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The directory in which tests reside.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  tsconfig?: TypescriptConfig
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  tsconfigDev: TypescriptConfig
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  A typescript configuration file which covers all files (sources, tests, projen).

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  tsconfigEslint?: TypescriptConfig
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  upgradeWorkflow?: UpgradeDependencies
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The upgrade workflow.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  vscode: VsCode | undefined
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Access all VSCode components.

                                                                                                                                                                                                                                                                  This will be undefined for subprojects.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  watchTask: Task

                                                                                                                                                                                                                                                                  The "watch" task.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  workflowBootstrapSteps: JobStep[]
                                                                                                                                                                                                                                                                  workflowPackageCache: boolean
                                                                                                                                                                                                                                                                  DEFAULT_TASK: "default"

                                                                                                                                                                                                                                                                  The name of the default task (the task executed when projen is run without arguments). Normally +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  watchTask: Task
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The "watch" task.

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  workflowBootstrapSteps: JobStep[]
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  workflowPackageCache: boolean
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  DEFAULT_TASK: "default"
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  The name of the default task (the task executed when projen is run without arguments). Normally this task should synthesize the project files.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  DEFAULT_TS_JEST_TRANFORM_PATTERN: "^.+\\.[t]sx?$"

                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                  • get allowLibraryDependencies(): boolean

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                    use package.allowLibraryDependencies

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • get buildTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • get buildWorkflowJobId(): string | undefined

                                                                                                                                                                                                                                                                    The job ID of the build workflow.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  • get cdkVersion(): string

                                                                                                                                                                                                                                                                    The CDK version this app is using.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  • get compileTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • get components(): Component[]

                                                                                                                                                                                                                                                                    Returns all the components within this project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns Component[]

                                                                                                                                                                                                                                                                  • get ejected(): boolean

                                                                                                                                                                                                                                                                    Whether or not the project is being ejected.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                  • get entrypoint(): string

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                    use package.entrypoint

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • get files(): FileBase[]

                                                                                                                                                                                                                                                                    All files in this project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns FileBase[]

                                                                                                                                                                                                                                                                  • get manifest(): any

                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                    use package.addField(x, y)

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • get maxNodeVersion(): string | undefined

                                                                                                                                                                                                                                                                    Maximum node version supported by this package.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  DEFAULT_TS_JEST_TRANFORM_PATTERN: "^.+\\.[t]sx?$"
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get allowLibraryDependencies(): boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use package.allowLibraryDependencies

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get buildTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get buildWorkflowJobId(): string | undefined
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The job ID of the build workflow.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get cdkVersion(): string
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The CDK version this app is using.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get compileTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get components(): Component[]
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns all the components within this project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Component[]

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get ejected(): boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Whether or not the project is being ejected.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get entrypoint(): string
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use package.entrypoint

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get files(): FileBase[]
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    All files in this project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns FileBase[]

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get manifest(): any
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use package.addField(x, y)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get maxNodeVersion(): string | undefined
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Maximum node version supported by this package.

                                                                                                                                                                                                                                                                    The value indicates the package is incompatible with newer versions.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  • get minNodeVersion(): string | undefined

                                                                                                                                                                                                                                                                    The minimum node version required by this package to function.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get minNodeVersion(): string | undefined
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The minimum node version required by this package to function.

                                                                                                                                                                                                                                                                    This value indicates the package is incompatible with older versions.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  • get npmrc(): NpmConfig

                                                                                                                                                                                                                                                                    The .npmrc file

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns NpmConfig

                                                                                                                                                                                                                                                                  • get packageManager(): NodePackageManager

                                                                                                                                                                                                                                                                    The package manager to use.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns NodePackageManager

                                                                                                                                                                                                                                                                    use package.packageManager

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • get packageTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • get postCompileTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • get preCompileTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • get projenCommand(): string

                                                                                                                                                                                                                                                                    The command to use in order to run the projen CLI.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  • get root(): Project

                                                                                                                                                                                                                                                                    The root project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns Project

                                                                                                                                                                                                                                                                  • get subprojects(): Project[]

                                                                                                                                                                                                                                                                    Returns all the subprojects within this project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns Project[]

                                                                                                                                                                                                                                                                  • get testTask(): Task

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                    • bins: Record<string, string>

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Defines bundled dependencies.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string | undefined

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get npmrc(): NpmConfig
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The .npmrc file

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns NpmConfig

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get packageManager(): NodePackageManager
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The package manager to use.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns NodePackageManager

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use package.packageManager

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get packageTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get postCompileTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get preCompileTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get projenCommand(): string
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The command to use in order to run the projen CLI.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get root(): Project
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    The root project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Project

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get subprojects(): Project[]
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns all the subprojects within this project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Project[]

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                    get testTask(): Task
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • bins: Record<string, string>
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Defines bundled dependencies.

                                                                                                                                                                                                                                                                    Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...deps: string[]

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • ...deps: string[] +

                                                                                                                                                                                                                                                                        Names modules to install. By default, the the dependency will be installed in the next pnpm projen run and the version will be recorded in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax: module@^7.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                  • Adds an AWS CDK module dependencies

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...modules: string[]

                                                                                                                                                                                                                                                                      The list of modules to depend on

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • DEPRECATED

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...commands: string[]

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    use project.compileTask.exec()

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Defines normal dependencies.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...deps: string[]

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will +

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Adds an AWS CDK module dependencies

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...modules: string[] +

                                                                                                                                                                                                                                                                      The list of modules to depend on

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    DEPRECATED

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...commands: string[]
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use project.compileTask.exec()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Defines normal dependencies.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...deps: string[] +

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will be installed in the next pnpm projen run and the version will be recorded in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax: module@^7.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Defines development/test dependencies.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...deps: string[]

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will +

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Defines development/test dependencies.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...deps: string[] +

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will be installed in the next pnpm projen run and the version will be recorded in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax: module@^7.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Exclude the matching files from pre-synth cleanup. Can be used when, for example, some +

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...globs: string[]

                                                                                                                                                                                                                                                                      The glob patterns to match

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Directly set fields in package.json.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • fields: { [name: string]: any }

                                                                                                                                                                                                                                                                      The fields to set

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Adds a .gitignore pattern.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • pattern: string

                                                                                                                                                                                                                                                                      The glob pattern to ignore.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Adds keywords to package.json (deduplicated)

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...keywords: string[]

                                                                                                                                                                                                                                                                      The keywords to add

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Adds patterns to be ignored by npm.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • pattern: string

                                                                                                                                                                                                                                                                      The pattern to ignore.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    If you are having trouble getting an ignore to populate, try using your construct or component's preSynthesize method to properly delay calling this method.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Defines peer dependencies.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...globs: string[] +

                                                                                                                                                                                                                                                                      The glob patterns to match

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Directly set fields in package.json.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • fields: { [name: string]: any } +

                                                                                                                                                                                                                                                                      The fields to set

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Adds a .gitignore pattern.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • pattern: string +

                                                                                                                                                                                                                                                                      The glob pattern to ignore.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Adds keywords to package.json (deduplicated)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...keywords: string[] +

                                                                                                                                                                                                                                                                      The keywords to add

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Adds patterns to be ignored by npm.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • pattern: string +

                                                                                                                                                                                                                                                                      The pattern to ignore.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    If you are having trouble getting an ignore to populate, try using your construct or component's preSynthesize method to properly delay calling this method.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Defines peer dependencies.

                                                                                                                                                                                                                                                                    When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...deps: string[]

                                                                                                                                                                                                                                                                      Names modules to install. By default, the the dependency will +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • ...deps: string[] +

                                                                                                                                                                                                                                                                        Names modules to install. By default, the the dependency will be installed in the next pnpm projen run and the version will be recorded in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax: module@^7.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                  • Replaces the contents of multiple npm package.json scripts.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • scripts: { [name: string]: string }

                                                                                                                                                                                                                                                                      The scripts to set

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Adds a new task to this project. This will fail if the project already has +

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Replaces the contents of multiple npm package.json scripts.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • scripts: { [name: string]: string } +

                                                                                                                                                                                                                                                                      The scripts to set

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Adds a new task to this project. This will fail if the project already has a task with this name.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                      The task name to add

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • Optionalprops: TaskOptions

                                                                                                                                                                                                                                                                      Task properties

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  • DEPRECATED

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...commands: string[]

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    use project.testTask.exec()

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Prints a "tip" message during synthesis.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • message: string

                                                                                                                                                                                                                                                                      The message

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • name: string +

                                                                                                                                                                                                                                                                      The task name to add

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • Optionalprops: TaskOptions +

                                                                                                                                                                                                                                                                      Task properties

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    DEPRECATED

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...commands: string[]
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use project.testTask.exec()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Prints a "tip" message during synthesis.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • message: string +

                                                                                                                                                                                                                                                                      The message

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    • use project.logger.info(message) to show messages during synthesis
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Marks the provided file(s) as being generated. This is achieved using the +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Marks the provided file(s) as being generated. This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • glob: string

                                                                                                                                                                                                                                                                      the glob pattern to match (could be a file path).

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    https://github.com/github/linguist/blob/master/docs/overrides.md

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Projen default Typescript compiler options.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns TypeScriptCompilerOptions

                                                                                                                                                                                                                                                                  • Indicates if a script by the name name is defined.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                      The name of the script

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                    Use project.tasks.tryFind(name)

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Called after all components are synthesized. Order is not guaranteed.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Called before all components are synthesized.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Removes the npm script (always successful).

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                      The name of the script.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Removes a task from a project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                      The name of the task to remove.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns Task | undefined

                                                                                                                                                                                                                                                                    The Task that was removed, otherwise undefined.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Returns the set of workflow steps which should be executed to bootstrap a +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • glob: string +

                                                                                                                                                                                                                                                                      the glob pattern to match (could be a file path).

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    https://github.com/github/linguist/blob/master/docs/overrides.md

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Projen default Typescript compiler options.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns TypeScriptCompilerOptions

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Indicates if a script by the name name is defined.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • name: string +

                                                                                                                                                                                                                                                                      The name of the script

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Use project.tasks.tryFind(name)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Called after all components are synthesized. Order is not guaranteed.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Called before all components are synthesized.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Removes the npm script (always successful).

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • name: string +

                                                                                                                                                                                                                                                                      The name of the script.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Removes a task from a project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • name: string +

                                                                                                                                                                                                                                                                      The name of the task to remove.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns Task | undefined

                                                                                                                                                                                                                                                                    The Task that was removed, otherwise undefined.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns the set of workflow steps which should be executed to bootstrap a workflow.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • Optionaloptions: RenderWorkflowSetupOptions

                                                                                                                                                                                                                                                                      Options.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns JobStep[]

                                                                                                                                                                                                                                                                    Job steps

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Returns the shell command to execute in order to run a task. This will +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • Optionaloptions: RenderWorkflowSetupOptions +

                                                                                                                                                                                                                                                                      Options.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns JobStep[]

                                                                                                                                                                                                                                                                    Job steps

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns the shell command to execute in order to run a task. This will typically be pnpm projen TASK.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • task: Task

                                                                                                                                                                                                                                                                      The task for which the command is required

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  • Replaces the contents of an npm package.json script.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                      The script name

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • command: string

                                                                                                                                                                                                                                                                      The command to execute

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Synthesize all project files into outdir.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • task: Task +

                                                                                                                                                                                                                                                                      The task for which the command is required

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Replaces the contents of an npm package.json script.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • name: string +

                                                                                                                                                                                                                                                                      The script name

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • command: string +

                                                                                                                                                                                                                                                                      The command to execute

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Synthesize all project files into outdir.

                                                                                                                                                                                                                                                                    1. Call "this.preSynthesize()"
                                                                                                                                                                                                                                                                    2. Delete all generated files
                                                                                                                                                                                                                                                                      3. @@ -273,31 +1153,122 @@
                                                                                                                                                                                                                                                                    3. Call "postSynthesize()" for all components of this project
                                                                                                                                                                                                                                                                    4. Call "this.postSynthesize()"
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  • Finds a file at the specified relative path within this project and all +

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns a string representation of this construct.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Finds a file at the specified relative path within this project and all its subprojects.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • filePath: string

                                                                                                                                                                                                                                                                      The file path. If this path is relative, it will be resolved +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • filePath: string +

                                                                                                                                                                                                                                                                        The file path. If this path is relative, it will be resolved from the root of this project.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Returns FileBase | undefined

                                                                                                                                                                                                                                                                      a FileBase or undefined if there is no file in that path

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                  • Finds a json file by name.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • filePath: string

                                                                                                                                                                                                                                                                      The file path.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns JsonFile | undefined

                                                                                                                                                                                                                                                                    use tryFindObjectFile

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Finds an object file (like JsonFile, YamlFile, etc.) by name.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • filePath: string

                                                                                                                                                                                                                                                                      The file path.

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns ObjectFile | undefined

                                                                                                                                                                                                                                                                  • Finds a file at the specified relative path within this project and removes +

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns FileBase | undefined

                                                                                                                                                                                                                                                                  a FileBase or undefined if there is no file in that path

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Finds a json file by name.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • filePath: string +

                                                                                                                                                                                                                                                                      The file path.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns JsonFile | undefined

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    use tryFindObjectFile

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Finds an object file (like JsonFile, YamlFile, etc.) by name.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • filePath: string +

                                                                                                                                                                                                                                                                      The file path.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns ObjectFile | undefined

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Finds a file at the specified relative path within this project and removes it.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • filePath: string

                                                                                                                                                                                                                                                                      The file path. If this path is relative, it will be +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • filePath: string +

                                                                                                                                                                                                                                                                        The file path. If this path is relative, it will be resolved from the root of this project.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Returns FileBase | undefined

                                                                                                                                                                                                                                                                      a FileBase if the file was found and removed, or undefined if +

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns FileBase | undefined

                                                                                                                                                                                                                                                                  a FileBase if the file was found and removed, or undefined if the file was not found.

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  • Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                    Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • ...mixins: IMixin[]

                                                                                                                                                                                                                                                                      The mixins to apply

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns IConstruct

                                                                                                                                                                                                                                                                    This construct for chaining

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Checks if x is a construct.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • ...mixins: IMixin[] +

                                                                                                                                                                                                                                                                      The mixins to apply

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns IConstruct

                                                                                                                                                                                                                                                                    This construct for chaining

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Checks if x is a construct.

                                                                                                                                                                                                                                                                    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                    Explanation: in JavaScript, multiple copies of the constructs library on @@ -310,10 +1281,75 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • x: any

                                                                                                                                                                                                                                                                      Any object

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns x is Construct

                                                                                                                                                                                                                                                                    true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  • Test whether the given construct is a project.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • x: any

                                                                                                                                                                                                                                                                    Returns x is Project

                                                                                                                                                                                                                                                                  • Find the closest ancestor project for given construct. +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • x: any +

                                                                                                                                                                                                                                                                      Any object

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns x is Construct

                                                                                                                                                                                                                                                                    true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Test whether the given construct is a project.

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • x: any
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Returns x is Project

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • + +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Find the closest ancestor project for given construct. When given a project, this it the project itself.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • construct: IConstruct

                                                                                                                                                                                                                                                                    Returns Project

                                                                                                                                                                                                                                                                    when no project is found in the path to the root

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  Accessors
                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                  • construct: IConstruct
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Returns Project

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  when no project is found in the path to the root

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Constructors +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Accessors +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Methods +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  diff --git a/docs/projen/classes/Workflow.html b/docs/projen/classes/Workflow.html index e1170d8..ce62c6c 100644 --- a/docs/projen/classes/Workflow.html +++ b/docs/projen/classes/Workflow.html @@ -1,13 +1,49 @@ -Workflow | cdk-serverless
                                                                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Class Workflow

                                                                                                                                                                                                                                                                    The Workflow construct sets up an AWS Step Functions workflow for a serverless project using projen. +Workflow | cdk-serverless

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                      Class Workflow

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      The Workflow construct sets up an AWS Step Functions workflow for a serverless project using projen. This construct extends the projen Component to generate a sample state machine definition file and corresponding TypeScript construct file.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      const workflow = new Workflow(app, {
                                                                                                                                                                                                                                                                        workflowName: 'MyWorkflow',
                                                                                                                                                                                                                                                                        definitionFile: 'statemachine/definition.json',
                                                                                                                                                                                                                                                                      });
+
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      const workflow = new Workflow(app, {
                                                                                                                                                                                                                                                                        workflowName: 'MyWorkflow',
                                                                                                                                                                                                                                                                        definitionFile: 'statemachine/definition.json',
                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                      • Component
                                                                                                                                                                                                                                                                        • Workflow
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                      constructor -

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      node +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • Component +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • Workflow
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      constructor +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      node options project -

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      createConstructFile +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      createConstructFile postSynthesize preSynthesize renderDefinitionSubstitution @@ -17,33 +53,180 @@ with isComponent isConstruct -

                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                      • Creates an instance of Workflow.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • app: AwsCdkTypeScriptApp

                                                                                                                                                                                                                                                                          The AWS CDK TypeScript app.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                        • options: WorkflowOptions

                                                                                                                                                                                                                                                                          The options for configuring the Workflow.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns Workflow

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      node: Node

                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      options: WorkflowOptions

                                                                                                                                                                                                                                                                      The options for configuring the Workflow.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      project: Project

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      • Creates the construct file content for the generated Workflow.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • file: FileBase

                                                                                                                                                                                                                                                                          The file object to create content for.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The content of the construct file.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      • Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      • Called before synthesis.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      • Renders the definition substitution for a given variable.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • def: VariableDefinition

                                                                                                                                                                                                                                                                          The variable definition.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The definition substitution string.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      • Renders the state configuration definition for a given variable.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • def: VariableDefinition

                                                                                                                                                                                                                                                                          The variable definition.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The state configuration definition string.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      • Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      • Returns a string representation of this construct.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                      • Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Creates an instance of Workflow.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • app: AwsCdkTypeScriptApp +

                                                                                                                                                                                                                                                                          The AWS CDK TypeScript app.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        • options: WorkflowOptions +

                                                                                                                                                                                                                                                                          The options for configuring the Workflow.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns Workflow

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      node: Node
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      The tree node.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      options: WorkflowOptions
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      The options for configuring the Workflow.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      project: Project
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Creates the construct file content for the generated Workflow.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • file: FileBase +

                                                                                                                                                                                                                                                                          The file object to create content for.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The content of the construct file.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Called after synthesis. Order is not guaranteed.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Called before synthesis.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Renders the definition substitution for a given variable.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • def: VariableDefinition +

                                                                                                                                                                                                                                                                          The variable definition.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The definition substitution string.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Renders the state configuration definition for a given variable.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • def: VariableDefinition +

                                                                                                                                                                                                                                                                          The variable definition.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        The state configuration definition string.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Synthesizes files to the project output directory.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns a string representation of this construct.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Applies one or more mixins to this construct.

                                                                                                                                                                                                                                                                        Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • ...mixins: IMixin[]

                                                                                                                                                                                                                                                                          The mixins to apply

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns IConstruct

                                                                                                                                                                                                                                                                        This construct for chaining

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      • Test whether the given construct is a component.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • x: any

                                                                                                                                                                                                                                                                        Returns x is Component

                                                                                                                                                                                                                                                                      • Checks if x is a construct.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • ...mixins: IMixin[] +

                                                                                                                                                                                                                                                                          The mixins to apply

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns IConstruct

                                                                                                                                                                                                                                                                        This construct for chaining

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Test whether the given construct is a component.

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • x: any
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Returns x is Component

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Checks if x is a construct.

                                                                                                                                                                                                                                                                        Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

                                                                                                                                                                                                                                                                        Explanation: in JavaScript, multiple copies of the constructs library on @@ -56,6 +239,40 @@ library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • x: any

                                                                                                                                                                                                                                                                          Any object

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns x is Construct

                                                                                                                                                                                                                                                                        true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • x: any +

                                                                                                                                                                                                                                                                        Any object

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Returns x is Construct

                                                                                                                                                                                                                                                                      true if x is an object created from a class which extends Construct.

                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Constructors +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Methods +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      diff --git a/docs/projen/hierarchy.html b/docs/projen/hierarchy.html index 45b8f77..f472aaa 100644 --- a/docs/projen/hierarchy.html +++ b/docs/projen/hierarchy.html @@ -1 +1,29 @@ -cdk-serverless
                                                                                                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        cdk-serverless

                                                                                                                                                                                                                                                                        Hierarchy Summary

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                        +cdk-serverless
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          cdk-serverless

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Hierarchy Summary

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          diff --git a/docs/projen/index.html b/docs/projen/index.html index baafa6f..3874299 100644 --- a/docs/projen/index.html +++ b/docs/projen/index.html @@ -1,4 +1,14 @@ -cdk-serverless
                                                                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            cdk-serverless

                                                                                                                                                                                                                                                                            CDK Serverless

                                                                                                                                                                                                                                                                            +cdk-serverless
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              cdk-serverless

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              CDK Serverless

                                                                                                                                                                                                                                                                              npm version

                                                                                                                                                                                                                                                                              CDK Serverless is a powerful toolkit designed to simplify serverless application development using the AWS Cloud Development Kit (CDK). It offers project management features, higher-level (L3) constructs, and utility libraries to streamline the creation and management of serverless architectures. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

                                                                                                                                                                                                                                                                              Video introduction: https://www.youtube.com/watch?v=xhNJ0cXG3O8

                                                                                                                                                                                                                                                                              @@ -136,4 +146,60 @@

                                                                                                                                                                                                                                                                              Authors

                                                                                                                                                                                                                                                                              Brought to you by Taimos

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              CDK Serverless
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                              CDK Serverless +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              diff --git a/docs/projen/interfaces/DatastoreOptions.html b/docs/projen/interfaces/DatastoreOptions.html index 99b4cc4..026fba0 100644 --- a/docs/projen/interfaces/DatastoreOptions.html +++ b/docs/projen/interfaces/DatastoreOptions.html @@ -1,3 +1,55 @@ -DatastoreOptions | cdk-serverless
                                                                                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface DatastoreOptions

                                                                                                                                                                                                                                                                                interface DatastoreOptions {
                                                                                                                                                                                                                                                                                    definitionFile: string;
                                                                                                                                                                                                                                                                                    modelName: string;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                definitionFile +DatastoreOptions | cdk-serverless
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                  Interface DatastoreOptions

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  interface DatastoreOptions {
                                                                                                                                                                                                                                                                                      definitionFile: string;
                                                                                                                                                                                                                                                                                      modelName: string;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  definitionFile modelName -

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  definitionFile: string
                                                                                                                                                                                                                                                                                  modelName: string

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  definitionFile: string
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  modelName: string
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  diff --git a/docs/projen/interfaces/GraphQlApiOptions.html b/docs/projen/interfaces/GraphQlApiOptions.html index b93c7c5..60fc083 100644 --- a/docs/projen/interfaces/GraphQlApiOptions.html +++ b/docs/projen/interfaces/GraphQlApiOptions.html @@ -1,3 +1,55 @@ -GraphQlApiOptions | cdk-serverless
                                                                                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface GraphQlApiOptions

                                                                                                                                                                                                                                                                                    interface GraphQlApiOptions {
                                                                                                                                                                                                                                                                                        apiName: string;
                                                                                                                                                                                                                                                                                        definitionFile: string;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    apiName +GraphQlApiOptions | cdk-serverless
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    cdk-serverless + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                      Interface GraphQlApiOptions

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface GraphQlApiOptions {
                                                                                                                                                                                                                                                                                          apiName: string;
                                                                                                                                                                                                                                                                                          definitionFile: string;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      apiName definitionFile -

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      apiName: string
                                                                                                                                                                                                                                                                                      definitionFile: string

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      apiName: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      definitionFile: string
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Member Visibility +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                       +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Properties +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      diff --git a/docs/projen/interfaces/RestApiOptions.html b/docs/projen/interfaces/RestApiOptions.html index 6c2baaf..2c4914f 100644 --- a/docs/projen/interfaces/RestApiOptions.html +++ b/docs/projen/interfaces/RestApiOptions.html @@ -1,3 +1,55 @@ -RestApiOptions | cdk-serverless
                                                                                                                                                                                                                                                                                      cdk-serverless
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface RestApiOptions

                                                                                                                                                                                                                                                                                        interface RestApiOptions {
                                                                                                                                                                                                                                                                                            apiName: string;
                                                                                                                                                                                                                                                                                            definitionFile: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        apiName +RestApiOptions | cdk-serverless
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        cdk-serverless + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          Interface RestApiOptions

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          interface RestApiOptions {
                                                                                                                                                                                                                                                                                              apiName: string;
                                                                                                                                                                                                                                                                                              definitionFile: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          apiName definitionFile -

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          apiName: string
                                                                                                                                                                                                                                                                                          definitionFile: string

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          apiName: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          definitionFile: string
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Properties +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          diff --git a/docs/projen/interfaces/ServerlessProjectOptions.html b/docs/projen/interfaces/ServerlessProjectOptions.html index 0e37e64..5fb1e42 100644 --- a/docs/projen/interfaces/ServerlessProjectOptions.html +++ b/docs/projen/interfaces/ServerlessProjectOptions.html @@ -1,4 +1,30 @@ -ServerlessProjectOptions | cdk-serverless
                                                                                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface ServerlessProjectOptions

                                                                                                                                                                                                                                                                                            interface ServerlessProjectOptions {
                                                                                                                                                                                                                                                                                                addPackageManagerToDevEngines?: boolean;
                                                                                                                                                                                                                                                                                                allowLibraryDependencies?: boolean;
                                                                                                                                                                                                                                                                                                app?: string;
                                                                                                                                                                                                                                                                                                appEntrypoint?: string;
                                                                                                                                                                                                                                                                                                artifactsDirectory?: string;
                                                                                                                                                                                                                                                                                                auditDeps?: boolean;
                                                                                                                                                                                                                                                                                                auditDepsOptions?: AuditOptions;
                                                                                                                                                                                                                                                                                                authorEmail?: string;
                                                                                                                                                                                                                                                                                                authorName?: string;
                                                                                                                                                                                                                                                                                                authorOrganization?: boolean;
                                                                                                                                                                                                                                                                                                authorUrl?: string;
                                                                                                                                                                                                                                                                                                autoApproveOptions?: AutoApproveOptions;
                                                                                                                                                                                                                                                                                                autoApproveUpgrades?: boolean;
                                                                                                                                                                                                                                                                                                autoDetectBin?: boolean;
                                                                                                                                                                                                                                                                                                autoMerge?: boolean;
                                                                                                                                                                                                                                                                                                autoMergeOptions?: AutoMergeOptions;
                                                                                                                                                                                                                                                                                                bin?: Record<string, string>;
                                                                                                                                                                                                                                                                                                biome?: boolean;
                                                                                                                                                                                                                                                                                                biomeOptions?: BiomeOptions;
                                                                                                                                                                                                                                                                                                bugsEmail?: string;
                                                                                                                                                                                                                                                                                                bugsUrl?: string;
                                                                                                                                                                                                                                                                                                buildCommand?: string;
                                                                                                                                                                                                                                                                                                buildWorkflow?: boolean;
                                                                                                                                                                                                                                                                                                buildWorkflowOptions?: BuildWorkflowOptions;
                                                                                                                                                                                                                                                                                                buildWorkflowTriggers?: Triggers;
                                                                                                                                                                                                                                                                                                bumpPackage?: string;
                                                                                                                                                                                                                                                                                                bundledDeps?: string[];
                                                                                                                                                                                                                                                                                                bundlerOptions?: BundlerOptions;
                                                                                                                                                                                                                                                                                                bunVersion?: string;
                                                                                                                                                                                                                                                                                                cdkAssert?: boolean;
                                                                                                                                                                                                                                                                                                cdkAssertions?: boolean;
                                                                                                                                                                                                                                                                                                cdkCliVersion?: string;
                                                                                                                                                                                                                                                                                                cdkDependencies?: string[];
                                                                                                                                                                                                                                                                                                cdkDependenciesAsDeps?: boolean;
                                                                                                                                                                                                                                                                                                cdkout?: string;
                                                                                                                                                                                                                                                                                                cdkTestDependencies?: string[];
                                                                                                                                                                                                                                                                                                cdkVersion: string;
                                                                                                                                                                                                                                                                                                cdkVersionPinning?: boolean;
                                                                                                                                                                                                                                                                                                checkLicenses?: LicenseCheckerOptions;
                                                                                                                                                                                                                                                                                                clobber?: boolean;
                                                                                                                                                                                                                                                                                                codeArtifactOptions?: CodeArtifactOptions;
                                                                                                                                                                                                                                                                                                codeCov?: boolean;
                                                                                                                                                                                                                                                                                                codeCovTokenSecret?: string;
                                                                                                                                                                                                                                                                                                commitGenerated?: boolean;
                                                                                                                                                                                                                                                                                                constructsVersion?: string;
                                                                                                                                                                                                                                                                                                context?: { [key: string]: any };
                                                                                                                                                                                                                                                                                                copyrightOwner?: string;
                                                                                                                                                                                                                                                                                                copyrightPeriod?: string;
                                                                                                                                                                                                                                                                                                defaultReleaseBranch: string;
                                                                                                                                                                                                                                                                                                deleteOrphanedLockFiles?: boolean;
                                                                                                                                                                                                                                                                                                dependabot?: boolean;
                                                                                                                                                                                                                                                                                                dependabotOptions?: DependabotOptions;
                                                                                                                                                                                                                                                                                                deps?: string[];
                                                                                                                                                                                                                                                                                                depsUpgrade?: boolean;
                                                                                                                                                                                                                                                                                                depsUpgradeOptions?: UpgradeDependenciesOptions;
                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                devContainer?: boolean;
                                                                                                                                                                                                                                                                                                devDeps?: string[];
                                                                                                                                                                                                                                                                                                devEngines?: DevEngines;
                                                                                                                                                                                                                                                                                                disableTsconfig?: boolean;
                                                                                                                                                                                                                                                                                                disableTsconfigDev?: boolean;
                                                                                                                                                                                                                                                                                                docgen?: boolean;
                                                                                                                                                                                                                                                                                                docsDirectory?: string;
                                                                                                                                                                                                                                                                                                edgeLambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                entrypoint?: string;
                                                                                                                                                                                                                                                                                                entrypointTypes?: string;
                                                                                                                                                                                                                                                                                                eslint?: boolean;
                                                                                                                                                                                                                                                                                                eslintOptions?: EslintOptions;
                                                                                                                                                                                                                                                                                                experimentalIntegRunner?: boolean;
                                                                                                                                                                                                                                                                                                featureFlags?: ICdkFeatureFlags;
                                                                                                                                                                                                                                                                                                github?: boolean;
                                                                                                                                                                                                                                                                                                githubOptions?: GitHubOptions;
                                                                                                                                                                                                                                                                                                gitignore?: string[];
                                                                                                                                                                                                                                                                                                gitIgnoreOptions?: IgnoreFileOptions;
                                                                                                                                                                                                                                                                                                gitOptions?: GitOptions;
                                                                                                                                                                                                                                                                                                gitpod?: boolean;
                                                                                                                                                                                                                                                                                                homepage?: string;
                                                                                                                                                                                                                                                                                                integrationTestAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                jest?: boolean;
                                                                                                                                                                                                                                                                                                jestOptions?: JestOptions;
                                                                                                                                                                                                                                                                                                jsiiReleaseVersion?: string;
                                                                                                                                                                                                                                                                                                keywords?: string[];
                                                                                                                                                                                                                                                                                                lambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                lambdaExtensionAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                lambdaOptions?: LambdaFunctionCommonOptions;
                                                                                                                                                                                                                                                                                                libdir?: string;
                                                                                                                                                                                                                                                                                                license?: string;
                                                                                                                                                                                                                                                                                                licensed?: boolean;
                                                                                                                                                                                                                                                                                                logging?: LoggerOptions;
                                                                                                                                                                                                                                                                                                majorVersion?: number;
                                                                                                                                                                                                                                                                                                maxNodeVersion?: string;
                                                                                                                                                                                                                                                                                                mergify?: boolean;
                                                                                                                                                                                                                                                                                                mergifyOptions?: MergifyOptions;
                                                                                                                                                                                                                                                                                                minMajorVersion?: number;
                                                                                                                                                                                                                                                                                                minNodeVersion?: string;
                                                                                                                                                                                                                                                                                                mutableBuild?: boolean;
                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                nextVersionCommand?: string;
                                                                                                                                                                                                                                                                                                npmAccess?: NpmAccess;
                                                                                                                                                                                                                                                                                                npmDistTag?: string;
                                                                                                                                                                                                                                                                                                npmignore?: string[];
                                                                                                                                                                                                                                                                                                npmignoreEnabled?: boolean;
                                                                                                                                                                                                                                                                                                npmIgnoreOptions?: IgnoreFileOptions;
                                                                                                                                                                                                                                                                                                npmProvenance?: boolean;
                                                                                                                                                                                                                                                                                                npmRegistry?: string;
                                                                                                                                                                                                                                                                                                npmRegistryUrl?: string;
                                                                                                                                                                                                                                                                                                npmTokenSecret?: string;
                                                                                                                                                                                                                                                                                                npmTrustedPublishing?: boolean;
                                                                                                                                                                                                                                                                                                outdir?: string;
                                                                                                                                                                                                                                                                                                package?: boolean;
                                                                                                                                                                                                                                                                                                packageManager?: NodePackageManager;
                                                                                                                                                                                                                                                                                                packageName?: string;
                                                                                                                                                                                                                                                                                                parent?: Project;
                                                                                                                                                                                                                                                                                                peerDependencyOptions?: PeerDependencyOptions;
                                                                                                                                                                                                                                                                                                peerDeps?: string[];
                                                                                                                                                                                                                                                                                                pnpmVersion?: string;
                                                                                                                                                                                                                                                                                                postBuildSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                prerelease?: string;
                                                                                                                                                                                                                                                                                                prettier?: boolean;
                                                                                                                                                                                                                                                                                                prettierOptions?: PrettierOptions;
                                                                                                                                                                                                                                                                                                projectTree?: boolean;
                                                                                                                                                                                                                                                                                                projectType?: ProjectType;
                                                                                                                                                                                                                                                                                                projenCommand?: string;
                                                                                                                                                                                                                                                                                                projenCredentials?: GithubCredentials;
                                                                                                                                                                                                                                                                                                projenDevDependency?: boolean;
                                                                                                                                                                                                                                                                                                projenrcJs?: boolean;
                                                                                                                                                                                                                                                                                                projenrcJson?: boolean;
                                                                                                                                                                                                                                                                                                projenrcJsonOptions?: ProjenrcJsonOptions;
                                                                                                                                                                                                                                                                                                projenrcJsOptions?: ProjenrcOptions;
                                                                                                                                                                                                                                                                                                projenrcTs?: boolean;
                                                                                                                                                                                                                                                                                                projenrcTsOptions?: ProjenrcOptions;
                                                                                                                                                                                                                                                                                                projenTokenSecret?: string;
                                                                                                                                                                                                                                                                                                projenVersion?: string;
                                                                                                                                                                                                                                                                                                publishDryRun?: boolean;
                                                                                                                                                                                                                                                                                                publishTasks?: boolean;
                                                                                                                                                                                                                                                                                                pullRequestTemplate?: boolean;
                                                                                                                                                                                                                                                                                                pullRequestTemplateContents?: string[];
                                                                                                                                                                                                                                                                                                readme?: SampleReadmeProps;
                                                                                                                                                                                                                                                                                                releasableCommits?: ReleasableCommits;
                                                                                                                                                                                                                                                                                                release?: boolean;
                                                                                                                                                                                                                                                                                                releaseBranches?: { [name: string]: BranchOptions };
                                                                                                                                                                                                                                                                                                releaseEnvironment?: string;
                                                                                                                                                                                                                                                                                                releaseEveryCommit?: boolean;
                                                                                                                                                                                                                                                                                                releaseFailureIssue?: boolean;
                                                                                                                                                                                                                                                                                                releaseFailureIssueLabel?: string;
                                                                                                                                                                                                                                                                                                releaseSchedule?: string;
                                                                                                                                                                                                                                                                                                releaseTagPrefix?: string;
                                                                                                                                                                                                                                                                                                releaseToNpm?: boolean;
                                                                                                                                                                                                                                                                                                releaseTrigger?: ReleaseTrigger;
                                                                                                                                                                                                                                                                                                releaseWorkflow?: boolean;
                                                                                                                                                                                                                                                                                                releaseWorkflowEnv?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                releaseWorkflowName?: string;
                                                                                                                                                                                                                                                                                                releaseWorkflowSetupSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                renovatebot?: boolean;
                                                                                                                                                                                                                                                                                                renovatebotOptions?: RenovatebotOptions;
                                                                                                                                                                                                                                                                                                repository?: string;
                                                                                                                                                                                                                                                                                                repositoryDirectory?: string;
                                                                                                                                                                                                                                                                                                requireApproval?: ApprovalLevel;
                                                                                                                                                                                                                                                                                                sampleCode?: boolean;
                                                                                                                                                                                                                                                                                                scopedPackagesOptions?: ScopedPackagesOptions[];
                                                                                                                                                                                                                                                                                                scripts?: { [name: string]: string };
                                                                                                                                                                                                                                                                                                singletonLambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                srcdir?: string;
                                                                                                                                                                                                                                                                                                stability?: string;
                                                                                                                                                                                                                                                                                                stale?: boolean;
                                                                                                                                                                                                                                                                                                staleOptions?: StaleOptions;
                                                                                                                                                                                                                                                                                                testdir?: string;
                                                                                                                                                                                                                                                                                                tsconfig?: TypescriptConfigOptions;
                                                                                                                                                                                                                                                                                                tsconfigDev?: TypescriptConfigOptions;
                                                                                                                                                                                                                                                                                                tsconfigDevFile?: string;
                                                                                                                                                                                                                                                                                                tsJestOptions?: TsJestOptions;
                                                                                                                                                                                                                                                                                                typescriptVersion?: string;
                                                                                                                                                                                                                                                                                                versionrcOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                                vscode?: boolean;
                                                                                                                                                                                                                                                                                                watchExcludes?: string[];
                                                                                                                                                                                                                                                                                                watchIncludes?: string[];
                                                                                                                                                                                                                                                                                                workflowBootstrapSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                workflowContainerImage?: string;
                                                                                                                                                                                                                                                                                                workflowGitIdentity?: GitIdentity;
                                                                                                                                                                                                                                                                                                workflowNodeVersion?: string;
                                                                                                                                                                                                                                                                                                workflowPackageCache?: boolean;
                                                                                                                                                                                                                                                                                                workflowRunsOn?: string[];
                                                                                                                                                                                                                                                                                                workflowRunsOnGroup?: GroupRunnerOptions;
                                                                                                                                                                                                                                                                                                yarnBerryOptions?: YarnBerryOptions;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                            • AwsCdkTypeScriptAppOptions
                                                                                                                                                                                                                                                                                              • ServerlessProjectOptions
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            addPackageManagerToDevEngines? +ServerlessProjectOptions | cdk-serverless
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Interface ServerlessProjectOptions

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              interface ServerlessProjectOptions {
                                                                                                                                                                                                                                                                                                  addPackageManagerToDevEngines?: boolean;
                                                                                                                                                                                                                                                                                                  allowLibraryDependencies?: boolean;
                                                                                                                                                                                                                                                                                                  app?: string;
                                                                                                                                                                                                                                                                                                  appEntrypoint?: string;
                                                                                                                                                                                                                                                                                                  artifactsDirectory?: string;
                                                                                                                                                                                                                                                                                                  auditDeps?: boolean;
                                                                                                                                                                                                                                                                                                  auditDepsOptions?: AuditOptions;
                                                                                                                                                                                                                                                                                                  authorEmail?: string;
                                                                                                                                                                                                                                                                                                  authorName?: string;
                                                                                                                                                                                                                                                                                                  authorOrganization?: boolean;
                                                                                                                                                                                                                                                                                                  authorUrl?: string;
                                                                                                                                                                                                                                                                                                  autoApproveOptions?: AutoApproveOptions;
                                                                                                                                                                                                                                                                                                  autoApproveUpgrades?: boolean;
                                                                                                                                                                                                                                                                                                  autoDetectBin?: boolean;
                                                                                                                                                                                                                                                                                                  autoMerge?: boolean;
                                                                                                                                                                                                                                                                                                  autoMergeOptions?: AutoMergeOptions;
                                                                                                                                                                                                                                                                                                  bin?: Record<string, string>;
                                                                                                                                                                                                                                                                                                  biome?: boolean;
                                                                                                                                                                                                                                                                                                  biomeOptions?: BiomeOptions;
                                                                                                                                                                                                                                                                                                  bugsEmail?: string;
                                                                                                                                                                                                                                                                                                  bugsUrl?: string;
                                                                                                                                                                                                                                                                                                  buildCommand?: string;
                                                                                                                                                                                                                                                                                                  buildWorkflow?: boolean;
                                                                                                                                                                                                                                                                                                  buildWorkflowOptions?: BuildWorkflowOptions;
                                                                                                                                                                                                                                                                                                  buildWorkflowTriggers?: Triggers;
                                                                                                                                                                                                                                                                                                  bumpPackage?: string;
                                                                                                                                                                                                                                                                                                  bundledDeps?: string[];
                                                                                                                                                                                                                                                                                                  bundlerOptions?: BundlerOptions;
                                                                                                                                                                                                                                                                                                  bunVersion?: string;
                                                                                                                                                                                                                                                                                                  cdkAssert?: boolean;
                                                                                                                                                                                                                                                                                                  cdkAssertions?: boolean;
                                                                                                                                                                                                                                                                                                  cdkCliVersion?: string;
                                                                                                                                                                                                                                                                                                  cdkDependencies?: string[];
                                                                                                                                                                                                                                                                                                  cdkDependenciesAsDeps?: boolean;
                                                                                                                                                                                                                                                                                                  cdkout?: string;
                                                                                                                                                                                                                                                                                                  cdkTestDependencies?: string[];
                                                                                                                                                                                                                                                                                                  cdkVersion: string;
                                                                                                                                                                                                                                                                                                  cdkVersionPinning?: boolean;
                                                                                                                                                                                                                                                                                                  checkLicenses?: LicenseCheckerOptions;
                                                                                                                                                                                                                                                                                                  clobber?: boolean;
                                                                                                                                                                                                                                                                                                  codeArtifactOptions?: CodeArtifactOptions;
                                                                                                                                                                                                                                                                                                  codeCov?: boolean;
                                                                                                                                                                                                                                                                                                  codeCovTokenSecret?: string;
                                                                                                                                                                                                                                                                                                  commitGenerated?: boolean;
                                                                                                                                                                                                                                                                                                  constructsVersion?: string;
                                                                                                                                                                                                                                                                                                  context?: { [key: string]: any };
                                                                                                                                                                                                                                                                                                  copyrightOwner?: string;
                                                                                                                                                                                                                                                                                                  copyrightPeriod?: string;
                                                                                                                                                                                                                                                                                                  defaultReleaseBranch: string;
                                                                                                                                                                                                                                                                                                  deleteOrphanedLockFiles?: boolean;
                                                                                                                                                                                                                                                                                                  dependabot?: boolean;
                                                                                                                                                                                                                                                                                                  dependabotOptions?: DependabotOptions;
                                                                                                                                                                                                                                                                                                  deps?: string[];
                                                                                                                                                                                                                                                                                                  depsUpgrade?: boolean;
                                                                                                                                                                                                                                                                                                  depsUpgradeOptions?: UpgradeDependenciesOptions;
                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                  devContainer?: boolean;
                                                                                                                                                                                                                                                                                                  devDeps?: string[];
                                                                                                                                                                                                                                                                                                  devEngines?: DevEngines;
                                                                                                                                                                                                                                                                                                  disableTsconfig?: boolean;
                                                                                                                                                                                                                                                                                                  disableTsconfigDev?: boolean;
                                                                                                                                                                                                                                                                                                  docgen?: boolean;
                                                                                                                                                                                                                                                                                                  docsDirectory?: string;
                                                                                                                                                                                                                                                                                                  edgeLambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                  entrypoint?: string;
                                                                                                                                                                                                                                                                                                  entrypointTypes?: string;
                                                                                                                                                                                                                                                                                                  eslint?: boolean;
                                                                                                                                                                                                                                                                                                  eslintOptions?: EslintOptions;
                                                                                                                                                                                                                                                                                                  experimentalIntegRunner?: boolean;
                                                                                                                                                                                                                                                                                                  featureFlags?: ICdkFeatureFlags;
                                                                                                                                                                                                                                                                                                  github?: boolean;
                                                                                                                                                                                                                                                                                                  githubOptions?: GitHubOptions;
                                                                                                                                                                                                                                                                                                  gitignore?: string[];
                                                                                                                                                                                                                                                                                                  gitIgnoreOptions?: IgnoreFileOptions;
                                                                                                                                                                                                                                                                                                  gitOptions?: GitOptions;
                                                                                                                                                                                                                                                                                                  gitpod?: boolean;
                                                                                                                                                                                                                                                                                                  homepage?: string;
                                                                                                                                                                                                                                                                                                  integrationTestAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                  jest?: boolean;
                                                                                                                                                                                                                                                                                                  jestOptions?: JestOptions;
                                                                                                                                                                                                                                                                                                  jsiiReleaseVersion?: string;
                                                                                                                                                                                                                                                                                                  keywords?: string[];
                                                                                                                                                                                                                                                                                                  lambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                  lambdaExtensionAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                  lambdaOptions?: LambdaFunctionCommonOptions;
                                                                                                                                                                                                                                                                                                  libdir?: string;
                                                                                                                                                                                                                                                                                                  license?: string;
                                                                                                                                                                                                                                                                                                  licensed?: boolean;
                                                                                                                                                                                                                                                                                                  logging?: LoggerOptions;
                                                                                                                                                                                                                                                                                                  majorVersion?: number;
                                                                                                                                                                                                                                                                                                  maxNodeVersion?: string;
                                                                                                                                                                                                                                                                                                  mergify?: boolean;
                                                                                                                                                                                                                                                                                                  mergifyOptions?: MergifyOptions;
                                                                                                                                                                                                                                                                                                  minMajorVersion?: number;
                                                                                                                                                                                                                                                                                                  minNodeVersion?: string;
                                                                                                                                                                                                                                                                                                  mutableBuild?: boolean;
                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                  nextVersionCommand?: string;
                                                                                                                                                                                                                                                                                                  npmAccess?: NpmAccess;
                                                                                                                                                                                                                                                                                                  npmDistTag?: string;
                                                                                                                                                                                                                                                                                                  npmignore?: string[];
                                                                                                                                                                                                                                                                                                  npmignoreEnabled?: boolean;
                                                                                                                                                                                                                                                                                                  npmIgnoreOptions?: IgnoreFileOptions;
                                                                                                                                                                                                                                                                                                  npmProvenance?: boolean;
                                                                                                                                                                                                                                                                                                  npmRegistry?: string;
                                                                                                                                                                                                                                                                                                  npmRegistryUrl?: string;
                                                                                                                                                                                                                                                                                                  npmTokenSecret?: string;
                                                                                                                                                                                                                                                                                                  npmTrustedPublishing?: boolean;
                                                                                                                                                                                                                                                                                                  outdir?: string;
                                                                                                                                                                                                                                                                                                  package?: boolean;
                                                                                                                                                                                                                                                                                                  packageManager?: NodePackageManager;
                                                                                                                                                                                                                                                                                                  packageName?: string;
                                                                                                                                                                                                                                                                                                  parent?: Project;
                                                                                                                                                                                                                                                                                                  peerDependencyOptions?: PeerDependencyOptions;
                                                                                                                                                                                                                                                                                                  peerDeps?: string[];
                                                                                                                                                                                                                                                                                                  pnpmVersion?: string;
                                                                                                                                                                                                                                                                                                  postBuildSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                  prerelease?: string;
                                                                                                                                                                                                                                                                                                  prettier?: boolean;
                                                                                                                                                                                                                                                                                                  prettierOptions?: PrettierOptions;
                                                                                                                                                                                                                                                                                                  projectTree?: boolean;
                                                                                                                                                                                                                                                                                                  projectType?: ProjectType;
                                                                                                                                                                                                                                                                                                  projenCommand?: string;
                                                                                                                                                                                                                                                                                                  projenCredentials?: GithubCredentials;
                                                                                                                                                                                                                                                                                                  projenDevDependency?: boolean;
                                                                                                                                                                                                                                                                                                  projenrcJs?: boolean;
                                                                                                                                                                                                                                                                                                  projenrcJson?: boolean;
                                                                                                                                                                                                                                                                                                  projenrcJsonOptions?: ProjenrcJsonOptions;
                                                                                                                                                                                                                                                                                                  projenrcJsOptions?: ProjenrcOptions;
                                                                                                                                                                                                                                                                                                  projenrcTs?: boolean;
                                                                                                                                                                                                                                                                                                  projenrcTsOptions?: ProjenrcOptions;
                                                                                                                                                                                                                                                                                                  projenTokenSecret?: string;
                                                                                                                                                                                                                                                                                                  projenVersion?: string;
                                                                                                                                                                                                                                                                                                  publishDryRun?: boolean;
                                                                                                                                                                                                                                                                                                  publishTasks?: boolean;
                                                                                                                                                                                                                                                                                                  pullRequestTemplate?: boolean;
                                                                                                                                                                                                                                                                                                  pullRequestTemplateContents?: string[];
                                                                                                                                                                                                                                                                                                  readme?: SampleReadmeProps;
                                                                                                                                                                                                                                                                                                  releasableCommits?: ReleasableCommits;
                                                                                                                                                                                                                                                                                                  release?: boolean;
                                                                                                                                                                                                                                                                                                  releaseBranches?: { [name: string]: BranchOptions };
                                                                                                                                                                                                                                                                                                  releaseEnvironment?: string;
                                                                                                                                                                                                                                                                                                  releaseEveryCommit?: boolean;
                                                                                                                                                                                                                                                                                                  releaseFailureIssue?: boolean;
                                                                                                                                                                                                                                                                                                  releaseFailureIssueLabel?: string;
                                                                                                                                                                                                                                                                                                  releaseSchedule?: string;
                                                                                                                                                                                                                                                                                                  releaseTagPrefix?: string;
                                                                                                                                                                                                                                                                                                  releaseToNpm?: boolean;
                                                                                                                                                                                                                                                                                                  releaseTrigger?: ReleaseTrigger;
                                                                                                                                                                                                                                                                                                  releaseWorkflow?: boolean;
                                                                                                                                                                                                                                                                                                  releaseWorkflowEnv?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                  releaseWorkflowName?: string;
                                                                                                                                                                                                                                                                                                  releaseWorkflowSetupSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                  renovatebot?: boolean;
                                                                                                                                                                                                                                                                                                  renovatebotOptions?: RenovatebotOptions;
                                                                                                                                                                                                                                                                                                  repository?: string;
                                                                                                                                                                                                                                                                                                  repositoryDirectory?: string;
                                                                                                                                                                                                                                                                                                  requireApproval?: ApprovalLevel;
                                                                                                                                                                                                                                                                                                  sampleCode?: boolean;
                                                                                                                                                                                                                                                                                                  scopedPackagesOptions?: ScopedPackagesOptions[];
                                                                                                                                                                                                                                                                                                  scripts?: { [name: string]: string };
                                                                                                                                                                                                                                                                                                  singletonLambdaAutoDiscover?: boolean;
                                                                                                                                                                                                                                                                                                  srcdir?: string;
                                                                                                                                                                                                                                                                                                  stability?: string;
                                                                                                                                                                                                                                                                                                  stale?: boolean;
                                                                                                                                                                                                                                                                                                  staleOptions?: StaleOptions;
                                                                                                                                                                                                                                                                                                  testdir?: string;
                                                                                                                                                                                                                                                                                                  tsconfig?: TypescriptConfigOptions;
                                                                                                                                                                                                                                                                                                  tsconfigDev?: TypescriptConfigOptions;
                                                                                                                                                                                                                                                                                                  tsconfigDevFile?: string;
                                                                                                                                                                                                                                                                                                  tsJestOptions?: TsJestOptions;
                                                                                                                                                                                                                                                                                                  typescriptVersion?: string;
                                                                                                                                                                                                                                                                                                  versionrcOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                                  vscode?: boolean;
                                                                                                                                                                                                                                                                                                  watchExcludes?: string[];
                                                                                                                                                                                                                                                                                                  watchIncludes?: string[];
                                                                                                                                                                                                                                                                                                  workflowBootstrapSteps?: JobStep[];
                                                                                                                                                                                                                                                                                                  workflowContainerImage?: string;
                                                                                                                                                                                                                                                                                                  workflowGitIdentity?: GitIdentity;
                                                                                                                                                                                                                                                                                                  workflowNodeVersion?: string;
                                                                                                                                                                                                                                                                                                  workflowPackageCache?: boolean;
                                                                                                                                                                                                                                                                                                  workflowRunsOn?: string[];
                                                                                                                                                                                                                                                                                                  workflowRunsOnGroup?: GroupRunnerOptions;
                                                                                                                                                                                                                                                                                                  yarnBerryOptions?: YarnBerryOptions;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              • AwsCdkTypeScriptAppOptions +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                • ServerlessProjectOptions
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              addPackageManagerToDevEngines? allowLibraryDependencies? app? appEntrypoint? @@ -182,106 +208,296 @@ workflowRunsOn? workflowRunsOnGroup? yarnBerryOptions? -

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              addPackageManagerToDevEngines?: boolean

                                                                                                                                                                                                                                                                                              Automatically add the resolved packageManager to devEngines.packageManager +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              addPackageManagerToDevEngines?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically add the resolved packageManager to devEngines.packageManager in package.json, setting onFail to ignore.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              allowLibraryDependencies?: boolean

                                                                                                                                                                                                                                                                                              Allow the project to include peerDependencies and bundledDependencies. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              allowLibraryDependencies?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Allow the project to include peerDependencies and bundledDependencies. This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              app?: string

                                                                                                                                                                                                                                                                                              The command line to execute in order to synthesize the CDK application +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              app?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The command line to execute in order to synthesize the CDK application (language specific).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              appEntrypoint?: string

                                                                                                                                                                                                                                                                                              The CDK app's entrypoint (relative to the source directory, which is +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              appEntrypoint?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The CDK app's entrypoint (relative to the source directory, which is "src" by default).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "main.ts"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              artifactsDirectory?: string

                                                                                                                                                                                                                                                                                              A directory which will contain build artifacts.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "dist"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              auditDeps?: boolean

                                                                                                                                                                                                                                                                                              Run security audit on dependencies.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "main.ts"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              artifactsDirectory?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              A directory which will contain build artifacts.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "dist"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              auditDeps?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Run security audit on dependencies.

                                                                                                                                                                                                                                                                                              When enabled, creates an "audit" task that checks for known security vulnerabilities in dependencies. By default, runs during every build and checks for "high" severity vulnerabilities or above in all dependencies (including dev dependencies).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              auditDepsOptions?: AuditOptions

                                                                                                                                                                                                                                                                                              Security audit options.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              authorEmail?: string

                                                                                                                                                                                                                                                                                              Author's e-mail

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              authorName?: string

                                                                                                                                                                                                                                                                                              Author's name

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              authorOrganization?: boolean

                                                                                                                                                                                                                                                                                              Is the author an organization

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              authorUrl?: string

                                                                                                                                                                                                                                                                                              Author's URL / Website

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              autoApproveOptions?: AutoApproveOptions

                                                                                                                                                                                                                                                                                              Enable and configure the 'auto approve' workflow.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - auto approve is disabled
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              autoApproveUpgrades?: boolean

                                                                                                                                                                                                                                                                                              Automatically approve deps upgrade PRs, allowing them to be +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              auditDepsOptions?: AuditOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Security audit options.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              authorEmail?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Author's e-mail

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              authorName?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Author's name

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              authorOrganization?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Is the author an organization

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              authorUrl?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Author's URL / Website

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              autoApproveOptions?: AutoApproveOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable and configure the 'auto approve' workflow.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - auto approve is disabled
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              autoApproveUpgrades?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).

                                                                                                                                                                                                                                                                                              Throw if set to true but autoApproveOptions are not defined.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              autoDetectBin?: boolean

                                                                                                                                                                                                                                                                                              Automatically add all executables under the bin directory to your +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              autoDetectBin?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically add all executables under the bin directory to your package.json file under the bin section.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              autoMerge?: boolean

                                                                                                                                                                                                                                                                                              Enable automatic merging on GitHub. Has no effect if github.mergify +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              autoMerge?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable automatic merging on GitHub. Has no effect if github.mergify is set to false.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              autoMergeOptions?: AutoMergeOptions

                                                                                                                                                                                                                                                                                              Configure options for automatic merging on GitHub. Has no effect if +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              autoMergeOptions?: AutoMergeOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configure options for automatic merging on GitHub. Has no effect if github.mergify or autoMerge is set to false.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • see defaults in AutoMergeOptions
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bin?: Record<string, string>

                                                                                                                                                                                                                                                                                              Binary programs vended with your module.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bin?: Record<string, string>
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Binary programs vended with your module.

                                                                                                                                                                                                                                                                                              You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              biome?: boolean

                                                                                                                                                                                                                                                                                              Setup Biome.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              biomeOptions?: BiomeOptions

                                                                                                                                                                                                                                                                                              Biome options

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              bugsEmail?: string

                                                                                                                                                                                                                                                                                              The email address to which issues should be reported.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bugsUrl?: string

                                                                                                                                                                                                                                                                                              The url to your project's issue tracker.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              buildCommand?: string

                                                                                                                                                                                                                                                                                              A command to execute before synthesis. This command will be called when +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              biome?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Setup Biome.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              biomeOptions?: BiomeOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Biome options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bugsEmail?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The email address to which issues should be reported.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bugsUrl?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The url to your project's issue tracker.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              buildCommand?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              A command to execute before synthesis. This command will be called when running cdk synth or when cdk watch identifies a change in your source code before redeployment.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no build command
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              buildWorkflow?: boolean

                                                                                                                                                                                                                                                                                              Define a GitHub workflow for building PRs.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true if not a subproject
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              buildWorkflowOptions?: BuildWorkflowOptions

                                                                                                                                                                                                                                                                                              Options for PR build workflow.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              buildWorkflowTriggers?: Triggers

                                                                                                                                                                                                                                                                                              Build workflow triggers

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "{ pullRequest: {}, workflowDispatch: {} }"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no build command
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              buildWorkflow?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Define a GitHub workflow for building PRs.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true if not a subproject
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              buildWorkflowOptions?: BuildWorkflowOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for PR build workflow.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              buildWorkflowTriggers?: Triggers
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Build workflow triggers

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "{ pullRequest: {}, workflowDispatch: {} }"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • Use buildWorkflowOptions.workflowTriggers
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bumpPackage?: string

                                                                                                                                                                                                                                                                                              The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bumpPackage?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

                                                                                                                                                                                                                                                                                              This can be any compatible package version, including the deprecated standard-version@9.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - A recent version of "commit-and-tag-version"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              bundledDeps?: string[]

                                                                                                                                                                                                                                                                                              List of dependencies to bundle into this module. These modules will be +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - A recent version of "commit-and-tag-version"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bundledDeps?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              List of dependencies to bundle into this module. These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

                                                                                                                                                                                                                                                                                              The recommendation is to only specify the module name here (e.g. @@ -290,151 +506,398 @@ file with the latest version (^). You can specify semver requirements in the same syntax passed to pnpm add or npm i (e.g. express@^2) and this will be what your package.json will eventually include.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bundlerOptions?: BundlerOptions

                                                                                                                                                                                                                                                                                              Options for Bundler.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bunVersion?: string

                                                                                                                                                                                                                                                                                              The version of Bun to use if using Bun as a package manager.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "latest"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              cdkAssert?: boolean

                                                                                                                                                                                                                                                                                              Warning: NodeJS only. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bundlerOptions?: BundlerOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for Bundler.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bunVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The version of Bun to use if using Bun as a package manager.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "latest"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkAssert?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Warning: NodeJS only. Install the @aws-cdk/assert library?

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              The @aws-cdk/assert library is deprecated in favor of +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The @aws-cdk/assert library is deprecated in favor of @aws-cdk/assertions (in V1) and included in aws-cdk-lib for V2.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              cdkAssertions?: boolean

                                                                                                                                                                                                                                                                                              Install the assertions library?

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkAssertions?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Install the assertions library?

                                                                                                                                                                                                                                                                                              Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              cdkCliVersion?: string

                                                                                                                                                                                                                                                                                              Version range of the AWS CDK CLI to depend on.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkCliVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Version range of the AWS CDK CLI to depend on.

                                                                                                                                                                                                                                                                                              Can be either a specific version, or an NPM version range.

                                                                                                                                                                                                                                                                                              By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "^2"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              cdkDependencies?: string[]

                                                                                                                                                                                                                                                                                              Which AWS CDKv1 modules this project requires

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              cdkDependenciesAsDeps?: boolean

                                                                                                                                                                                                                                                                                              If this is enabled (default), all modules declared in cdkDependencies will be also added as +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "^2"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkDependencies?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Which AWS CDKv1 modules this project requires

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkDependenciesAsDeps?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies).

                                                                                                                                                                                                                                                                                              This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, cdkDependencies will be added to devDependencies to ensure they are present during development.

                                                                                                                                                                                                                                                                                              Note: this setting only applies to construct library projects

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Not supported in CDK v2.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              cdkout?: string

                                                                                                                                                                                                                                                                                              cdk.out directory.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "cdk.out"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              cdkTestDependencies?: string[]

                                                                                                                                                                                                                                                                                              AWS CDK modules required for testing.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              cdkVersion: string

                                                                                                                                                                                                                                                                                              Minimum version of the AWS CDK to depend on.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "2.189.1"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              cdkVersionPinning?: boolean

                                                                                                                                                                                                                                                                                              Use pinned version instead of caret version for CDK.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Not supported in CDK v2.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkout?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              cdk.out directory.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "cdk.out"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkTestDependencies?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              AWS CDK modules required for testing.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkVersion: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Minimum version of the AWS CDK to depend on.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "2.189.1"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              cdkVersionPinning?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use pinned version instead of caret version for CDK.

                                                                                                                                                                                                                                                                                              You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              checkLicenses?: LicenseCheckerOptions

                                                                                                                                                                                                                                                                                              Configure which licenses should be deemed acceptable for use by dependencies

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              checkLicenses?: LicenseCheckerOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configure which licenses should be deemed acceptable for use by dependencies

                                                                                                                                                                                                                                                                                              This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no license checks are run during the build and all licenses will be accepted
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              clobber?: boolean

                                                                                                                                                                                                                                                                                              Add a clobber task which resets the repo to origin.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true, but false for subprojects
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              codeArtifactOptions?: CodeArtifactOptions

                                                                                                                                                                                                                                                                                              Options for npm packages using AWS CodeArtifact. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no license checks are run during the build and all licenses will be accepted
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              clobber?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Add a clobber task which resets the repo to origin.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true, but false for subprojects
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              codeArtifactOptions?: CodeArtifactOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - undefined
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              codeCov?: boolean

                                                                                                                                                                                                                                                                                              Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - undefined
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              codeCov?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via codeCovTokenSecret.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              codeCovTokenSecret?: string

                                                                                                                                                                                                                                                                                              Define the secret name for a specified https://codecov.io/ token

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - OIDC auth is used
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              commitGenerated?: boolean

                                                                                                                                                                                                                                                                                              Whether to commit the managed files by default.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              constructsVersion?: string

                                                                                                                                                                                                                                                                                              Minimum version of the constructs library to depend on.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
                                                                                                                                                                                                                                                                                              "10.5.1".
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              context?: { [key: string]: any }

                                                                                                                                                                                                                                                                                              Additional context to include in cdk.json.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no additional context
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              copyrightOwner?: string

                                                                                                                                                                                                                                                                                              License copyright owner.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              codeCovTokenSecret?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Define the secret name for a specified https://codecov.io/ token

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - OIDC auth is used
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              commitGenerated?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Whether to commit the managed files by default.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              constructsVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Minimum version of the constructs library to depend on.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
                                                                                                                                                                                                                                                                                              "10.5.1".
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              context?: { [key: string]: any }
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Additional context to include in cdk.json.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no additional context
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              copyrightOwner?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              License copyright owner.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • defaults to the value of authorName or "" if authorName is undefined.
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              copyrightPeriod?: string

                                                                                                                                                                                                                                                                                              The copyright years to put in the LICENSE file.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - current year
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              defaultReleaseBranch: string

                                                                                                                                                                                                                                                                                              The name of the main release branch.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "main"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              deleteOrphanedLockFiles?: boolean

                                                                                                                                                                                                                                                                                              Automatically delete lockfiles from package managers that are not the +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              copyrightPeriod?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The copyright years to put in the LICENSE file.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - current year
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              defaultReleaseBranch: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The name of the main release branch.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "main"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              deleteOrphanedLockFiles?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists.

                                                                                                                                                                                                                                                                                              This is useful when migrating between package managers to avoid conflicts.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              dependabot?: boolean

                                                                                                                                                                                                                                                                                              Use dependabot to handle dependency upgrades. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              dependabot?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use dependabot to handle dependency upgrades. Cannot be used in conjunction with depsUpgrade.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              dependabotOptions?: DependabotOptions

                                                                                                                                                                                                                                                                                              Options for dependabot.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              deps?: string[]

                                                                                                                                                                                                                                                                                              Runtime dependencies of this module.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              dependabotOptions?: DependabotOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for dependabot.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              deps?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Runtime dependencies of this module.

                                                                                                                                                                                                                                                                                              The recommendation is to only specify the module name here (e.g. express). This will behave similar to pnpm add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to pnpm add or npm i (e.g. express@^2) and this will be what your package.json will eventually include.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              [ 'express', 'lodash', 'foo@^2' ]
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              [ 'express', 'lodash', 'foo@^2' ]
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              depsUpgrade?: boolean

                                                                                                                                                                                                                                                                                              Use tasks and github workflows to handle dependency upgrades. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              depsUpgrade?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with dependabot.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • true for root projects, false for subprojects
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              depsUpgradeOptions?: UpgradeDependenciesOptions

                                                                                                                                                                                                                                                                                              Options for UpgradeDependencies.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              description?: string

                                                                                                                                                                                                                                                                                              The description is just a string that helps people understand the purpose of the package. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              depsUpgradeOptions?: UpgradeDependenciesOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for UpgradeDependencies.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              description?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              devContainer?: boolean

                                                                                                                                                                                                                                                                                              Add a VSCode development environment (used for GitHub Codespaces)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              devDeps?: string[]

                                                                                                                                                                                                                                                                                              Build dependencies for this module. These dependencies will only be +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              devContainer?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Add a VSCode development environment (used for GitHub Codespaces)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              devDeps?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

                                                                                                                                                                                                                                                                                              The recommendation is to only specify the module name here (e.g. @@ -443,170 +906,459 @@ file with the latest version (^). You can specify semver requirements in the same syntax passed to pnpm add or npm i (e.g. express@^2) and this will be what your package.json will eventually include.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              [ 'typescript', '@types/express' ]
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              [ 'typescript', '@types/express' ]
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              devEngines?: DevEngines

                                                                                                                                                                                                                                                                                              Configure the devEngines field in package.json.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              devEngines?: DevEngines
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configure the devEngines field in package.json.

                                                                                                                                                                                                                                                                                              The devEngines.packageManager field is automatically populated based on the resolved packageManager value. Any fields provided here are merged with the auto-populated packageManager entry.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              disableTsconfig?: boolean

                                                                                                                                                                                                                                                                                              Do not generate a tsconfig.json file (used by jsii projects since +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              disableTsconfig?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              disableTsconfigDev?: boolean

                                                                                                                                                                                                                                                                                              Do not generate a tsconfig.dev.json file.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              docgen?: boolean

                                                                                                                                                                                                                                                                                              Docgen by Typedoc

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              docsDirectory?: string

                                                                                                                                                                                                                                                                                              Docs directory

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "docs"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              edgeLambdaAutoDiscover?: boolean

                                                                                                                                                                                                                                                                                              Automatically adds an cloudfront.experimental.EdgeFunction for each +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              disableTsconfigDev?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Do not generate a tsconfig.dev.json file.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              docgen?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Docgen by Typedoc

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              docsDirectory?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Docs directory

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "docs"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              edgeLambdaAutoDiscover?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically adds an cloudfront.experimental.EdgeFunction for each .edge-lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              entrypoint?: string

                                                                                                                                                                                                                                                                                              Module entrypoint (main in package.json)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              entrypoint?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Module entrypoint (main in package.json)

                                                                                                                                                                                                                                                                                              Set to an empty string to not include main in your package.json

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "lib/index.js"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              entrypointTypes?: string

                                                                                                                                                                                                                                                                                              The .d.ts file that includes the type declarations for this module.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              eslint?: boolean

                                                                                                                                                                                                                                                                                              Setup eslint.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true, unless biome is enabled
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              eslintOptions?: EslintOptions

                                                                                                                                                                                                                                                                                              Eslint options

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - opinionated default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              experimentalIntegRunner?: boolean

                                                                                                                                                                                                                                                                                              Enable experimental support for the AWS CDK integ-runner.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                              @experimental
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              featureFlags?: ICdkFeatureFlags

                                                                                                                                                                                                                                                                                              Feature flags that should be enabled in cdk.json.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "lib/index.js"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              entrypointTypes?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The .d.ts file that includes the type declarations for this module.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              eslint?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Setup eslint.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true, unless biome is enabled
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              eslintOptions?: EslintOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Eslint options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - opinionated default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              experimentalIntegRunner?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable experimental support for the AWS CDK integ-runner.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                              @experimental
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              featureFlags?: ICdkFeatureFlags
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Feature flags that should be enabled in cdk.json.

                                                                                                                                                                                                                                                                                              Make sure to double-check any changes to feature flags in cdk.json before deploying. Unexpected changes may cause breaking changes in your CDK app. You can overwrite any feature flag by passing it into the context field.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no feature flags are enabled by default
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              github?: boolean

                                                                                                                                                                                                                                                                                              Enable GitHub integration.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no feature flags are enabled by default
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              github?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable GitHub integration.

                                                                                                                                                                                                                                                                                              Enabled by default for root projects. Disabled for non-root projects.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              githubOptions?: GitHubOptions

                                                                                                                                                                                                                                                                                              Options for GitHub integration

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - see GitHubOptions
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              gitignore?: string[]

                                                                                                                                                                                                                                                                                              Additional entries to .gitignore

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              gitIgnoreOptions?: IgnoreFileOptions

                                                                                                                                                                                                                                                                                              Configuration options for .gitignore file

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              gitOptions?: GitOptions

                                                                                                                                                                                                                                                                                              Configuration options for git

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              gitpod?: boolean

                                                                                                                                                                                                                                                                                              Add a Gitpod development environment

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              homepage?: string

                                                                                                                                                                                                                                                                                              Package's Homepage / Website

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              integrationTestAutoDiscover?: boolean

                                                                                                                                                                                                                                                                                              Automatically discovers and creates integration tests for each .integ.ts +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              githubOptions?: GitHubOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for GitHub integration

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - see GitHubOptions
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              gitignore?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Additional entries to .gitignore

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              gitIgnoreOptions?: IgnoreFileOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configuration options for .gitignore file

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              gitOptions?: GitOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configuration options for git

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              gitpod?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Add a Gitpod development environment

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              homepage?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Package's Homepage / Website

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              integrationTestAutoDiscover?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically discovers and creates integration tests for each .integ.ts file in under your test directory.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              jest?: boolean

                                                                                                                                                                                                                                                                                              Setup jest unit tests

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              jestOptions?: JestOptions

                                                                                                                                                                                                                                                                                              Jest options

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              jsiiReleaseVersion?: string

                                                                                                                                                                                                                                                                                              Version requirement of publib which is used to publish modules to npm.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "latest"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              keywords?: string[]

                                                                                                                                                                                                                                                                                              Keywords to include in package.json.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              lambdaAutoDiscover?: boolean

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              jest?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Setup jest unit tests

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              jestOptions?: JestOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Jest options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              jsiiReleaseVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Version requirement of publib which is used to publish modules to npm.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "latest"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              keywords?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Keywords to include in package.json.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              lambdaAutoDiscover?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              lambdaExtensionAutoDiscover?: boolean

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              lambdaExtensionAutoDiscover?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              lambdaOptions?: LambdaFunctionCommonOptions

                                                                                                                                                                                                                                                                                              Common options for all AWS Lambda functions.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              libdir?: string

                                                                                                                                                                                                                                                                                              Typescript artifacts output directory

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "lib"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              license?: string

                                                                                                                                                                                                                                                                                              License's SPDX identifier. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              lambdaOptions?: LambdaFunctionCommonOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Common options for all AWS Lambda functions.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              libdir?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Typescript artifacts output directory

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "lib"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              license?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "Apache-2.0"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              licensed?: boolean

                                                                                                                                                                                                                                                                                              Indicates if a license should be added.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              logging?: LoggerOptions

                                                                                                                                                                                                                                                                                              Configure logging options such as verbosity.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              {}
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              majorVersion?: number

                                                                                                                                                                                                                                                                                              Major version to release from the default branch.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "Apache-2.0"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              licensed?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Indicates if a license should be added.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              logging?: LoggerOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configure logging options such as verbosity.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              {}
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              majorVersion?: number
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Major version to release from the default branch.

                                                                                                                                                                                                                                                                                              If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - Major version is not enforced.
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              maxNodeVersion?: string

                                                                                                                                                                                                                                                                                              The maximum node version supported by this package. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - Major version is not enforced.
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              maxNodeVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The maximum node version supported by this package. Most projects should not use this option.

                                                                                                                                                                                                                                                                                              The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field.

                                                                                                                                                                                                                                                                                              You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no maximum version is enforced
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              mergify?: boolean

                                                                                                                                                                                                                                                                                              Whether mergify should be enabled on this repository or not.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              use githubOptions.mergify instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              mergifyOptions?: MergifyOptions

                                                                                                                                                                                                                                                                                              Options for mergify

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              use githubOptions.mergifyOptions instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              minMajorVersion?: number

                                                                                                                                                                                                                                                                                              Minimal Major version to release

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no maximum version is enforced
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              mergify?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Whether mergify should be enabled on this repository or not.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              use githubOptions.mergify instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              mergifyOptions?: MergifyOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for mergify

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              use githubOptions.mergifyOptions instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              minMajorVersion?: number
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Minimal Major version to release

                                                                                                                                                                                                                                                                                              This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

                                                                                                                                                                                                                                                                                              Can not be set together with majorVersion.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - No minimum version is being enforced
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              minNodeVersion?: string

                                                                                                                                                                                                                                                                                              The minimum node version required by this package to function. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - No minimum version is being enforced
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              minNodeVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The minimum node version required by this package to function. Most projects should not use this option.

                                                                                                                                                                                                                                                                                              The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field.

                                                                                                                                                                                                                                                                                              @@ -615,24 +1367,52 @@ Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible.

                                                                                                                                                                                                                                                                                              To change the node version of your CI/CD workflows, use workflowNodeVersion.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no minimum version is enforced
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              mutableBuild?: boolean

                                                                                                                                                                                                                                                                                              Automatically update files modified during builds to pull-request branches. This means +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no minimum version is enforced
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              mutableBuild?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

                                                                                                                                                                                                                                                                                              Implies that PR builds do not have anti-tamper checks.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • Use buildWorkflowOptions.mutableBuild
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                              This is the name of your project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              $BASEDIR
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              nextVersionCommand?: string

                                                                                                                                                                                                                                                                                              A shell command to control the next version to release.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              name: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              This is the name of your project.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              $BASEDIR
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              nextVersionCommand?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              A shell command to control the next version to release.

                                                                                                                                                                                                                                                                                              If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment:

                                                                                                                                                                                                                                                                                              @@ -651,81 +1431,216 @@

                                                                                                                                                                                                                                                                                              This setting cannot be specified together with minMajorVersion; the invoked script can be used to achieve the effects of minMajorVersion.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - The next version will be determined based on the commit history and project settings.
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmAccess?: NpmAccess

                                                                                                                                                                                                                                                                                              Access level of the npm package.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - The next version will be determined based on the commit history and project settings.
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmAccess?: NpmAccess
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Access level of the npm package.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              npmDistTag?: string

                                                                                                                                                                                                                                                                                              The npmDistTag to use when publishing from the default branch.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmDistTag?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The npmDistTag to use when publishing from the default branch.

                                                                                                                                                                                                                                                                                              To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "latest"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmignore?: string[]

                                                                                                                                                                                                                                                                                              Additional entries to .npmignore.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "latest"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmignore?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Additional entries to .npmignore.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • use project.addPackageIgnore
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              npmignoreEnabled?: boolean

                                                                                                                                                                                                                                                                                              Defines an .npmignore file. Normally this is only needed for libraries that +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmignoreEnabled?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmIgnoreOptions?: IgnoreFileOptions

                                                                                                                                                                                                                                                                                              Configuration options for .npmignore file

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              npmProvenance?: boolean

                                                                                                                                                                                                                                                                                              Should provenance statements be generated when the package is published.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmIgnoreOptions?: IgnoreFileOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Configuration options for .npmignore file

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmProvenance?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Should provenance statements be generated when the package is published.

                                                                                                                                                                                                                                                                                              A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

                                                                                                                                                                                                                                                                                              Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              https://docs.npmjs.com/generating-provenance-statements

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true for public packages, false otherwise
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmRegistry?: string

                                                                                                                                                                                                                                                                                              The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              use npmRegistryUrl instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              npmRegistryUrl?: string

                                                                                                                                                                                                                                                                                              The base URL of the npm package registry.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              https://docs.npmjs.com/generating-provenance-statements

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true for public packages, false otherwise
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmRegistry?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              use npmRegistryUrl instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmRegistryUrl?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The base URL of the npm package registry.

                                                                                                                                                                                                                                                                                              Must be a URL (e.g. start with "https://" or "http://")

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "https://registry.npmjs.org"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmTokenSecret?: string

                                                                                                                                                                                                                                                                                              GitHub secret which contains the NPM token to use when publishing packages.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "NPM_TOKEN"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              npmTrustedPublishing?: boolean

                                                                                                                                                                                                                                                                                              Use trusted publishing for publishing to npmjs.com +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "https://registry.npmjs.org"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmTokenSecret?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              GitHub secret which contains the NPM token to use when publishing packages.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "NPM_TOKEN"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              npmTrustedPublishing?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              outdir?: string

                                                                                                                                                                                                                                                                                              The root directory of the project.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              outdir?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The root directory of the project.

                                                                                                                                                                                                                                                                                              Relative to this directory, all files are synthesized.

                                                                                                                                                                                                                                                                                              If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "."
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              package?: boolean

                                                                                                                                                                                                                                                                                              Defines a package task that will produce an npm tarball under the +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "."
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              package?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              packageManager?: NodePackageManager

                                                                                                                                                                                                                                                                                              The Node Package Manager used to execute scripts

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              packageManager?: NodePackageManager
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The Node Package Manager used to execute scripts

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • Detected from the calling process or YARN_CLASSIC if detection fails.
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              $PACKAGE_MANAGER

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              packageName?: string

                                                                                                                                                                                                                                                                                              The "name" in package.json

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - defaults to project name
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              parent?: Project

                                                                                                                                                                                                                                                                                              The parent project, if this project is part of a bigger project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              peerDependencyOptions?: PeerDependencyOptions

                                                                                                                                                                                                                                                                                              Options for peerDeps.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              peerDeps?: string[]

                                                                                                                                                                                                                                                                                              Peer dependencies for this module. Dependencies listed here are required to +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              $PACKAGE_MANAGER

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              packageName?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The "name" in package.json

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - defaults to project name
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              parent?: Project
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The parent project, if this project is part of a bigger project.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              peerDependencyOptions?: PeerDependencyOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for peerDeps.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              peerDeps?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

                                                                                                                                                                                                                                                                                              @@ -736,322 +1651,907 @@ enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              pnpmVersion?: string

                                                                                                                                                                                                                                                                                              The version of PNPM to use if using PNPM as a package manager.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "10.33.0"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              postBuildSteps?: JobStep[]

                                                                                                                                                                                                                                                                                              Steps to execute after build as part of the release workflow.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              prerelease?: string

                                                                                                                                                                                                                                                                                              Bump versions from the default branch as pre-releases (e.g. "beta", +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              pnpmVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The version of PNPM to use if using PNPM as a package manager.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "10.33.0"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              postBuildSteps?: JobStep[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Steps to execute after build as part of the release workflow.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              prerelease?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - normal semantic versions
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              prettier?: boolean

                                                                                                                                                                                                                                                                                              Setup prettier.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              prettierOptions?: PrettierOptions

                                                                                                                                                                                                                                                                                              Prettier options

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projectTree?: boolean

                                                                                                                                                                                                                                                                                              Generate a project tree file (.projen/tree.json) that shows all +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - normal semantic versions
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              prettier?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Setup prettier.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              prettierOptions?: PrettierOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Prettier options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projectTree?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Generate a project tree file (.projen/tree.json) that shows all components and their relationships. Useful for understanding your project structure and debugging.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              experimental

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projectType?: ProjectType

                                                                                                                                                                                                                                                                                              Which type of project this is (library/app).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              ProjectType.UNKNOWN
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              no longer supported at the base project level

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              projenCommand?: string

                                                                                                                                                                                                                                                                                              The shell command to use in order to run the projen CLI.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              experimental

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projectType?: ProjectType
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Which type of project this is (library/app).

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              ProjectType.UNKNOWN
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              no longer supported at the base project level

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenCommand?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The shell command to use in order to run the projen CLI.

                                                                                                                                                                                                                                                                                              Can be used to customize in special environments.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "npx projen"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenCredentials?: GithubCredentials

                                                                                                                                                                                                                                                                                              Choose a method of providing GitHub API access for projen workflows.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - use a personal access token named PROJEN_GITHUB_TOKEN
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenDevDependency?: boolean

                                                                                                                                                                                                                                                                                              Indicates of "projen" should be installed as a devDependency.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true if not a subproject
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenrcJs?: boolean

                                                                                                                                                                                                                                                                                              Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "npx projen"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenCredentials?: GithubCredentials
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Choose a method of providing GitHub API access for projen workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - use a personal access token named PROJEN_GITHUB_TOKEN
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenDevDependency?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Indicates of "projen" should be installed as a devDependency.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true if not a subproject
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcJs?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true if projenrcJson is false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenrcJson?: boolean

                                                                                                                                                                                                                                                                                              Generate (once) .projenrc.json (in JSON). Set to false in order to disable +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true if projenrcJson is false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcJson?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenrcJsonOptions?: ProjenrcJsonOptions

                                                                                                                                                                                                                                                                                              Options for .projenrc.json

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenrcJsOptions?: ProjenrcOptions

                                                                                                                                                                                                                                                                                              Options for .projenrc.js

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              projenrcTs?: boolean

                                                                                                                                                                                                                                                                                              Use TypeScript for your projenrc file (.projenrc.ts).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              true

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              projenrcTsOptions?: ProjenrcOptions

                                                                                                                                                                                                                                                                                              Options for .projenrc.ts

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              projenTokenSecret?: string

                                                                                                                                                                                                                                                                                              The name of a secret which includes a GitHub Personal Access Token to be +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcJsonOptions?: ProjenrcJsonOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for .projenrc.json

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcJsOptions?: ProjenrcOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for .projenrc.js

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcTs?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use TypeScript for your projenrc file (.projenrc.ts).

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              true

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenrcTsOptions?: ProjenrcOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for .projenrc.ts

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenTokenSecret?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the repo, workflows and packages scope.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "PROJEN_GITHUB_TOKEN"
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              use projenCredentials

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              projenVersion?: string

                                                                                                                                                                                                                                                                                              Version of projen to install.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - Defaults to the latest version.
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              publishDryRun?: boolean

                                                                                                                                                                                                                                                                                              Instead of actually publishing to package managers, just print the publishing command.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              publishTasks?: boolean

                                                                                                                                                                                                                                                                                              Define publishing tasks that can be executed manually as well as workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "PROJEN_GITHUB_TOKEN"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              use projenCredentials

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              projenVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Version of projen to install.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - Defaults to the latest version.
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              publishDryRun?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Instead of actually publishing to package managers, just print the publishing command.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              publishTasks?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Define publishing tasks that can be executed manually as well as workflows.

                                                                                                                                                                                                                                                                                              Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              pullRequestTemplate?: boolean

                                                                                                                                                                                                                                                                                              Include a GitHub pull request template.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              pullRequestTemplateContents?: string[]

                                                                                                                                                                                                                                                                                              The contents of the pull request template.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default content
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              readme?: SampleReadmeProps

                                                                                                                                                                                                                                                                                              The README setup.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - { filename: 'README.md', contents: '# replace this' }
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              "{ filename: 'readme.md', contents: '# title' }"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releasableCommits?: ReleasableCommits

                                                                                                                                                                                                                                                                                              Find commits that should be considered releasable +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              pullRequestTemplate?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Include a GitHub pull request template.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              pullRequestTemplateContents?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The contents of the pull request template.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default content
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              readme?: SampleReadmeProps
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The README setup.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - { filename: 'README.md', contents: '# replace this' }
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "{ filename: 'readme.md', contents: '# title' }"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releasableCommits?: ReleasableCommits
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Find commits that should be considered releasable Used to decide if a release is required.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              ReleasableCommits.everyCommit()
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              release?: boolean

                                                                                                                                                                                                                                                                                              Add release management to this project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true (false for subprojects)
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseBranches?: { [name: string]: BranchOptions }

                                                                                                                                                                                                                                                                                              Defines additional release branches. A workflow will be created for each +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              ReleasableCommits.everyCommit()
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              release?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Add release management to this project.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true (false for subprojects)
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseBranches?: { [name: string]: BranchOptions }
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • no additional branches are used for release. you can use addBranch() to add additional branches.
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              releaseEnvironment?: string

                                                                                                                                                                                                                                                                                              The GitHub Actions environment used for the release.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseEnvironment?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The GitHub Actions environment used for the release.

                                                                                                                                                                                                                                                                                              This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

                                                                                                                                                                                                                                                                                              When multiple artifacts are released, the environment can be overwritten on a per artifact basis.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no environment used, unless set at the artifact level
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseEveryCommit?: boolean

                                                                                                                                                                                                                                                                                              Automatically release new versions every commit to one of branches in releaseBranches.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Use releaseTrigger: ReleaseTrigger.continuous() instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              releaseFailureIssue?: boolean

                                                                                                                                                                                                                                                                                              Create a github issue on every failed publishing task.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseFailureIssueLabel?: string

                                                                                                                                                                                                                                                                                              The label to apply to issues indicating publish failures. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no environment used, unless set at the artifact level
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseEveryCommit?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically release new versions every commit to one of branches in releaseBranches.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use releaseTrigger: ReleaseTrigger.continuous() instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseFailureIssue?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Create a github issue on every failed publishing task.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseFailureIssueLabel?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The label to apply to issues indicating publish failures. Only applies if releaseFailureIssue is true.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "failed-release"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseSchedule?: string

                                                                                                                                                                                                                                                                                              CRON schedule to trigger new releases.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - no scheduled releases
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Use releaseTrigger: ReleaseTrigger.scheduled() instead

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              releaseTagPrefix?: string

                                                                                                                                                                                                                                                                                              Automatically add the given prefix to release tags. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "failed-release"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseSchedule?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              CRON schedule to trigger new releases.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - no scheduled releases
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use releaseTrigger: ReleaseTrigger.scheduled() instead

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseTagPrefix?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

                                                                                                                                                                                                                                                                                              Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "v"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseToNpm?: boolean

                                                                                                                                                                                                                                                                                              Automatically release to npm when new versions are introduced.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseTrigger?: ReleaseTrigger

                                                                                                                                                                                                                                                                                              The release trigger to use.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "v"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseToNpm?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically release to npm when new versions are introduced.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseTrigger?: ReleaseTrigger
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The release trigger to use.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • Continuous releases (ReleaseTrigger.continuous())
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              releaseWorkflow?: boolean

                                                                                                                                                                                                                                                                                              DEPRECATED: renamed to release.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - true if not a subproject
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              see release.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              releaseWorkflowEnv?: { [key: string]: string }

                                                                                                                                                                                                                                                                                              Build environment variables for release workflows.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              {}
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseWorkflowName?: string

                                                                                                                                                                                                                                                                                              The name of the default release workflow.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "release"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              releaseWorkflowSetupSteps?: JobStep[]

                                                                                                                                                                                                                                                                                              A set of workflow steps to execute in order to setup the workflow +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseWorkflow?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              DEPRECATED: renamed to release.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - true if not a subproject
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              see release.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseWorkflowEnv?: { [key: string]: string }
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Build environment variables for release workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              {}
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseWorkflowName?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The name of the default release workflow.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "release"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              releaseWorkflowSetupSteps?: JobStep[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              A set of workflow steps to execute in order to setup the workflow container.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              renovatebot?: boolean

                                                                                                                                                                                                                                                                                              Use renovatebot to handle dependency upgrades.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              renovatebotOptions?: RenovatebotOptions

                                                                                                                                                                                                                                                                                              Options for renovatebot.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              repository?: string

                                                                                                                                                                                                                                                                                              The repository is the location where the actual code for your package lives. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              renovatebot?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Use renovatebot to handle dependency upgrades.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              renovatebotOptions?: RenovatebotOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for renovatebot.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              repository?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              repositoryDirectory?: string

                                                                                                                                                                                                                                                                                              If the package.json for your package is not in the root directory (for example if it is part of a monorepo), +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              repositoryDirectory?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              requireApproval?: ApprovalLevel

                                                                                                                                                                                                                                                                                              To protect you against unintended changes that affect your security posture, +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              requireApproval?: ApprovalLevel
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              ApprovalLevel.BROADENING
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              sampleCode?: boolean

                                                                                                                                                                                                                                                                                              Generate one-time sample in src/ and test/ if there are no files there.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              scopedPackagesOptions?: ScopedPackagesOptions[]

                                                                                                                                                                                                                                                                                              Options for privately hosted scoped packages

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - fetch all scoped packages from the public npm registry
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              scripts?: { [name: string]: string }

                                                                                                                                                                                                                                                                                              npm scripts to include. If a script has the same name as a standard script, +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              ApprovalLevel.BROADENING
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              sampleCode?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Generate one-time sample in src/ and test/ if there are no files there.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              scopedPackagesOptions?: ScopedPackagesOptions[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for privately hosted scoped packages

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - fetch all scoped packages from the public npm registry
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              scripts?: { [name: string]: string }
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              {}
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              use project.addTask() or package.setScript()

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              singletonLambdaAutoDiscover?: boolean

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.SingletonFunction for each +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              {}
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              use project.addTask() or package.setScript()

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              singletonLambdaAutoDiscover?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Automatically adds an awscdk.SingletonFunction for each .singleton-lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              srcdir?: string

                                                                                                                                                                                                                                                                                              Typescript sources directory.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "src"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              stability?: string

                                                                                                                                                                                                                                                                                              Package's Stability

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              stale?: boolean

                                                                                                                                                                                                                                                                                              Auto-close of stale issues and pull request. See staleOptions for options.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              staleOptions?: StaleOptions

                                                                                                                                                                                                                                                                                              Auto-close stale issues and pull requests. To disable set stale to false.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              srcdir?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Typescript sources directory.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "src"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              stability?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Package's Stability

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              stale?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Auto-close of stale issues and pull request. See staleOptions for options.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              staleOptions?: StaleOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Auto-close stale issues and pull requests. To disable set stale to false.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • see defaults in StaleOptions
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              testdir?: string

                                                                                                                                                                                                                                                                                              Jest tests directory. Tests files should be named xxx.test.ts.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              testdir?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Jest tests directory. Tests files should be named xxx.test.ts.

                                                                                                                                                                                                                                                                                              If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "test"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              tsconfig?: TypescriptConfigOptions

                                                                                                                                                                                                                                                                                              Custom TSConfig

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              tsconfigDev?: TypescriptConfigOptions

                                                                                                                                                                                                                                                                                              Custom tsconfig options for the development tsconfig.json file (used for testing).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - use the production tsconfig options
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              tsconfigDevFile?: string

                                                                                                                                                                                                                                                                                              The name of the development tsconfig.json file.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "tsconfig.dev.json"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              tsJestOptions?: TsJestOptions

                                                                                                                                                                                                                                                                                              Options for ts-jest

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              typescriptVersion?: string

                                                                                                                                                                                                                                                                                              TypeScript version to use.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "test"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              tsconfig?: TypescriptConfigOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Custom TSConfig

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              tsconfigDev?: TypescriptConfigOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Custom tsconfig options for the development tsconfig.json file (used for testing).

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - use the production tsconfig options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              tsconfigDevFile?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The name of the development tsconfig.json file.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "tsconfig.dev.json"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              tsJestOptions?: TsJestOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for ts-jest

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              typescriptVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              TypeScript version to use.

                                                                                                                                                                                                                                                                                              NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "latest"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              versionrcOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                              Custom configuration used when creating changelog with commit-and-tag-version package. +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "latest"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              versionrcOptions?: Record<string, any>
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Custom configuration used when creating changelog with commit-and-tag-version package. Given values either append to default configuration or overwrite values in it.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - standard configuration applicable for GitHub repositories
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              vscode?: boolean

                                                                                                                                                                                                                                                                                              Enable VSCode integration.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - standard configuration applicable for GitHub repositories
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              vscode?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable VSCode integration.

                                                                                                                                                                                                                                                                                              Enabled by default for root projects. Disabled for non-root projects.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              true
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              watchExcludes?: string[]

                                                                                                                                                                                                                                                                                              Glob patterns to exclude from cdk watch.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              watchIncludes?: string[]

                                                                                                                                                                                                                                                                                              Glob patterns to include in cdk watch.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              []
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              workflowBootstrapSteps?: JobStep[]

                                                                                                                                                                                                                                                                                              Workflow steps to use in order to bootstrap this repo.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              "yarn install --frozen-lockfile && yarn projen"
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              workflowContainerImage?: string

                                                                                                                                                                                                                                                                                              Container image to use for GitHub workflows.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default image
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              workflowGitIdentity?: GitIdentity

                                                                                                                                                                                                                                                                                              The git identity to use in workflows.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - default GitHub Actions user
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              workflowNodeVersion?: string

                                                                                                                                                                                                                                                                                              The node version used in GitHub Actions workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              true
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              watchExcludes?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Glob patterns to exclude from cdk watch.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              watchIncludes?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Glob patterns to include in cdk watch.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              []
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowBootstrapSteps?: JobStep[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Workflow steps to use in order to bootstrap this repo.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              "yarn install --frozen-lockfile && yarn projen"
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowContainerImage?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Container image to use for GitHub workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default image
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowGitIdentity?: GitIdentity
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The git identity to use in workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - default GitHub Actions user
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowNodeVersion?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              The node version used in GitHub Actions workflows.

                                                                                                                                                                                                                                                                                              Always use this option if your GitHub Actions workflows require a specific to run.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              • minNodeVersion if set, otherwise lts/*.
                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              workflowPackageCache?: boolean

                                                                                                                                                                                                                                                                                              Enable Node.js package cache in GitHub workflows.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              false
-
                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                              workflowRunsOn?: string[]

                                                                                                                                                                                                                                                                                              Github Runner selection labels

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              ["ubuntu-latest"]
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Defines a target Runner by labels

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              if both runsOn and runsOnGroup are specified

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              workflowRunsOnGroup?: GroupRunnerOptions

                                                                                                                                                                                                                                                                                              Github Runner Group selection options

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Defines a target Runner Group by name and/or labels

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              if both runsOn and runsOnGroup are specified

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              yarnBerryOptions?: YarnBerryOptions

                                                                                                                                                                                                                                                                                              Options for Yarn Berry

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - Yarn Berry v4 with all default options
-
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              addPackageManagerToDevEnginesallowLibraryDependenciesappappEntrypointartifactsDirectoryauditDepsauditDepsOptionsauthorEmailauthorNameauthorOrganizationauthorUrlautoApproveOptionsautoApproveUpgradesautoDetectBinautoMergeautoMergeOptionsbinbiomebiomeOptionsbugsEmailbugsUrlbuildCommandbuildWorkflowbuildWorkflowOptionsbuildWorkflowTriggersbumpPackagebundledDepsbundlerOptionsbunVersioncdkAssertcdkAssertionscdkCliVersioncdkDependenciescdkDependenciesAsDepscdkoutcdkTestDependenciescdkVersioncdkVersionPinningcheckLicensesclobbercodeArtifactOptionscodeCovcodeCovTokenSecretcommitGeneratedconstructsVersioncontextcopyrightOwnercopyrightPerioddefaultReleaseBranchdeleteOrphanedLockFilesdependabotdependabotOptionsdepsdepsUpgradedepsUpgradeOptionsdescriptiondevContainerdevDepsdevEnginesdisableTsconfigdisableTsconfigDevdocgendocsDirectoryedgeLambdaAutoDiscoverentrypointentrypointTypeseslinteslintOptionsexperimentalIntegRunnerfeatureFlagsgithubgithubOptionsgitignoregitIgnoreOptionsgitOptionsgitpodhomepageintegrationTestAutoDiscoverjestjestOptionsjsiiReleaseVersionkeywordslambdaAutoDiscoverlambdaExtensionAutoDiscoverlambdaOptionslibdirlicenselicensedloggingmajorVersionmaxNodeVersionmergifymergifyOptionsminMajorVersionminNodeVersionmutableBuildnamenextVersionCommandnpmAccessnpmDistTagnpmignorenpmignoreEnablednpmIgnoreOptionsnpmProvenancenpmRegistrynpmRegistryUrlnpmTokenSecretnpmTrustedPublishingoutdirpackagepackageManagerpackageNameparentpeerDependencyOptionspeerDepspnpmVersionpostBuildStepsprereleaseprettierprettierOptionsprojectTreeprojectTypeprojenCommandprojenCredentialsprojenDevDependencyprojenrcJsprojenrcJsonprojenrcJsonOptionsprojenrcJsOptionsprojenrcTsprojenrcTsOptionsprojenTokenSecretprojenVersionpublishDryRunpublishTaskspullRequestTemplatepullRequestTemplateContentsreadmereleasableCommitsreleasereleaseBranchesreleaseEnvironmentreleaseEveryCommitreleaseFailureIssuereleaseFailureIssueLabelreleaseSchedulereleaseTagPrefixreleaseToNpmreleaseTriggerreleaseWorkflowreleaseWorkflowEnvreleaseWorkflowNamereleaseWorkflowSetupStepsrenovatebotrenovatebotOptionsrepositoryrepositoryDirectoryrequireApprovalsampleCodescopedPackagesOptionsscriptssingletonLambdaAutoDiscoversrcdirstabilitystalestaleOptionstestdirtsconfigtsconfigDevtsconfigDevFiletsJestOptionstypescriptVersionversionrcOptionsvscodewatchExcludeswatchIncludesworkflowBootstrapStepsworkflowContainerImageworkflowGitIdentityworkflowNodeVersionworkflowPackageCacheworkflowRunsOnworkflowRunsOnGroupyarnBerryOptions
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowPackageCache?: boolean
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Enable Node.js package cache in GitHub workflows.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              false
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowRunsOn?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Github Runner selection labels

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              ["ubuntu-latest"]
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Defines a target Runner by labels

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              if both runsOn and runsOnGroup are specified

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              workflowRunsOnGroup?: GroupRunnerOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Github Runner Group selection options

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Defines a target Runner Group by name and/or labels

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              if both runsOn and runsOnGroup are specified

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              yarnBerryOptions?: YarnBerryOptions
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Options for Yarn Berry

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              - Yarn Berry v4 with all default options
+
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Properties +
                                                                                                                                                                                                                                                                                              addPackageManagerToDevEnginesallowLibraryDependenciesappappEntrypointartifactsDirectoryauditDepsauditDepsOptionsauthorEmailauthorNameauthorOrganizationauthorUrlautoApproveOptionsautoApproveUpgradesautoDetectBinautoMergeautoMergeOptionsbinbiomebiomeOptionsbugsEmailbugsUrlbuildCommandbuildWorkflowbuildWorkflowOptionsbuildWorkflowTriggersbumpPackagebundledDepsbundlerOptionsbunVersioncdkAssertcdkAssertionscdkCliVersioncdkDependenciescdkDependenciesAsDepscdkoutcdkTestDependenciescdkVersioncdkVersionPinningcheckLicensesclobbercodeArtifactOptionscodeCovcodeCovTokenSecretcommitGeneratedconstructsVersioncontextcopyrightOwnercopyrightPerioddefaultReleaseBranchdeleteOrphanedLockFilesdependabotdependabotOptionsdepsdepsUpgradedepsUpgradeOptionsdescriptiondevContainerdevDepsdevEnginesdisableTsconfigdisableTsconfigDevdocgendocsDirectoryedgeLambdaAutoDiscoverentrypointentrypointTypeseslinteslintOptionsexperimentalIntegRunnerfeatureFlagsgithubgithubOptionsgitignoregitIgnoreOptionsgitOptionsgitpodhomepageintegrationTestAutoDiscoverjestjestOptionsjsiiReleaseVersionkeywordslambdaAutoDiscoverlambdaExtensionAutoDiscoverlambdaOptionslibdirlicenselicensedloggingmajorVersionmaxNodeVersionmergifymergifyOptionsminMajorVersionminNodeVersionmutableBuildnamenextVersionCommandnpmAccessnpmDistTagnpmignorenpmignoreEnablednpmIgnoreOptionsnpmProvenancenpmRegistrynpmRegistryUrlnpmTokenSecretnpmTrustedPublishingoutdirpackagepackageManagerpackageNameparentpeerDependencyOptionspeerDepspnpmVersionpostBuildStepsprereleaseprettierprettierOptionsprojectTreeprojectTypeprojenCommandprojenCredentialsprojenDevDependencyprojenrcJsprojenrcJsonprojenrcJsonOptionsprojenrcJsOptionsprojenrcTsprojenrcTsOptionsprojenTokenSecretprojenVersionpublishDryRunpublishTaskspullRequestTemplatepullRequestTemplateContentsreadmereleasableCommitsreleasereleaseBranchesreleaseEnvironmentreleaseEveryCommitreleaseFailureIssuereleaseFailureIssueLabelreleaseSchedulereleaseTagPrefixreleaseToNpmreleaseTriggerreleaseWorkflowreleaseWorkflowEnvreleaseWorkflowNamereleaseWorkflowSetupStepsrenovatebotrenovatebotOptionsrepositoryrepositoryDirectoryrequireApprovalsampleCodescopedPackagesOptionsscriptssingletonLambdaAutoDiscoversrcdirstabilitystalestaleOptionstestdirtsconfigtsconfigDevtsconfigDevFiletsJestOptionstypescriptVersionversionrcOptionsvscodewatchExcludeswatchIncludesworkflowBootstrapStepsworkflowContainerImageworkflowGitIdentityworkflowNodeVersionworkflowPackageCacheworkflowRunsOnworkflowRunsOnGroupyarnBerryOptions
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              diff --git a/docs/projen/interfaces/WorkflowOptions.html b/docs/projen/interfaces/WorkflowOptions.html index 5b33c53..11daffc 100644 --- a/docs/projen/interfaces/WorkflowOptions.html +++ b/docs/projen/interfaces/WorkflowOptions.html @@ -1,3 +1,55 @@ -WorkflowOptions | cdk-serverless
                                                                                                                                                                                                                                                                                              cdk-serverless
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface WorkflowOptions

                                                                                                                                                                                                                                                                                                interface WorkflowOptions {
                                                                                                                                                                                                                                                                                                    definitionFile: string;
                                                                                                                                                                                                                                                                                                    workflowName: string;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                definitionFile +WorkflowOptions | cdk-serverless
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                cdk-serverless + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  Interface WorkflowOptions

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  interface WorkflowOptions {
                                                                                                                                                                                                                                                                                                      definitionFile: string;
                                                                                                                                                                                                                                                                                                      workflowName: string;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  definitionFile workflowName -

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  definitionFile: string
                                                                                                                                                                                                                                                                                                  workflowName: string

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  definitionFile: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  workflowName: string
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Member Visibility +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                   +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Properties +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  diff --git a/docs/projen/modules.html b/docs/projen/modules.html index e75ce2b..f7e54b8 100644 --- a/docs/projen/modules.html +++ b/docs/projen/modules.html @@ -1 +1,44 @@ -cdk-serverless
                                                                                                                                                                                                                                                                                                  cdk-serverless
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                      cdk-serverless

                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                      Datastore
                                                                                                                                                                                                                                                                                                      GraphQlApi
                                                                                                                                                                                                                                                                                                      RestApi
                                                                                                                                                                                                                                                                                                      ServerlessProject
                                                                                                                                                                                                                                                                                                      Workflow

                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                      DatastoreOptions
                                                                                                                                                                                                                                                                                                      GraphQlApiOptions
                                                                                                                                                                                                                                                                                                      RestApiOptions
                                                                                                                                                                                                                                                                                                      ServerlessProjectOptions
                                                                                                                                                                                                                                                                                                      WorkflowOptions

                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                      PACKAGE_NAME

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                      Variables
                                                                                                                                                                                                                                                                                                      +cdk-serverless
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      cdk-serverless + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          cdk-serverless

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Datastore
                                                                                                                                                                                                                                                                                                          GraphQlApi
                                                                                                                                                                                                                                                                                                          RestApi
                                                                                                                                                                                                                                                                                                          ServerlessProject
                                                                                                                                                                                                                                                                                                          Workflow
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          DatastoreOptions
                                                                                                                                                                                                                                                                                                          GraphQlApiOptions
                                                                                                                                                                                                                                                                                                          RestApiOptions
                                                                                                                                                                                                                                                                                                          ServerlessProjectOptions
                                                                                                                                                                                                                                                                                                          WorkflowOptions
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          PACKAGE_NAME
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Member Visibility +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                           +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Classes +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Interfaces +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Variables +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          diff --git a/docs/projen/variables/PACKAGE_NAME.html b/docs/projen/variables/PACKAGE_NAME.html index 418c28a..ce95686 100644 --- a/docs/projen/variables/PACKAGE_NAME.html +++ b/docs/projen/variables/PACKAGE_NAME.html @@ -1 +1,31 @@ -PACKAGE_NAME | cdk-serverless
                                                                                                                                                                                                                                                                                                          cdk-serverless
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Variable PACKAGE_NAMEConst

                                                                                                                                                                                                                                                                                                            PACKAGE_NAME: "cdk-serverless" = 'cdk-serverless'

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                            +PACKAGE_NAME | cdk-serverless
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            cdk-serverless + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                              Variable PACKAGE_NAMEConst

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              PACKAGE_NAME: "cdk-serverless" = 'cdk-serverless'
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                               +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Member Visibility +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +