Skip to content

Commit 134098c

Browse files
authored
Update README.md
1 parent 0870095 commit 134098c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,16 +154,18 @@ First, you will need your secret environment variables setup in [AWS Systems Man
154154

155155
Crypteia supports two methods to fetch SSM parameters:
156156

157-
1. `x-crypteia-ssm:` - Single path for a single environment variable.
158-
2. `x-crypteia-ssm-path:` - Path prefix to fetch many environment variables.
157+
1. `x-crypteia-ssm:` - [Single] path for a single environment variable.
158+
2. `x-crypteia-ssm-path:` - [Group] Path prefix to fetch many environment variables.
159159

160160
Using whatever serverless framework you prefer, and set up your function's environment variables using either of the two SSM interfaces from above. For example, here is an environment variables section for an [AWS SAM](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-getting-started.html) template that demonstrates all of Crypteia's features.
161161

162162
```yaml
163163
Environment:
164164
Variables:
165+
# [Single] Example
165166
SECRET: x-crypteia-ssm:/myapp/SECRET
166167
ACCESS_KEY: x-crypteia-ssm:/myapp/access-key
168+
# [Group] Example
167169
X_CRYPTEIA_SSM: x-crypteia-ssm-path:/myapp/envs
168170
DB_URL: x-crypteia
169171
NR_KEY: x-crypteia

0 commit comments

Comments
 (0)