A lambda layer for AWS Powertools for python
Project description
Lambda powertools python layer
Why this project exists
This is a custom construct that will create AWS Lambda Layer with AWS Powertools for Python library. There are different
ways how to create a layer and when working with CDK you need to install the library, create a zip file and wire it
correctly. With this construct you don't have to care about packaging and dependency management, just create a construct
and add it to your function. The construct is an extension of the
existing LayerVersion
construct
from the CDK library, so you have access to all fields and methods.
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer';
const powertoolsLayer = new LambdaPowertoolsLayer(this, 'TestLayer');
Python
from cdk_lambda_powertools_python_layer import LambdaPowertoolsLayer
powertoolsLayer = LambdaPowertoolsLayer(self, 'PowertoolsLayer')
Install
TypeSript/JavaScript:
npm i cdk-lambda-powertools-python-layer
Python:
pip install cdk-lambda-powertools-python-layer
Usage
Python
A single line will create a layer with powertools for python:
from cdk_lambda_powertools_python_layer import LambdaPowertoolsLayer
powertoolsLayer = LambdaPowertoolsLayer(self, 'PowertoolsLayer')
You can then add the layer to your funciton:
aws_lambda.Function(self, 'LambdaFunction',
code=aws_lambda.Code.from_asset('function'),
handler='app.handler',
runtime=aws_lambda.Runtime.PYTHON_3_9,
layers=[powertoolsLayer])
You can specify the powertools version by passing the optional version
paramter, otherwise the construct will take the
latest version from pypi repository.
LambdaPowertoolsLayer(self, 'PowertoolsLayer', version='1.24.0')
Additionally, powertools have extras depenedncies such as Pydantic, documented here. This is not included by default, and you have to set this option in the construct definition if you need it:
LambdaPowertoolsLayer(self, 'PowertoolsLayer', include_extras=True)
Full example:
from aws_cdk import Stack, aws_lambda
from cdk_lambda_powertools_python_layer import LambdaPowertoolsLayer
from constructs import Construct
from typing_extensions import runtime
class LayerTestStack(Stack):
def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
super().__init__(scope, construct_id, **kwargs)
powertoolsLayer = LambdaPowertoolsLayer(
self, 'PowertoolsLayer', include_extras=True, version='1.24.0')
aws_lambda.Function(self, 'LambdaFunction',
code=aws_lambda.Code.from_asset('function'),
handler='app.handler',
runtime=aws_lambda.Runtime.PYTHON_3_9,
layers=[powertoolsLayer])
TypeScript
These examples are for TypeScript:
Build the layer:
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer';
const powertoolsLayer = new LambdaPowertoolsLayer(this, 'TestLayer', {
version: '1.22.0',
});
Add to your function:
new Function(this, 'LambdaFunction', {
code: Code.fromAsset(path.join('./function')),
handler: 'app.handler',
runtime: Runtime.PYTHON_3_9,
layers: [powertoolsLayer],
});
You can specify the powertools version:
new LambdaPowertoolsLayer(this, 'PowertoolsLayer', {
version: '1.21.0'
});
Decide if you want to incldue pydantic as extras dependencies:
new LambdaPowertoolsLayer(this, 'PowertoolsLayer', {
includeExtras: true
});
Full example:
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer';
import { Code, Function, Runtime } from 'aws-cdk-lib/aws-lambda';
import * as path from 'path';
export class CdkPowertoolsExampleStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const powertoolsLayer = new LambdaPowertoolsLayer(this, 'TestLayer', {
version: '1.22.0',
includeExtras: true
});
new Function(this, 'LambdaFunction', {
code: Code.fromAsset(path.join('./function')),
handler: 'app.handler',
runtime: Runtime.PYTHON_3_9,
layers: [powertoolsLayer],
});
}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk-lambda-powertools-python-layer-2.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b249516eab707d8a23faf8aeb8f4615fb3ea032a94ed54c59b2b01669f67b05a |
|
MD5 | 13bd2addf6b034f46c062073c4c868f6 |
|
BLAKE2b-256 | 5f9ac2369fd8b8c0ef078a6ffa67165641b9746a81dd06aaddcc65d906e7a486 |
Hashes for cdk_lambda_powertools_python_layer-2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be083a03ab6fc31792a1b8dc9663869251e11bb2c901ab6c77e8ecd4241ad2e5 |
|
MD5 | e4f789b5a74ce47373dab7abca1cb4cd |
|
BLAKE2b-256 | cf97cfcc185a9b64e610ad9eba0ae16162e250468dede318453bcf0923c57ae1 |