Skip to content

Commit d451934

Browse files
authored
Merge pull request #497 from aws/jikwa-develop
Small JDBC documentation changes
2 parents b4880cd + 175bc17 commit d451934

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

GETTING_STARTED.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,8 @@ integration testing, follow the directions below.
271271
To enable integration testing the following environment variables allow
272272
you to customize the credentials and DocumentDB cluster settings.
273273

274+
For MacOS, you may need to make changes to ~/.zshrc, source the file, and restart the IDE for changes to be picked up.
275+
274276
1. Create and set the following environment variables:
275277

276278
| Variable | Description | Example |
@@ -279,7 +281,7 @@ you to customize the credentials and DocumentDB cluster settings.
279281
| `DOC_DB_PASSWORD` | This is the DocumentDB password. | `aSecret` |
280282
| `DOC_DB_LOCAL_PORT` | This is the port number used locally via an SSH Tunnel. It is recommend to use a different value than the default 27017. | `27019` |
281283
| `DOC_DB_USER` | This is the user and host of SSH Tunnel EC2 instance. | `[email protected]` |
282-
| `DOC_DB_HOST` | This is the host of the DocumentDB cluster server. | `docdb-jdbc-literal-test.cluster-abcdefghijk.us-east-2.docdb.amazonaws.com` |
284+
| `DOC_DB_HOST` | This is the host of the DocumentDB cluster server, including the port, separated by a colon (i.e., \<cluster endpoint>:\<port>). | `docdb-jdbc-literal-test.cluster-abcdefghijk.us-east-2.docdb.amazonaws.com:27017` |
283285
| `DOC_DB_PRIV_KEY_FILE` | This is the path to the SSH Tunnel private key-pair file. | `~/.ssh/ec2-literal.pem` |
284286

285287
### SSH Tunnel

0 commit comments

Comments
 (0)