From 984bbbaa0f359b408d08b8ece077bd93f668ee47 Mon Sep 17 00:00:00 2001 From: josefaidt Date: Mon, 24 Jun 2024 09:25:40 -0700 Subject: [PATCH] add warning callout to gen1 backend-config --- .../gen1/[platform]/tools/cli/reference/files/index.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx index 0cc65d302a8..e52427aa18a 100644 --- a/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx +++ b/src/pages/gen1/[platform]/tools/cli/reference/files/index.mdx @@ -82,7 +82,13 @@ These files work together to maintain the overall state of the Amplify project s > Add to version control: YES -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. +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. + + + +**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. + + ### amplify-meta.json