From 109602bbec66a17279765737534d5297eab0df3a Mon Sep 17 00:00:00 2001 From: Brian Shacklett Date: Wed, 20 Aug 2025 09:35:54 -0400 Subject: [PATCH 1/2] Add example for specifying tags/params --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 0e808302..f7f939e9 100644 --- a/README.md +++ b/README.md @@ -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 From 0659a07505bd26d151da4ebc61b848fa6bd03108 Mon Sep 17 00:00:00 2001 From: Brian Shacklett Date: Wed, 20 Aug 2025 10:02:40 -0400 Subject: [PATCH 2/2] Update formatting for config flag example --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7f939e9..17472708 100644 --- a/README.md +++ b/README.md @@ -100,8 +100,8 @@ Rain is licensed under the Apache 2.0 License. ### 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 +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: