Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update AWS service name #6650

Merged
merged 2 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export function getStaticProps(context) {
In Gen 2, Amplify offers centralized secret and environment variable management for all fullstack branches. Secrets allow you to securely configure environment-specific values like social sign-in keys, function environment variables, function secrets, and other sensitive data needed by your application across environments.

<Accordion title="How is this different from Gen 1?" eyebrow='FAQ'>
Gen 1 required defining environment variables and secrets using the CLI and stored keys in both AWS Parameter Store and a local `team-provider.json` file. We have streamlined this workflow in Gen 2 by centralizing the management of secrets and environment variables in the Amplify console.
Gen 1 required defining environment variables and secrets using the CLI and stored keys in both AWS Systems Manager (SSM) Parameter Store and a local `team-provider.json` file. We have streamlined this workflow in Gen 2 by centralizing the management of secrets and environment variables in the Amplify console.
</Accordion>

## Set secrets
Expand All @@ -30,7 +30,7 @@ Secrets for branch deployments can be added in the Amplify console. From the App
<source src="/images/gen2/secrets-and-vars/secrets.mp4" />
</video>

Secrets are stored in AWS Parameter Store under the following naming conventions:
Secrets are stored in AWS Systems Manager (SSM) Parameter Store under the following naming conventions:

- Secrets that apply to all branches: `/amplify/shared/<app-id>/<secret-key>`
- Secrets that apply to a specific branch: `/amplify/<app-id>/<branchname>/<secret-key>`
Expand All @@ -40,7 +40,7 @@ Secrets are stored in AWS Parameter Store under the following naming conventions
[comment]: <> (When editing this section, also update /gen2/deploy-and-host/sandbox-environments/features/index.md -)

<Callout info>
Secrets set in a sandbox do not show up in the Amplify Console. You can view them in the AWS Parameter Store console.
Secrets set in a sandbox do not show up in the Amplify Console. You can view them in the Parameter Store console.
Jay2113 marked this conversation as resolved.
Show resolved Hide resolved
</Callout>

When testing features locally, you might want to test with real secrets. You can add secrets while running the cloud sandbox with the following command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Sandbox environments include additional features for managing secrets, deploying
## Secure secrets in your sandbox

<Callout info>
Secrets set in a sandbox do not show up in the Amplify Console. You can view them in the AWS Parameter Store console.
Secrets set in a sandbox do not show up in the Amplify Console. You can view them in the AWS Systems Manager (SSM) Parameter Store console.
</Callout>

Gen 2 offers secure secret storage to manage sensitive data like API keys and database credentials. Secrets are similar to environment variables, but they are encrypted AWS Systems Manager (SSM) Parameter Store key value pairs. Secrets are stored in AWS Parameter Store with the following naming convention: `/amplify/<package.json#name>/<sandbox-name>/<key-name>`.
Gen 2 offers secure secret storage to manage sensitive data like API keys and database credentials. Secrets are similar to environment variables, but they are encrypted Parameter Store key value pairs. Secrets are stored in Parameter Store with the following naming convention: `/amplify/<package.json#name>/<sandbox-name>/<key-name>`.
Jay2113 marked this conversation as resolved.
Show resolved Hide resolved

### Set secrets

Expand Down
Loading