summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Henderson <dhenderson@gmail.com>2016-09-01 22:52:39 -0400
committerDave Henderson <dhenderson@gmail.com>2016-09-01 22:56:09 -0400
commite6a2cfbf18894d944f744f9b2efc3be389a19e67 (patch)
treeb379c2ecc331a7f06dcf53afe52689f394b57bd2 /README.md
parent1fb1dbb55fa635fb09d91c92f44c22b3f6336c52 (diff)
Adding ability to provide default for ec2region function
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9f51552b..a4f7718c 100644
--- a/README.md
+++ b/README.md
@@ -245,14 +245,23 @@ us-east-1
#### `ec2region`
-Queries AWS to get the region. Returns `unknown` if it can't be determined for some reason.
+Queries AWS to get the region. An optional default can be provided, or returns
+`unknown` if it can't be determined for some reason.
##### Example
+_In EC2_
```console
$ echo '{{ ec2region }}' | ./gomplate
us-east-1
```
+_Not in EC2_
+```console
+$ echo '{{ ec2region }}' | ./gomplate
+unknown
+$ echo '{{ ec2region "foo" }}' | ./gomplate
+foo
+```
#### `ec2tag`