Lifecycle hook for adding custom resources?

ryan · May 20, 2018, 7:55pm

Which is the proper lifecycle hook for adding custom resources to a service? I’ve noticed many plugins do this in the deploy:deploy hook, this seems to me to be much too late. Doesn’t packaging happen before deploy?

bwinant · May 21, 2018, 12:58am

If you are talking about adding custom CloudFormation resources, before:package:finalize is a good spot.

If you are talking about adding files/assets/etc to the serverless zip file, then after:package:initialize or maybe before:package:setupProviderConfiguration

bwinant · May 21, 2018, 1:12am

I too was confused in the beginning about where to hook plugins into the serverless lifecycle. So I made a simple plugin that bound to every event and printed out where it was.

Code and log is here:

gist.github.com

https://gist.github.com/bwinant/406b7cf1677ba63896f5253d07d01f37

lifecycle-plugin.js

'use strict';

// This plugin will bind to all available lifecycle events and print them out as they are invoked
class LifecyclePrinter {
    constructor(serverless, options) {
        this.serverless = serverless;
        this.options = options;

        this.provider = this.serverless.getProvider('aws');

This file has been truncated. show original

sls-plugin-aws-lifecycle-events.log

~/sandbox> sls deploy
 IN: before:package:cleanup
 IN: before:aws:common:validate:validate
 IN: after:aws:common:validate:validate
 IN: before:aws:common:cleanupTempDir:cleanup
 IN: after:aws:common:cleanupTempDir:cleanup
 IN: after:package:cleanup
 IN: before:package:initialize
 IN: after:package:initialize
 IN: before:package:setupProviderConfiguration

This file has been truncated. show original

ryan · May 21, 2018, 1:14am

This is really great, thanks for sharing. I guess it’s not completely obvious what is happening at each of these hooks, but it sure does help.

Topic		Replies	Views
Is it possible to modify Resources in before:deploy from a plugin? Serverless Framework	0	363	June 21, 2020
Add a custom AWS resource (not normally supported by CF) during deploy? Serverless Framework	6	2570	March 7, 2018
Update a field in custom field before everything else is run Serverless Framework aws , lambda , variables	0	865	October 19, 2018
Just deploy cloudformation changes for AWS Serverless Framework aws	1	517	October 3, 2019
S3 Bucket event and lifecycle Serverless Framework aws	2	6960	January 10, 2018

Lifecycle hook for adding custom resources?

Related topics