serverless.yml

serverless.yml sits at the heart of serverless framework in AWS Lambda. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

serverless.yml Overview

serverless.yml lets you structure AWS Lambda work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep serverless.yml focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

service: orders-api

provider:
  name: aws
  runtime: nodejs20.x
  environment:
    TABLE_NAME: Orders

functions:
  getOrder:
    handler: src/handler.getOrder
    events:
      - httpApi:
          path: /orders/{id}
          method: get

The Serverless Framework describes functions and their event triggers in a single serverless.yml file.

serverless.yml Example

// handler.mjs
export const handler = async (event, context) => {
  // 1. read input from the event
  // 2. do the work
  // 3. return a response (or throw on error)
};

Start from a minimal serverless.yml example and grow it only as needed.
Keep configuration explicit so serverless.yml behaves the same in every environment.
Name things clearly so teammates understand your serverless.yml at a glance.
Add tests around serverless.yml early to lock in expected behaviour.

AWS Lambda Cheatsheet

Handy reference for working with serverless.yml in AWS Lambda and Node.js.

Task	Example	Purpose
Define handler	`export const handler = async (event) => {}`	Entry point AWS invokes
Read input	`event.body`, `event.Records`	Access request or trigger data
Return response	`{ statusCode, body }`	Reply through API Gateway
Reuse SDK client	`const c = new S3Client({})` (module scope)	Faster warm invocations
Env config	`process.env.TABLE_NAME`	Externalise settings
Log	`console.log(JSON.stringify(obj))`	Structured CloudWatch logs
Deploy	`sam deploy` / `serverless deploy`	Ship the function

How serverless.yml Works in AWS Lambda

serverless.yml runs inside the managed Lambda execution environment. AWS provisions a micro-VM, loads your Node.js code, runs any module-scope initialisation once, and then invokes your handler for each event.

The Serverless Framework describes functions and their event triggers in a single serverless.yml file.

Handlers should be small and do one job well.
Initialise SDK clients and config outside the handler to reuse them on warm starts.
Return quickly and let event sources handle retries where possible.
Emit structured logs so CloudWatch and X-Ray can correlate activity.

Practical Guidance for serverless.yml

On real projects, serverless.yml works best when it is observable, secure, and cheap to run. Grant least-privilege IAM, validate every input, and keep the deployment package small.

Concern	Recommendation
Security	Least-privilege IAM role, validate all input
Performance	Reuse clients, right-size memory, avoid heavy cold starts
Reliability	Idempotent handlers, dead-letter queues for failures
Observability	Structured logs, metrics, and X-Ray tracing

Common Mistakes

Skipping error handling and edge cases when wiring up serverless.yml.
Leaving serverless.yml untested, so regressions slip into production.
Over-engineering serverless.yml before you actually need the extra flexibility.
Ignoring documentation, which makes serverless.yml hard for the next developer to change.

Key Takeaways

serverless.yml is a core part of working effectively with AWS Lambda.
Start small and keep serverless.yml focused on a single responsibility.
Apply consistent patterns so serverless.yml scales across your project.
Test and document serverless.yml to keep it maintainable over time.

Pro Tip

When you get stuck on serverless.yml, reduce it to the smallest reproducible example first — most AWS Lambda issues become obvious once the noise is gone.