- Automatically attach layers for each lambda function
- Creates a new layer version when
package.jsonwas updated - If package.json was not changed, it does not publish a new layer
- Reduces drastically lambda size
- It reduces deployment time.
- Share same layers (libraries) with all lambda functions
- Serverless >= 1.34.0 (layers support)
- Node >= v6.10.3
- NPM >= 3.10.10
- AWS only (sorry)
- A valid package.json file
npm install -D serverless-layers
or
serverless plugin install --name serverless-layers
Add the plugin to your serverless.yml file:
provider:
...
deploymentBucket:
name: 'your_bucket'
plugins:
- serverless-layersExample:
custom:
serverless-layers:
packageManager: npm| Option | Type | Default | Description |
|---|---|---|---|
| packageManager | string |
npm | Possible values: npm, yarn |
| compileDir | string |
.serverless | Compilation directory |
| packagePath | string |
package.json | You can specify custom path for your package.json |
| compatibleRuntimes | array |
['nodejs'] |
Possible values: nodejs, nodejs8.10, nodejs10.x |
| layersDeploymentBucket | string |
You can specify a bucket to upload lambda layers. Required if deploymentBucket is not defined. |
|
| customInstallationCommand | string |
It specify a custom command to install deps ex. MY_ENV=1 npm --proxy http://myproxy.com i -P |
This plugin will setup follow options automatically if not specified at serverless.yml.
| Option | Type | Default |
|---|---|---|
| package.individually | bool |
false |
| package.exclude | array |
['node_modules/**'] |
| package.excludeDevDependencies | bool |
false |
serverless-layers-policy.json
{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Action":[
"s3:PutObject",
"s3:GetObject"
],
"Resource": "arn:aws:s3:::examplebucket"
},
{
"Effect":"Allow",
"Action":[
"cloudformation:DescribeStacks"
],
"Resource": "*"
},
{
"Effect":"Allow",
"Action":[
"lambda:PublishLayerVersion"
],
"Resource": "*"
}
]
}Yes, thank you! This plugin is community-driven, most of its features are from different authors. Please update the docs and tests and add your name to the package.json file. We try to follow Airbnb's JavaScript Style Guide.
MIT