Skip to content

[CLI] update Parameter Store reference for v11 #5174

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

Merged
merged 10 commits into from
Mar 17, 2023
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions src/pages/cli/reference/ssm-parameter-store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,31 @@ The `team-provider-info.json` file (from here on referred to as the TPI file) is
With this change the values historically stored in the TPI file are now being copied to Parameter Store. We are not removing the TPI file, Parameter Store is being used as a backup. If Amplify CLI needs a value that is not present in the TPI file, it will fetch the value from Parameter Store. The values in Parameter Store are updated after a successful Amplify deployment.

Developers can now seamlessly move between various environments like different developer machines and even to AWS Amplify Studio.

<Callout>Note: When an Amplify environment is deleted, all parameters under that environment name are deleted in Parameter Store. When an Amplify project is deleted, all parameters for that `appId` are deleted along with it.</Callout>

## Manually creating parameters

In some multi-environment scenarios, it is helpful to create parameters in Parameter Store manually. To do so, head to the AWS Console and search for SSM.

![AWS Console's search with "SSM"](/images/cli/parameter-store/select-ssm-console.png)

Once the SSM console has been opened, navigate to Parameter Store.

![AWS Systems Manager side navigation with "Parameter Store" highlighted](/images/cli/parameter-store/select-parameter-store.png)

With Parameter Store opened, select "Create Parameter".

![AWS SSM Parameter Store's landing page with a list of parameters](/images/cli/parameter-store/view-parameter-store.png)

Amplify parameter keys must follow a strict naming pattern:

```
/amplify/<appId>/<environment-name>/AMPLIFY_<category-name>_<resource-name>_<parameter-name>
```

Only Standard parameters with the default String type are supported.

![AWS SSM Parameter Store's "Create Parameter" form with Amplify's parameter naming pattern](/images/cli/parameter-store/create-parameter.png)

At the bottom of the page, select "Create parameter". That's it!