-
Notifications
You must be signed in to change notification settings - Fork 5
feat: add DA prefix doc #76
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
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Prefix in Deployable Architecture | ||
|
||
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: | ||
|
||
- **Avoiding naming collisions** when deploying the same solution multiple times within the same account. | ||
- **Creating identical infrastructure** across multiple regions or environments. | ||
- **Improving resource traceability** by embedding environment or region identifiers into resource names. | ||
|
||
If you do not wish to use a prefix, you may set the value to `null` or an empty string (`""`). | ||
|
||
**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. | ||
|
||
### Examples | ||
|
||
Here are some common patterns for using the prefix: | ||
|
||
- **Environment-based**: | ||
- `dev`, `test`, `prod` | ||
- **Environment + Region**: | ||
- `dev-eu-gb`, `prod-us-south`, `test-jp-tok` | ||
- **Project-specific**: | ||
- `webapp-dev`, `ml-prod`, `iot-test` | ||
- **Team or department identifiers**: | ||
- `fin-dev`, `hr-prod`, `eng-test` | ||
- **Date or version-based** (for temporary or experimental deployments): | ||
- `exp-202505`, `v2-dev` | ||
|
||
These conventions help ensure that resources are clearly grouped and easily identifiable, especially in shared or multi-tenant accounts. | ||
|
||
### Naming Rules | ||
|
||
To ensure compatibility and consistency, the prefix must follow these rules: | ||
|
||
- Must begin with a **lowercase letter** | ||
- May contain only **lowercase letters**, **digits**, and **hyphens (`-`)** | ||
- Must **not end** with a hyphen (`-`) | ||
- Must **not contain consecutive hyphens** (`--`) | ||
- Maximum length: **16 characters** | ||
maheshwarishikha marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.