You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/views/docs/en/reference/cli/deploy.md
+28-22Lines changed: 28 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,34 +8,34 @@ sections:
8
8
- Flags
9
9
---
10
10
11
-
Deploy an Architect project to AWS by creating or updating a [CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) stack with resources declared in [the project manifest](../../get-started/project-manifest).
11
+
Deploy an Architect project to AWS by creating or updating a [CloudFormation][cfn] Stack with resources declared in [the project manifest][manifest].
12
12
13
-
CloudFormation stack names are created from the name specified in the `@app` pragma and are unique to an AWS region. Changing the project name or region will create a new CF stack.
13
+
[CloudFormation][cfn] Stack names are created from the name specified in [the `@app` pragma][app] and are unique to an AWS region. Changing the project name or region will create a new [CloudFormation][cfn] Stack.
-`[--direct path/to/function]` Overwrite staging Lambda with local source. A faster way to deploy and test small changes to individual functions without redeploying an entire stack.
25
-
-`[--dry-run]` Creates a CloudFormation template but does not deploy it. A dry-run allows you to check the CloudFormation and SAM output before deploying the actual stack.
26
-
-`[--fast, -f]` Deploy the stack, but do not hold the process open to determine whether the deployment succeeded or failed within AWS
27
-
-`[--name, -n]` Deploy a custom named staging stack.
28
-
-`[--no-hydrate]` Do not automatically run `npm`, `bundle`, or `pip`
29
-
-`[--production, -p]` Deploys a CloudFormation stack to a production stack.
30
-
-`[--prune]` Remove assets not present in the local static folder.
31
-
-`[--static, -s]` Deploys only the files in the static folder.
32
-
-`[--tags, -t]` Adds resource tags to the CloudFormation stack.
33
-
- The required tag format is `key=value`, e.g. `--tags key1=value1 key2=value2`
34
-
-`[--verbose, -v]` Displays verbose logging.
23
+
-`--direct path/to/function`: Directly deploy the specified Lambda. A faster way to deploy and test small changes to individual functions without redeploying an entire Stack.
24
+
-`--dry-run`: Generate a [CloudFormation][cfn] template but do not deploy it. A dry run allows you to check the [CloudFormation][cfn] and SAM output before deploying the actual stack.
25
+
-`--eject`: Generate a [CloudFormation][cfn] template but do not deploy it. Instead, print out the `aws cloudformation` CLI invocation to execute the deployment.
26
+
-`-f`, `--fast`: Deploy the stack, but do not block the process until deployment completed.
27
+
-`-n`, `--name`: Deploy a custom named staging Stack. E.g. `--name CI` will deploy a `AppnameStagingCI`[CloudFormation][cfn] Stack.
28
+
-`--no-hydrate`: Do not automatically [`hydrate`](hydrate) functions prior to deployment.
29
+
-`-p`, `--production`: Deploys a [CloudFormation][cfn] Stack to a production Stack. If not specified, will default to deploy to a staging Stack.
30
+
-`--prune`: Remove static assets deployed to S3 bucket not present in the local [`@static`][static] folder.
31
+
-`-s`, `--static`: Deploys only the files in the [`@static`][static] folder.
32
+
-`-t`, `--tags`: Adds resource tags to the CloudFormation stack. The required tag format is `key=value`, e.g. `--tags key1=value1 key2=value2`
When deploying, Architect can automatically scaffold resources (via [`arc init`](./init)) found in the [application's manifest](../../get-started/project-manifest) that do not yet exist. Options are set with [`@create` in local preferences](../configuration/local-preferences#%40create).
38
+
When deploying, Architect can automatically scaffold resources (via [`init`](init)) found in the [application's manifest][manifest] that do not yet exist. Options are set with [`@create` in local preferences](../configuration/local-preferences#%40create).
39
39
40
40
-`autocreate` - Set to `true` to enable automatic creation of boilerplate Lambda handlers and static assets if they do not exist.
41
41
-`templates` - Specify templates for automatic resource scaffolding.
@@ -52,42 +52,48 @@ templates
52
52
53
53
## Examples
54
54
55
-
### Deploy a staging stack
55
+
### Deploy a staging Stack
56
56
57
57
```bash
58
58
arc deploy
59
59
```
60
60
61
-
### Deploy a production stack
61
+
### Deploy a production Stack
62
62
63
63
```bash
64
64
arc deploy --production
65
65
```
66
66
67
-
### Deploy a named environment
67
+
### Deploy a named staging Stack
68
68
69
69
```bash
70
70
arc deploy --name my-stack
71
71
```
72
72
73
-
> 💁 Named stacks use `staging` environment variables [set with `arc env -e staging --add`](./env).
73
+
> 💁 Named stacks use `staging` environment variables [set with the `env` command](env).
74
74
75
75
### Deploy static assets to S3
76
76
77
77
```bash
78
78
arc deploy --static
79
79
```
80
80
81
-
### Deploy code directly to the staging Lambda
81
+
### Deploy the index route directly to staging
82
82
83
83
```bash
84
84
arc deploy --direct src/http/get-index
85
85
```
86
86
87
87
### Run deploy without deploying
88
88
89
-
This is useful for testing `@macros`; it will still generate `sam.json`.
89
+
This is useful for testing [`@plugins`][plugins]; it will still generate `sam.json`.
0 commit comments