Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Document the use of `--profile` as an argument in `start-api`
  • Loading branch information
frob committed Dec 21, 2017
1 parent c4d34f2 commit 0a35154
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -348,6 +348,13 @@ As with the AWS CLI and SDKs, SAM Local will look for credentials in the followi
2. The AWS credentials file (located at `~/.aws/credentials` on Linux, macOS, or Unix, or at `C:\Users\USERNAME \.aws\credentials` on Windows).
3. Instance profile credentials (if running on Amazon EC2 with an assigned instance role).

In order to test API Gateway with a non-default profile from your AWS credentials file append `--profile <profile name>` to the `start-api` command:

```
// Test API Gateway locally with a credential profile.
$ sam local start-api --profile some_profile
```

See this [Configuring the AWS CLI](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#config-settings-and-precedence) for more details.

### Lambda Environment Variables
Expand Down

0 comments on commit 0a35154

Please sign in to comment.