Question 1

How do I set up validation hooks for canary deployments with this plugin?

Accepted Answer

Define preTrafficHook and postTrafficHook functions in your serverless.yml, and ensure they use the CodeDeploy SDK to notify success or failure. The README provides an example with hooks.pre and hooks.post handlers, and links to AWS documentation for implementation details.

Question 2

What's the difference between using this plugin and configuring CodeDeploy manually for Lambda canary deployments?

Accepted Answer

This plugin automates CloudFormation template generation for CodeDeploy applications and deployment groups within the Serverless Framework, reducing manual configuration overhead. In contrast, manual setup requires more AWS resource management and is less integrated with Serverless workflows.

Question 3

Can I use this plugin with Lambda functions triggered by SQS?

Accepted Answer

Yes, the plugin supports SQS events as part of the stream-based triggers listed in the limitations section. You need to configure deploymentSettings for such functions in serverless.yml, similar to other event types.

Question 4

How does the automatic rollback work with CloudWatch alarms?

Accepted Answer

During deployment, if any CloudWatch alarm specified in the alarms list is triggered, AWS CodeDeploy automatically rolls back the traffic to the previous Lambda version. You must define these alarms in the deploymentSettings, either by Logical ID or name, as shown in the configuration.

Question 5

Is this plugin compatible with serverless-offline for local testing?

Accepted Answer

No, serverless-offline simulates AWS services locally but does not emulate CodeDeploy or Lambda traffic shifting features. Testing requires an actual AWS environment, which can slow down development cycles for teams relying on local simulations.

Question 6

What happens if the preTrafficHook fails during deployment?

Accepted Answer

If the preTrafficHook fails, CodeDeploy will halt the deployment and not proceed with traffic shifting, as per AWS's hook validation. The plugin relies on CodeDeploy's SDK integration, so you need to ensure your hook functions correctly report failure using the provided methods.

Canary deployments

What is Canary deployments?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions