CheatServerless Framework Deploy Lambda from YAML
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
serverless login
Sign in to the Framework
serverless deploy
Deploy the whole service
serverless deploy function -f <fn>
Fast single-function deploy
serverless invoke local -f <fn>
Run a function locally
serverless invoke -f <fn> --log
Call the deployed function
serverless logs -f <fn> -t
Tail CloudWatch logs
serverless infoShow stage, endpoints, functions
serverless remove
Delete the stack
Concepts
- serverless.yml functions + events
- .serverless/ zips + CloudFormation
- CloudFormation stack Lambda, API, IAM
- Running service per stage and region
Account
serverless login
Sign in and pick the default org
serverless login --org <name>
Switch the default org
serverless <command> --help
Show help for one command
Works without signing in
Deploy
serverless deploy
Deploy the whole service
serverless deploy --stage <stage> --region
<region>
Deploy to another stage or region
serverless deploy --verbose
Show stack events and outputs
serverless deploy --force
Force a deployment
serverless deploy --aws-profile <name>
Deploy with a named AWS profile
serverless deploy --package <dir>
Deploy a pre-built package
serverless deploy --conceal
Hide secrets in the output
serverless deploy function -f <fn>
Upload one function's code only
Skips CloudFormation, so it is fast; not for event or IAM
changes
serverless deploy function -f <fn>
--update-config
Push only Lambda config changes
serverless deploy list
List stored deployments
serverless deploy list functions
List deployed function versions
Package
serverless package
Build artifacts without deploying
serverless package --package <dir>
Write the package to a folder
serverless package --stage <stage>
Package for a given stage
Invoke
serverless invoke -f <fn>
Call the deployed function
serverless invoke -f <fn> --log
Also print the invocation log
serverless invoke -f <fn> -d
'<json>'
Pass an inline event
serverless invoke -f <fn> -p <file>
Pass an event from a JSON file
serverless invoke -f <fn> -t Event
Fire asynchronously
Types: RequestResponse (default), Event, DryRun
serverless invoke -f <fn> -q <alias>
Call a version or alias
serverless invoke -f <fn> --raw -d <text>
Send data as a plain string
serverless invoke -f <fn> --context
'<json>'
Pass a custom context
Local
serverless invoke local -f <fn>
Run a function on your machine
serverless invoke local -f <fn> -p <file>
Use an event file
serverless invoke local -f <fn> -d
'<json>'
Use an inline event
serverless invoke local -f <fn> -e
<NAME>=<value>
Set an environment variable
serverless invoke local -f <fn> --docker
Run in the declared runtime
Without it, Node.js and Python use your local interpreter
serverless invoke local -f <fn> -x <file>
Use a context file
serverless devRun deployed functions on local code
Attaches Node.js/Python functions of a deployed stage; refuses
prod
serverless dev --stage <stage> -f <fn>
Attach only chosen functions
serverless dev --dry-run
Preview what dev would change
serverless dev restore
Remove leftover dev attachments
Logs
serverless logs -f <fn>
Show the last 10 minutes of logs
serverless logs -f <fn> -t
Tail logs live
serverless logs -f <fn> --startTime
<time>
Logs since 30m, 2h, 3d or a date
serverless logs -f <fn> --filter <text>
Only lines containing a pattern
serverless logs -f <fn> -t -i <ms>
Change the polling interval
serverless metrics
Service-wide metrics, last 24 hours
serverless metrics -f <fn> --startTime
<t>
Metrics for one function
Inspect
serverless infoShow endpoints and functions
serverless info --verbose
Include all stack outputs
serverless info --json
Machine-readable output
serverless print
Show config with variables resolved
serverless print --path <a.b>
Print one sub-value
serverless print --format json
Output as yaml, json or text
serverless print --path functions --transform keys --format
text
List function names
Rollback and remove
serverless rollback
List deployments to roll back to
serverless rollback -t <timestamp>
Return to a past deployment
Timestamps come from serverless deploy list
serverless remove
Delete the service from AWS
serverless remove --stage <stage> --region
<region>
Delete one stage
serverless remove --verbose
Show stack events while removing
Config
service: my-apiprovider: name: aws runtime: nodejs20.x region: eu-central-1functions: hello: handler: handler.hello events: - httpApi: GET /helloRecipes
# edit handler.js, thenserverless deploy function -f helloserverless invoke -f hello --logserverless logs -f hello -techo '{"name":"Ada"}' > event.jsonserverless invoke local -f hello -p event.jsonserverless deploy --stage $USERserverless info --stage $USERserverless remove --stage $USERserverless deploy listserverless rollback -t <timestamp>serverless logs -f hello --startTime 10m
