mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
80 lines
2.4 KiB
Markdown
80 lines
2.4 KiB
Markdown
<!--
|
|
title: Serverless Framework Commands - AWS Lambda - Deploy
|
|
menuText: Deploy
|
|
menuOrder: 3
|
|
description: Deploy your service to the specified provider
|
|
layout: Doc
|
|
-->
|
|
|
|
<!-- DOCS-SITE-LINK:START automatically generated -->
|
|
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy)
|
|
<!-- DOCS-SITE-LINK:END -->
|
|
|
|
# Deploy
|
|
|
|
The `sls deploy` command deploys your service or an individual function.
|
|
|
|
**Deploy entire service:**
|
|
|
|
```bash
|
|
serverless deploy
|
|
```
|
|
|
|
**Deploy a single function:**
|
|
|
|
```bash
|
|
serverless deploy function -f functionName
|
|
```
|
|
|
|
**Note:** `sls deploy function` is faster than a full service deploy and recommended for a faster development flow
|
|
|
|
## Options
|
|
- `--function` or `-f` The name of the function which should be deployed (**Note:** only available when running
|
|
`serverless deploy function`)
|
|
- `--stage` or `-s` The stage in your service that you want to deploy to.
|
|
- `--region` or `-r` The region in that stage that you want to deploy to.
|
|
- `--noDeploy` or `-n` Skips the deployment steps and leaves artifacts in the `.serverless` directory
|
|
- `--verbose` or `-v` Shows all stack events during deployment, and display any Stack Output.
|
|
|
|
## Artifacts
|
|
|
|
After the `serverless deploy` command runs all created deployment artifacts are placed in the `.serverless` folder of the service.
|
|
|
|
## Examples
|
|
|
|
### Deployment without stage and region options
|
|
|
|
```bash
|
|
serverless deploy
|
|
```
|
|
|
|
This is the simplest deployment usage possible. With this command Serverless will deploy your service to the defined
|
|
provider in the default stage (`dev`) to the default region (`us-east-1`).
|
|
|
|
### Deployment with stage and region options
|
|
|
|
```bash
|
|
serverless deploy --stage production --region eu-central-1
|
|
```
|
|
|
|
With this example we've defined that we want our service to be deployed to the `production` stage in the region
|
|
`eu-central-1`.
|
|
|
|
## List existing deploys
|
|
|
|
```bash
|
|
serverless deploy list
|
|
```
|
|
|
|
Running this command will list your recent deployments available in your S3 deployment bucket. It will use stage and region from the provider config and show the timestamp of each deployment so you can roll back if necessary.
|
|
|
|
## Provided lifecycle events
|
|
- `deploy:cleanup`
|
|
- `deploy:initialize`
|
|
- `deploy:setupProviderConfiguration`
|
|
- `deploy:createDeploymentArtifacts`
|
|
- `deploy:compileFunctions`
|
|
- `deploy:compileEvents`
|
|
- `deploy:deploy`
|
|
- `deploy:function:deploy`
|