This repository contains the full source code that is used in the blog post Deploying AWS Lambda layers automatically across multiple Regions.
- An AWS account
- An AWS CLI configured with an IAM role or short-lived AWS STS credentials. Do not use long-lived IAM access keys for this sample.
- Installed and setup AWS Cloud Development Kit (AWS CDK)
- Installed Node.js, TypeScript and git
git clone git@github.com:aws-samples/multi-region-lambda-layers.git
2. Open the repository in your preferred IDE and familiarize yourself with the structure of the project.
.
├── cdk CDK code that defines our environment
├── img Images used in this README
├── res Sample code used to initialize the repository
└── src
├── example Contains a sample package.json which can by used to create a new sample layer
└── lambda Handler code of the lambda function used to distribute the Lambda layer
Dependencies are declared in a package.json and pinned in a lock file. This project contains a package.json file in two different folders:
cdk: Dependencies required to deploy your stack with the CDKsrc: Dependencies required for the Lambda function, such as TypeScript types for the AWS SDK
Navigate to each of the folders and run npm ci.
Open cdk/bin/lambda-layer-blog.ts and adjust the regions to deploy the layer in as well as the principal with whom the layer is shared.
// List of regions to distribute the Lambda layer to
regionCodesToDistribute: ['eu-central-1', 'eu-west-1', 'us-west-1', 'us-east-1'],
// Grants layer usage permission to one AWS account (the default)
layerPrincipal: cdk.Aws.ACCOUNT_ID,
// To share with an organization, use layerPrincipal: '*' together with its organization ID.
organizationId: '',
The stack rejects duplicate or malformed region names. A wildcard layer principal is rejected unless an AWS Organizations ID is also supplied. Avoid public layer sharing unless it is explicitly required.
Navigate to the cdk folder and run the following commands
cdk synth
cdk bootstrap
cdk deploy
cdk synth will synthesize a CloudFormation template from your CDK code. If you haven't worked with CDK in your account before, you need to bootstrap the required resources for the CDK with cdk bootstrap, otherweise skip this step. You can then deploy the template with cdk deploy.
If you navigate to CodePipeline in the AWS console, you will now see the following pipeline:
The CodeCommit repository contains a sample package.json file that defines the AWS SDK for JavaScript v3 for demonstration purposes. The created layer doesn't add any value because the AWS SDK clients are already provided with the AWS Lambda runtime. To provide a more useful layer, update package.json in the repository with the file provided in src/example, for example. This will create a layer with the pinned ASK SDK dependencies.
When you are done, make sure to clean everything up.
Run the following command to shut down the resources created in this workshop.
cdk destroy
The S3 bucket created by CodePipeline will contain some files. Cloudformation does not delete non-empty buckets and thus cdk destroy will not delete those buckets.
If you no longer need these files, you can use the AWS CLI or console to empty the bucket and delete it.
Similarily, the AWS Lambda layers that were created by running the pipeline need to be manually removed if not needed anymore.
The pipeline uses a dedicated encrypted, versioned artifact bucket with public access blocked. The distributor role can read only that bucket, publish only the configured layer in the configured regions, and write only to its own log group. The build uses the committed lock file and disables package lifecycle scripts.
See CONTRIBUTING for more information.
This library is licensed under the MIT-0 License. See the LICENSE file.