|
| 1 | +# Prefix in Deployable Architecture |
| 2 | + |
| 3 | +The **`prefix`** input variable allows you to prepend a custom string to the names of all resources created by this automation. This is especially useful for: |
| 4 | + |
| 5 | +- **Avoiding naming collisions** when deploying the same solution multiple times within the same account. |
| 6 | +- **Creating identical infrastructure** across multiple regions or environments. |
| 7 | +- **Improving resource traceability** by embedding environment or region identifiers into resource names. |
| 8 | + |
| 9 | +If you do not wish to use a prefix, you may set the value to `null` or an empty string (`""`). |
| 10 | + |
| 11 | +**Important**: The automation automatically inserts a hyphen between the prefix and the resource name. Therefore, you do not need to include a hyphen in the prefix yourself. |
| 12 | + |
| 13 | +### Examples |
| 14 | + |
| 15 | +Here are some common patterns for using the prefix: |
| 16 | + |
| 17 | +- **Environment-based**: |
| 18 | + - `dev`, `test`, `prod` |
| 19 | +- **Environment + Region**: |
| 20 | + - `dev-eu-gb`, `prod-us-south`, `test-jp-tok` |
| 21 | +- **Project-specific**: |
| 22 | + - `webapp-dev`, `ml-prod`, `iot-test` |
| 23 | +- **Team or department identifiers**: |
| 24 | + - `fin-dev`, `hr-prod`, `eng-test` |
| 25 | +- **Date or version-based** (for temporary or experimental deployments): |
| 26 | + - `exp-202505`, `v2-dev` |
| 27 | + |
| 28 | +These conventions help ensure that resources are clearly grouped and easily identifiable, especially in shared or multi-tenant accounts. |
| 29 | + |
| 30 | +### Naming Rules |
| 31 | + |
| 32 | +To ensure compatibility and consistency, the prefix must follow these rules: |
| 33 | + |
| 34 | +- Must begin with a **lowercase letter** |
| 35 | +- May contain only **lowercase letters**, **digits**, and **hyphens (`-`)** |
| 36 | +- Must **not end** with a hyphen (`-`) |
| 37 | +- Must **not contain consecutive hyphens** (`--`) |
| 38 | +- Maximum length: **16 characters** |
0 commit comments