rds_ssm_connect 1.0.6 → 1.0.9

package/README.md

@@ -20,15 +20,40 @@ You can install this application globally using npm:
 npm install -g rds_ssm_connect
 ```
 
-## Usage
+2. Select the environment you want to use. The application will then execute a series of AWS commands within that environment.
 
-1. Run the application. It will read your AWS configuration file and prompt you to select an environment.
+Given your provided code, here's how to connect to the database:
 
-```bash
-rds_ssm_connect
-```
+## Connecting to the Database
 
-2. Select the environment you want to use. The application will then execute a series of AWS commands within that environment.
+1. Invoke `rds_ssm_connect` in your terminal:
+
+   ```bash
+   rds_ssm_connect
+   ```
+
+   The application will read your AWS configuration file and prompt you to select an environment.
+
+2. Select the environment you want to connect to. The application will then execute a series of AWS commands within that environment. It will do the following:
+
+   - Extract the environments from the AWS configuration file
+   - Get the name of the parameter containing the RDS password
+   - Get the RDS credentials
+   - Display the connection credentials and the connection string
+   - Get the ID of the bastion instance
+   - Get the endpoint of the RDS cluster
+   - Start a port forwarding session to the RDS cluster
+
+3. After you've selected an environment and the AWS commands have been executed, you will receive the connection information. Here is an example of the output:
+
+   ```
+   Your connection string is: psql -h localhost -p <port> -U <username> -d oit
+   Use the password: <password>
+   ```
+
+4. Use the provided connection string and password to connect to your database via a database administration tool of your choice, such as pgAdmin, DBeaver, or the `psql` command-line interface.
+
+Please note: Make sure the chosen database administration tool is installed and configured on your local machine. The specific instructions for connecting to a database would vary based on the tool used.
 
 ## Requirements
 

package/connect.js

@@ -25,7 +25,10 @@ const envPortMapping = {
   dev: '5433',
   stage: '5434',
   'pre-prod': '5435',
-  prod: '5436'
+  prod: '5436',
+  dev2: '5437',
+  stage2: '5438',
+  sandbox: '5439'
 }
 
 // Define the table name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rds_ssm_connect",
-  "version": "1.0.6",
+  "version": "1.0.9",
   "type": "module",
   "dependencies": {
     "@aws-sdk/client-ec2": "^3.363.0",
@@ -18,7 +18,7 @@
   "devDependencies": {
     "eslint": "^8.44.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-n": "^16.0.1",
     "eslint-plugin-promise": "^6.1.1"
   }