Skip to content

Commit 0cee76e

Browse files
authored
add warning callout to gen1 backend-config (#7773)
1 parent ddd3717 commit 0cee76e

File tree

1 file changed

+7
-1
lines changed
  • src/pages/gen1/[platform]/tools/cli/reference/files

1 file changed

+7
-1
lines changed

src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,13 @@ These files work together to maintain the overall state of the Amplify project s
8282
8383
> Add to version control: YES
8484
85-
The `backend-config.json` in the `backend` directory contains configuration about your project's backend, such as how connects to AWS resources (eg. Cognito for auth or AppSync for an API backend). Typically, this file is updated by the CLI commands like `amplify add auth` or `amplify add api`. It can also be [extended manually](/gen1/[platform]/tools/cli/custom/cloudformation/) to configure your backend beyond Amplify CLI's features. Both the `amplify/backend` and `amplify/#current-cloud-backend` directories contain a `backend-config.json` file.
85+
The `backend-config.json` in the `backend` directory contains configuration about your project's backend, such as how connects to AWS resources (e.g. Cognito for auth or AppSync for an API backend). Typically, this file is updated by the CLI commands like `amplify add auth` or `amplify add api`. It can also be [extended manually](/gen1/[platform]/tools/cli/custom/cloudformation/) to configure your backend beyond Amplify CLI's features. Both the `amplify/backend` and `amplify/#current-cloud-backend` directories contain a `backend-config.json` file.
86+
87+
<Callout warning>
88+
89+
**Warning:** this file contains the resource structure of your Amplify backend. Edits to this file can yield unexpected results and have a negative impact on the integrity of your backend.
90+
91+
</Callout>
8692

8793
### amplify-meta.json
8894

0 commit comments

Comments
 (0)