cdk-aws-lambda-powertools-blueprint 0.1.1 → 1.0.0

package/.jsii

@@ -8508,7 +8508,7 @@
   },
   "description": "AWS CDK Blueprint to add AWS Lambda Powertools configuration to Lambda Functions.",
   "docs": {
-    "stability": "experimental"
+    "stability": "stable"
   },
   "homepage": "git+https://github.com/Tohaker/cdk-aws-lambda-powertools-blueprint.git",
   "jsiiVersion": "5.9.29",
@@ -8529,7 +8529,7 @@
   },
   "name": "cdk-aws-lambda-powertools-blueprint",
   "readme": {
-    "markdown": "# CDK AWS Lambda Powertools Blueprint\n\nThis [Blueprint](https://docs.aws.amazon.com/cdk/v2/guide/blueprints.html) enables Function constructs defined in your Stack to have all the necessary properties configured to take advantage of [Powertools for AWS Lambda](https://docs.aws.amazon.com/powertools/).\n\n## Benefits\n\nIncluding the `PowertoolsFunctionDefaults` in your property injectors will apply the following defaults to all Functions in your Stacks.\n\n- The official [Powertools Lambda Layer](https://docs.aws.amazon.com/powertools/typescript/latest/getting-started/lambda-layers/) (only on NodeJS and Python runtimes).\n- The POWERTOOLS_SERVICE_NAME environment variable automatically set to the provided `functionName`.\n\n## Usage\n\nDifferent Lambda Function runtimes will take advantage of different behaviour, demonstrated in each section.\n\n### NodeJS Functions\n\nBoth `Function` and `NodejsFunction` constructs are supported with the `NODEJS` Runtime Family. If you opt to use the latter, you will also benefit from the `bundling` props being updated to exclude the `@aws-lambda-powertools/*` modules from the final bundle. This will have the benefit of reducing the final bundle size, which can lead to performance improvements.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Runtime } from \"aws-cdk-lib/aws-lambda\";\nimport { NodejsFunction } from \"aws-cdk-lib/aws-lambda-nodejs\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new NodejsFunction(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.NODEJS_22_X,\n});\n```\n\nYou can also select a specific Powertools version if you don't want to use the `latest` version of the Lambda Layer. For example;\n\n```ts\nimport { App } from \"aws-cdk-lib\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [\n    new PowertoolsFunctionDefaults({\n      powertoolsVersion: \"2.30.0\",\n    }),\n  ],\n});\n```\n\n### Python Functions\n\nAll `Function` constructs with the `PYTHON` Runtime Family will have the latest [Lambda Layer](https://docs.aws.amazon.com/powertools/python/latest/getting-started/install/#lambda-layer) appropriate to the configured architecture applied. If no `architecture` is applied, the function will fall back to `x86_64` architecture and a warning will be added to your stack annotations.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Function, Runtime } from \"aws-cdk-lib/aws-lambda\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new Function(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.PYTHON_3_13,\n});\n```\n\n### All other runtimes\n\nEvery Function runtime is supported, but at the time of writing no others have a Lambda Layer to apply to the function. As a result, only the POWERTOOLS_SERVICE_NAME environment variable will be added to any function that is configured with a different runtime than NodeJS or Python.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Function, Runtime } from \"aws-cdk-lib/aws-lambda\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new Function(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.JAVA_21,\n});\n```\n\n## Development\n\nIf you wish to contribute to this project, please follow the [Contribution guidelines](./CONTRIBUTING.md).\n\nInstall dependencies\n\n```sh\nnpm install\n```\n\nBuild the package\n\n```sh\nnpm run build\n```\n\nRun unit tests\n\n```sh\nnpm run test\n```\n\nRun linting checks and fix linting issues\n\n```sh\nnpm run lint\nnpm run lint:fix\n```\n"
+    "markdown": "# CDK AWS Lambda Powertools Blueprint\n\nThis [Blueprint](https://docs.aws.amazon.com/cdk/v2/guide/blueprints.html) enables Function constructs defined in your Stack to have all the necessary properties configured to take advantage of [Powertools for AWS Lambda](https://docs.aws.amazon.com/powertools/).\n\n## Benefits\n\nIncluding the `PowertoolsFunctionDefaults` in your property injectors will apply the following defaults to all Functions in your Stacks.\n\n- The official [Powertools Lambda Layer](https://docs.aws.amazon.com/powertools/typescript/latest/getting-started/lambda-layers/) (only on NodeJS and Python runtimes).\n- The POWERTOOLS_SERVICE_NAME environment variable automatically set to the provided `functionName`.\n\n## Usage\n\nDifferent Lambda Function runtimes will take advantage of different behaviour, demonstrated in each section.\n\nIn general, you will just need to add `PowertoolsFunctionDefaults` to your `propertyInjectors`.\nYou can add it to the `App` instance to cover all your stacks;\n\n```ts\nimport { App } from \"aws-cdk-lib\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n```\n\nOr you can add it to individual `Stack` instances for more granular control;\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { MyStack } from \"../lib/myStack.ts\";\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App();\n\nconst stack = new MyStack(app, \"MyStack\", {\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n```\n\n### NodeJS Functions\n\nBoth `Function` and `NodejsFunction` constructs are supported with the `NODEJS` Runtime Family. If you opt to use the latter, you will also benefit from the `bundling` props being updated to exclude the `@aws-lambda-powertools/*` modules from the final bundle. This will have the benefit of reducing the final bundle size, which can lead to performance improvements.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Runtime } from \"aws-cdk-lib/aws-lambda\";\nimport { NodejsFunction } from \"aws-cdk-lib/aws-lambda-nodejs\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new NodejsFunction(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.NODEJS_22_X,\n});\n```\n\nYou can also select a specific Powertools version if you don't want to use the `latest` version of the Lambda Layer. For example;\n\n```ts\nimport { App } from \"aws-cdk-lib\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [\n    new PowertoolsFunctionDefaults({\n      powertoolsVersion: \"2.30.0\",\n    }),\n  ],\n});\n```\n\n### Python Functions\n\nAll `Function` constructs with the `PYTHON` Runtime Family will have the latest [Lambda Layer](https://docs.aws.amazon.com/powertools/python/latest/getting-started/install/#lambda-layer) appropriate to the configured architecture applied. If no `architecture` is applied, the function will fall back to `x86_64` architecture and a warning will be added to your stack annotations.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Function, Runtime } from \"aws-cdk-lib/aws-lambda\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new Function(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.PYTHON_3_13,\n});\n```\n\n### All other runtimes\n\nEvery Function runtime is supported, but at the time of writing no others have a Lambda Layer to apply to the function. As a result, only the POWERTOOLS_SERVICE_NAME environment variable will be added to any function that is configured with a different runtime than NodeJS or Python.\n\n```ts\nimport { App } from \"aws-cdk-lib\";\nimport { Function, Runtime } from \"aws-cdk-lib/aws-lambda\";\n\nimport { PowertoolsFunctionDefaults } from \"cdk-aws-lambda-powertools-blueprint\";\n\nconst app = new App({\n  propertyInjectors: [new PowertoolsFunctionDefaults()],\n});\n\nconst stack = new Stack(app, \"MyStack\");\n\nconst fn = new Function(stack, \"MyFunction\", {\n  functionName: \"service-my-function\",\n  runtime: Runtime.JAVA_21,\n});\n```\n\n## Development\n\nIf you wish to contribute to this project, please follow the [Contribution guidelines](./CONTRIBUTING.md).\n\nInstall dependencies\n\n```sh\nnpm install\n```\n\nBuild the package\n\n```sh\nnpm run build\n```\n\nRun unit tests\n\n```sh\nnpm run test\n```\n\nRun linting checks and fix linting issues\n\n```sh\nnpm run lint\nnpm run lint:fix\n```\n"
   },
   "repository": {
     "type": "git",
@@ -8547,13 +8547,13 @@
       "docs": {
         "remarks": "- If not provided, the POWERTOOLS_SERVICE_NAME environment variable is\n  set to the `functionName` provided to the function props. If no\n  `functionName` is set, `service_undefined` is set instead (as per the [Powertools defaults](https://docs.aws.amazon.com/powertools/typescript/latest/features/logger/#utility-settings))\n\nFor NodeJS and Python Functions, also applies the official Lambda Layer\nfor the appropriate runtime and architecture.\n\nNodeJS Functions will also have the '@aws-lambda-powertools/*' modules\nexcluded from being bundled to minimise the bundle size.",
         "see": "https://docs.aws.amazon.com/powertools/",
-        "stability": "experimental",
+        "stability": "stable",
         "summary": "Applies Powertools-specific defaults to Functions in your Stack."
       },
       "fqn": "cdk-aws-lambda-powertools-blueprint.PowertoolsFunctionDefaults",
       "initializer": {
         "docs": {
-          "stability": "experimental"
+          "stability": "stable"
         },
         "locationInModule": {
           "filename": "lib/index.ts",
@@ -8580,7 +8580,7 @@
       "methods": [
         {
           "docs": {
-            "stability": "experimental",
+            "stability": "stable",
             "summary": "The injector to be applied to the constructor properties of the Construct."
           },
           "locationInModule": {
@@ -8614,7 +8614,7 @@
       "properties": [
         {
           "docs": {
-            "stability": "experimental",
+            "stability": "stable",
             "summary": "The unique Id of the Construct class."
           },
           "immutable": true,
@@ -8635,7 +8635,7 @@
       "assembly": "cdk-aws-lambda-powertools-blueprint",
       "datatype": true,
       "docs": {
-        "stability": "experimental"
+        "stability": "stable"
       },
       "fqn": "cdk-aws-lambda-powertools-blueprint.PowertoolsFunctionDefaultsProps",
       "kind": "interface",
@@ -8650,7 +8650,7 @@
           "docs": {
             "default": "\"latest\"",
             "remarks": "Setting this field will only have an effect on NodeJS Functions.",
-            "stability": "experimental",
+            "stability": "stable",
             "summary": "The Powertools package version to load into the Lambda. Only provide this value if you don't want the latest version."
           },
           "immutable": true,
@@ -8668,6 +8668,6 @@
       "symbolId": "lib/index:PowertoolsFunctionDefaultsProps"
     }
   },
-  "version": "0.1.1",
-  "fingerprint": "624anGJDYbzMWDIevAk6OnA4ieXsNF4je91klFewGgI="
+  "version": "1.0.0",
+  "fingerprint": "0+Yb7BVqFq0PvQQA5RwzrPsECHs9yT05vRCsCD36nq4="
 }

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # cdk-aws-lambda-powertools-blueprint
 
+## 1.0.0
+
+### Major Changes
+
+- 6d47fd6: Adding documentation for first major release
+
 ## 0.1.1
 
 ### Patch Changes

package/CONTRIBUTING.md

@@ -68,6 +68,7 @@ Install dependencies
    - `npm run build`
 5. Update relevant documentation
 6. Create the commit with relevant files
+7. Create a changeset with `npm run changeset` and commit the generated file
 
 ### Step 5: Make the pull request
 

package/README.md

@@ -13,6 +13,33 @@ Including the `PowertoolsFunctionDefaults` in your property injectors will apply
 
 Different Lambda Function runtimes will take advantage of different behaviour, demonstrated in each section.
 
+In general, you will just need to add `PowertoolsFunctionDefaults` to your `propertyInjectors`.
+You can add it to the `App` instance to cover all your stacks;
+
+```ts
+import { App } from "aws-cdk-lib";
+
+import { PowertoolsFunctionDefaults } from "cdk-aws-lambda-powertools-blueprint";
+
+const app = new App({
+  propertyInjectors: [new PowertoolsFunctionDefaults()],
+});
+```
+
+Or you can add it to individual `Stack` instances for more granular control;
+
+```ts
+import { App } from "aws-cdk-lib";
+import { MyStack } from "../lib/myStack.ts";
+import { PowertoolsFunctionDefaults } from "cdk-aws-lambda-powertools-blueprint";
+
+const app = new App();
+
+const stack = new MyStack(app, "MyStack", {
+  propertyInjectors: [new PowertoolsFunctionDefaults()],
+});
+```
+
 ### NodeJS Functions
 
 Both `Function` and `NodejsFunction` constructs are supported with the `NODEJS` Runtime Family. If you opt to use the latter, you will also benefit from the `bundling` props being updated to exclude the `@aws-lambda-powertools/*` modules from the final bundle. This will have the benefit of reducing the final bundle size, which can lead to performance improvements.

package/dist/index.js

@@ -22,7 +22,7 @@ const aws_ssm_1 = require("aws-cdk-lib/aws-ssm");
  * @see https://docs.aws.amazon.com/powertools/
  */
 class PowertoolsFunctionDefaults {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "cdk-aws-lambda-powertools-blueprint.PowertoolsFunctionDefaults", version: "0.1.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "cdk-aws-lambda-powertools-blueprint.PowertoolsFunctionDefaults", version: "1.0.0" };
     constructUniqueId;
     powertoolsVersion;
     constructor(props) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "cdk-aws-lambda-powertools-blueprint",
 	"description": "AWS CDK Blueprint to add AWS Lambda Powertools configuration to Lambda Functions.",
-	"version": "0.1.1",
+	"version": "1.0.0",
 	"author": {
 		"name": "Miles Bardon",
 		"email": "milesbardon@gmail.com"
@@ -10,6 +10,9 @@
 		"url": "git+https://github.com/Tohaker/cdk-aws-lambda-powertools-blueprint.git",
 		"type": "git"
 	},
+	"bugs": {
+		"url": "https://github.com/Tohaker/cdk-aws-lambda-powertools-blueprint/issues"
+	},
 	"license": "MIT",
 	"keywords": [
 		"awscdk",
@@ -47,7 +50,7 @@
 		"aws-cdk-lib": "^2.196.0",
 		"constructs": "^10.0.0"
 	},
-	"stability": "experimental",
+	"stability": "stable",
 	"jsii": {
 		"targets": {},
 		"outdir": "./dist",