@raydeck/serverless-setup
v3.1.2
Published
Utility for setting up a serverless config
Readme
Usage
serverless-setup [options]Options
- -p --currentPath <
pathname> Reference path for examining a serverlesss setup (default: . - -t --stage <
stage> Stack stage to check against. Defaul value is dev (default: dev - -a --aws-profile <
profile> Named AWS Profile - -f --file-name [filename] File to write output (default config.json) (default: config.json
- -s --standard-output Write to standard output instead of config.json
- -n --stack-name <
stackname> Name of the stack/application (e.g. privilege, test-a, etc) - -r --region <
region> Region to pass to serverless commands
@raydeck/serverless-setup - v3.1.2
Index
Variables
Functions
Variables
Let cachedAccountId
• cachedAccountId: string | undefined
Defined in index.ts:8
Functions
Const getAccountID
▸ getAccountID(): Promise‹string›
Defined in index.ts:9
Returns: Promise‹string›
Const makeConfig
▸ makeConfig(__namedParameters: object): Promise‹object›
Defined in index.ts:16
Parameters:
▪ __namedParameters: object
Name | Type | Default |
------ | ------ | ------ |
awsProfile | undefined | string | - |
cmd | cmd | - |
currentPath | string | process.cwd() |
fromName | string | - |
getMyResources | boolean | false |
ignoreResources | boolean | false |
region | undefined | string | - |
stage | string | "dev" |
Returns: Promise‹object›
Const writeConfig
▸ writeConfig(fromObject: object, toPath: string, fileName: string): boolean
Defined in index.ts:111
Parameters:
Name | Type | Default |
------ | ------ | ------ |
fromObject | object | - |
toPath | string | process.cwd() |
fileName | string | "config.json" |
Returns: boolean
