| description |
|---|
This page describes naming conventions for SSM Parameters. |
The only requirements for SSM Parameter key names is that their path start with /unity/ followed by a service area name, where the service area name is one of those accepted by the AWS Resource Tagging Conventions. For example:
/unity/sps/...
/unity/cs/...
/unity/as/...
In many cases, these parameter names will become hard-coded across different repos. So, service areas should document the parameters they create and aim to make breaking changes to them as little as possible. The Name Form and Name Parts sections of this document cover suggestions for naming based on the way other projects have done it in the past.
However a service area chooses to name their parameters, it's important that the parameters provided are well documented and that changes to parameter names or value formats are communicated with the dependent teams.
See the Unity SSM Parameters page for a list of the actual parameters expected in the Unity system.
There is no hard-and-fast requirement for naming here, but in 99% of the cases, parameters should fall under the following two variants:
-
Things that are agnostic of a project/venue:
/unity/WHATEVER/...
Examples:-
/unity/account/network/vpc_id(VPC ID doesn’t change per project/venue)
-/unity/account/network/subnet_list(“)
-/unity/shared-services/aws/account(hopefully true that project/venues in an account use same SS account) -
Things that are tied to a project/venue:
/unity/${project}/${venue}/WHATEVER/...
Examples:
-/unity/sbg/dev/sps/${DEPLOYMENT_NAME}/${DEPLOYMENT_COUNTER}/processing/airflow/ui_url(sbg=project, and dev=venue, in this example)
-/unity/${PROJECT_NAME}/${VENUE_NAME}/deployment/status(status of a particular deployment)
The recommended form for the WHATEVER portion mentioned above is:
{service area}/{category}/{component}/{resource}
| Part | Description | Examples |
|---|---|---|
{service area} | The service area that creates and updates the SSM Parameter. | /unity/sps/.../unity/cs/.../unity/as/... |
{category} | The category of service provided by the service area that this SSM Parameter is related to. | /unity/sps/processing/.../unity/sps/scaling/.../unity/cs/routing/... |
{component} | The specific component of that the SSM Parameter is related to. | /unity/sps/processing/hysds/.../unity/sps/scaling/auto-scaling-group/.../unity/cs/routing/api-gateway/... |
{resource} | The descriptive name of what the SSM Parameter is providing a value for. | /unity/sps/processing/hysds/mozart_url/unity/sps/scaling/auto-scaling-group/arn/unity/cs/routing/api-gateway/rest-api-id |