Lambda-layer-version-cleaner NPM

lambda-layer-version-cleaner

lambda-layer-version-cleaner is a CDK Construct that helps you manage and automatically clean up old versions of AWS Lambda Layers. It works with both JavaScript / TypeScript and Python CDK apps. Please note that this cleaner will only clean up versions of Lambda Layers in the region where it's deployed.

Installation

For JavaScript / TypeScript projects:

npm install lambda-layer-version-cleaner

For Python projects:

pip install lambda-layer-version-cleaner

Usage

To use the LambdaLayerVersionCleaner in your CDK project, simply import it and add it to your stack. Note that the cleaner will delete old versions of Lambda Layers even if they are associated with Lambda functions. Please ensure that you are aware of this behavior before using the cleaner in your project.

JavaScript / TypeScript

import * as cdk from 'aws-cdk-lib';
import * as events from 'aws-cdk-lib/aws-events';
import { LambdaLayerVersionCleaner } from 'lambda-layer-version-cleaner';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'ExampleStack');

new LambdaLayerVersionCleaner(stack, 'LambdaLayerVersionCleaner', {
  retainVersions: 10,
  layerCleanerSchedule: events.Schedule.rate(cdk.Duration.days(7)),
});

Python

from aws_cdk import core as cdk
from aws_cdk.aws_events import Schedule
from aws_cdk.core import Duration
from lambda_layer_version_cleaner import LambdaLayerVersionCleaner

app = cdk.App()
stack = cdk.Stack(app, "ExampleStack")

LambdaLayerVersionCleaner(stack, "LambdaLayerVersionCleaner",
    retain_versions=10,
    layer_cleaner_schedule=Schedule.rate(Duration.days(7))
)

app.synth()

Configuration

The LambdaLayerVersionCleaner construct takes two required parameters and two optional parameters:

retainVersions: The number of layer versions to retain, specified as a positive integer. The cleaner will delete older versions beyond this count. Note that if a Layer has only one version, it won't be deleted.
layerCleanerSchedule: The schedule for running the cleanup process.

The optional parameters are:

handlerTimeout (default: cdk.Duration.minutes(15)): Maximum allowed runtime for the Lambda function.
handlerMemorySize (default: 256): Amount of memory allocated to the Lambda function.