Skip to content

Commit b83c13d

Browse files
authored
Improve the documentation on deploying custom resources
1 parent 496ec52 commit b83c13d

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

Diff for: docs/guides/resources.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# AWS Infrastructure Resources
22

3-
If you are using AWS as a provider for your Service, all [_Resources_](./intro.md#resources) are other AWS infrastructure resources which the AWS Lambda functions in your [_Service_](./intro.md#services) depend on, like AWS DynamoDB or AWS S3.
4-
5-
Using the Serverless Framework, you can define the infrastructure resources you need in `serverless.yml`, and easily deploy them.
3+
Serverless Framework deploys using the AWS CloudFormation engine under the hood. If you want to deploy AWS resources that are not natively supported by `serverless.yml` (like AWS DynamoDB or AWS S3), you can deploy anything via the `resources` section.
64

75
## Configuration
86

9-
Every stage you deploy to with `serverless.yml` using the `aws` provider is a single AWS CloudFormation stack. This is where your AWS Lambda functions and their event configurations are defined and it's how they are deployed. When you add `resources` those resources are added into your CloudFormation stack upon `serverless deploy`.
7+
Every stage you deploy with `serverless.yml` is a single AWS CloudFormation stack. This is where your AWS Lambda functions and their event configurations are defined and it's how they are deployed. When you add `resources` to `serverless.yml`, those resources are added into your CloudFormation stack upon `serverless deploy`.
108

119
Define your AWS resources in a property titled `resources`. What goes in this property is raw CloudFormation template syntax, in YAML, like this:
1210

@@ -34,7 +32,7 @@ resources: # CloudFormation template syntax
3432
WriteCapacityUnits: 1
3533
```
3634
37-
You can attach any kind of resource to your CloudFormation stack. You can add `Resources`, `Outputs`. You can also use [Serverless Variables](./variables.md) for sensitive data or reusable configuration in your resources templates.
35+
You can attach any kind of resource to your CloudFormation stack. You can add `Resources`, `Outputs`. You can also use [variables](./variables.md) for sensitive data or reusable configuration in your resources templates.
3836

3937
Note: By supplying your resources at `resources.Resources` you may accidentally override resources as generated by the framework. To intentionally extend such resources, please use `resources.extensions`, see [Override AWS CloudFormation Resource](#override-aws-cloudformation-resource) section for more info.
4038

0 commit comments

Comments
 (0)