Skip to content

Add example for specifying tags/params via file #705

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add example for specifying tags/params via file #705

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
109602b
Add example for specifying tags/params
Aug 20, 2025
0659a07
Update formatting for config flag example
Aug 20, 2025
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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,36 @@ Rain is licensed under the Apache 2.0 License.

## Example Usage

### Specifying Parameter and Tag Values via File

The `--config` flag can be used to programmatically set tags and parameters.
The format is similar to the "Template configuration file" for AWS CodePipeline
just without the 'StackPolicy' key. The file can be in YAML or JSON format.

JSON:
```json
{
"Parameters" : {
"NameOfTemplateParameter1" : "ValueOfParameter1",
"NameOfTemplateParameter2" : "ValueOfParameter2"
},
"Tags" : {
"TagKey1" : "TagValue1",
"TagKey2" : "TagValue2"
}
}
```

YAML:
```yaml
Parameters:
NameOfTemplateParameter1: ValueOfParameter1
NameOfTemplateParameter2: ValueOfParameter2
Tags:
TagKey1: TagValue1
TagKey2: TagValue2
```

### Packaging

The `rain pkg` command can be used as a replacement for the `aws cloudformation
Expand Down