Skip to content

Commit afe6ff4

Browse files
committed
Add env vars to README
1 parent b891227 commit afe6ff4

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,42 @@ After running setup, it's a good idea to gitignore the generated `event.json` an
5454
$ echo -e ".env\ndeploy.env\nevent.json\n.lambda" >> .gitignore
5555
```
5656

57+
##### Deploy env variables
58+
59+
```
60+
AWS_ENVIRONMENT // (default: '')
61+
CONFIG_FILE // (default: '')
62+
EVENT_SOURCE_FILE // (default: '')
63+
EXCLUDE_GLOBS // (default: '')
64+
AWS_ACCESS_KEY_ID // (default: not set!)
65+
AWS_SECRET_ACCESS_KEY // (default: not set!)
66+
AWS_PROFILE = // (default: '')
67+
AWS_SESSION_TOKEN = // (default: '')
68+
AWS_REGION = // (default: 'us-east-1,us-west-2,eu-west-1')
69+
AWS_FUNCTION_NAME // (default: package.json.name or 'UnnamedFunction')
70+
AWS_HANDLER // (default: 'index.handler')
71+
AWS_ROLE_ARN || AWS_ROLE // (default: 'missing')
72+
AWS_MEMORY_SIZE // (default: 128)
73+
AWS_TIMEOUT // (default: 60)
74+
AWS_RUN_TIMEOUT // (default: 3)
75+
AWS_DESCRIPTION // (default: package.json.description or '')
76+
AWS_RUNTIME // (default: 'nodejs6.10')
77+
AWS_PUBLISH // (default: false)
78+
AWS_FUNCTION_VERSION // (default: '')
79+
AWS_VPC_SUBNETS // (default: '')
80+
AWS_VPC_SECURITY_GROUPS // (default: '')
81+
AWS_TRACING_CONFIG // (default: '')
82+
EVENT_FILE // (default: 'event.json')
83+
PACKAGE_DIRECTORY // (default: not set)
84+
CONTEXT_FILE // (default: 'context.json')
85+
PREBUILT_DIRECTORY // (default: '')
86+
SRC_DIRECTORY // (default: '')
87+
DEPLOY_TIMEOUT // (default: '120000')
88+
DOCKER_IMAGE // (default: '')
89+
DEPLOY_ZIPFILE // (default: '')
90+
AWS_DLQ_TARGET_ARN // (default: not set)
91+
```
92+
5793
#### run
5894

5995
Runs your Amazon Lambda index.js file locally. Passes `event.json` data to the Amazon Lambda event object.
@@ -193,3 +229,4 @@ When setting ScheduleState to `ENABLED` or `DISABLED` for ScheduleEvents, it is
193229
$ npm install
194230
$ npm test
195231
```
232+

0 commit comments

Comments
 (0)