# rds-cli

> This AWS CDK project is designed to save time and reduce duplicated work when provisioning Amazon RDS instances. It automates the creation of AWS resources such as RDS secrets for CI, APP, and Readonly users, security groups, RDS proxy security groups, RD

Latest version **0.1.6** (published 2023-04-05) · 0 weekly downloads

## Install

```sh
npm install rds-cli
pnpm add rds-cli
yarn add rds-cli
bun add rds-cli
```

Provides the command `rds`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2023-04-05 |
| First published | 2023-04-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 116.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Datarock |
| Maintainers | loic_wang |

## Links

- npm: https://www.npmjs.com/package/rds-cli
- Repository: https://github.com/data-rock/rds-cli
- Homepage: https://github.com/data-rock/rds-cli/blob/master/README.md
- Issues: https://github.com/data-rock/rds-cli/issues
- npm.io page: https://npm.io/package/rds-cli

## Dependencies (12)

- [aws-cdk](https://npm.io/package/aws-cdk.md) 2.70.0
- [constructs](https://npm.io/package/constructs.md) ^10.0.0
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^9.0.1
- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) ^1.198.0
- [@aws-cdk/aws-ec2](https://npm.io/package/@aws-cdk/aws-ec2.md) ^1.198.0
- [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) ^1.198.0
- [@aws-cdk/aws-rds](https://npm.io/package/@aws-cdk/aws-rds.md) ^1.198.0
- [@aws-cdk/aws-ssm](https://npm.io/package/@aws-cdk/aws-ssm.md) ^1.198.0
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.21
- [@aws-sdk/client-ssm](https://npm.io/package/@aws-sdk/client-ssm.md) ^3.299.0
- [@aws-cdk/aws-secretsmanager](https://npm.io/package/@aws-cdk/aws-secretsmanager.md) ^1.198.0
- [@aws-sdk/client-cloudformation](https://npm.io/package/@aws-sdk/client-cloudformation.md) ^3.299.0

## Recent versions

- 0.1.6 (latest) — 2023-04-05
- 0.1.5 — 2023-04-05
- 0.1.4 — 2023-04-05
- 0.1.3 — 2023-04-05
- 0.1.2 — 2023-04-05
- 0.1.1 — 2023-04-05

## README

## Overview
This AWS CDK project is designed to save time and reduce duplicated work when provisioning Amazon RDS instances. It automates the creation of AWS resources such as RDS secrets for CI, APP, and Readonly users, security groups, RDS proxy security groups, RDS proxy role, RDS database instance, RDS proxy, and RDS proxy target group. Additionally, the project provides output of the database related endpoints and names.

## Prerequisites
Before you can use this AWS CDK project, you must have the following prerequisites installed and configured:

- AWS CLI
- Node.js and npm
- AWS CDK CLI

You must also have appropriate AWS credentials configured on your system.

## Installation
Clone this repository to your local machine.
Navigate to the root directory of the project in your terminal or command prompt.
Run npm install to install the project dependencies.

The `cdk.json` file tells the CDK Toolkit how to execute your app.

## Usage

### RDS-CLI repo
Modify the properties of the RdsStackProps interface to match your desired configuration for the RDS instance.
Save the file.

In your terminal or command prompt, run the following command to provision the RDS instance:

`cdk deploy`

This will deploy the RDS instance and associated resources to your AWS account.

When the deployment is complete, the AWS CloudFormation console will display the output values for the stack. These values will include the endpoint and name of the RDS instance and other relevant information.

## Other repos
1. Install rds-cli npm module

run `npm install rds-cli`

2. Provisioning the rds resources with specified DB, TIER, SIZE
 * DB - database name , e.g fracture-segmentation
 * TIER - AWS InstanceClass , e.g t2, t3 https://docs.aws.amazon.com/cdk/api/v1/java/software/amazon/awscdk/services/ec2/InstanceClass.html
 * SIZE - AWS InstanceSize, e.g mirco, small,  https://docs.aws.amazon.com/cdk/api/v1/java/software/amazon/awscdk/services/ec2/InstanceSize.html

run `DB=fracture-segmentation TIER=t2 SIZE=small ENVIRONMENT=test rds`

`CDK_DEFAULT_REGION` and `CDK_DEFAULT_ACCOUNT` are read from the current aws credential. To run it locally, both of the environment variable are required.


## Cleanup
When you are finished with the RDS instance, you can remove it from your AWS account to avoid incurring additional charges. To do this, run the following command in your terminal or command prompt:

`cdk destroy`

This will remove all resources associated with the stack.

## Useful commands

* `npm run build`   compile typescript to js
* `npm run watch`   watch for changes and compile
* `npm run test:coverage` perform the jest unit tests with coverage output
* `npm run test`    perform the jest unit tests
* `npm run audit` check audit
* `npm run audit:fix` fix audit
* `npm run lint` check lint error
* `npm run lint:fix` auto fix general lint error
* `npm run pretty:check`  check the code format
* `npm run pretty:fix` code prettier
* `npm run ci` check code style, lint error and audit issue
* `npm run patch-release` release the command rds-cli
* `cdk` list the ckd commands
* `cdk deploy`      deploy this stack to your default AWS account/region
* `cdk diff`        compare deployed stack with current state
* `cdk synth`       emits the synthesized CloudFormation template

## Naming conventions

Given `{pascalDbName : 'CdkTestDb', snakeDbName : 'cdk-test-db'}`

| Resources  | Name | Notes |
| ------------- | ------------- | --------------|
| AWS::SecretsManager::Secret  | `cdk-test-db`-`test`-RDS-ReadonlySecret  | username: `CdkTestDb_readonly`, password: `uuidv4`, ssmUsername:`/rds/cdk-test-db/test/readonly/username`, ssmPassword:`/rds/cdk-test-db/test/readonly/username`|
| AWS::SecretsManager::Secret  | `cdk-test-db`-`test`-RDS-CISecret  | username: `CdkTestDb_ci`, password: `uuidv4`, ssmUsername:`/rds/cdk-test-db/test/ci/username`, ssmPassword:`/rds/cdk-test-db/test/ci/username`|
| AWS::SecretsManager::Secret  | `cdk-test-db`-`test`-RDS-AppSecret  | username: `CdkTestDb_app`, password: `uuidv4`, ssmUsername:`/rds/cdk-test-db/test/app/username`, ssmPassword:`/rds/cdk-test-db/test/app/username`|
| AWS::IAM::Role  | `CdkTestDb`RDSProxyRole  |
| AWS::EC2::SecurityGroup  | `CdkTestDb`RDSProxySecurityGroup  |
| AWS::EC2::SecurityGroup  | `CdkTestDb`RDSSecurityGroup  |
| AWS::RDS::DBInstance  | `cdk-test-db`-`test`  | DBName: `cdktestdbtest`  DBInstanceIdentifier: `cdk-test-db-test`, MasterUsername: `CdkTestDb_ci`, MasterUserPassword: `uuidv4` |
| AWS::RDS::DBProxy  | `cdk-test-db`-rds-proxy`  |
| AWS::RDS::DBProxyTargetGroup  | default  |
| Outputs| `CdkTestDb`DatabaseProxy, `CdkTestDb`DatabaseHost`, `CdkTestDb`DatabasePort, `CdkTestDb`DatabaseName |

8 digits will be added to resource name to make sure it's global unique

## Issues

1. Fn:Import value doesn't work properly in AWS-CDK, to resolve the problem, we would need to read the data from ssm or read from stack details
2. RdsProxy IAMAuth is attached to Proxy rather than DBSecrets, so we can't have different IAMAuth configuration for the secrets under the RdsProxy. To resolve the issue, we override the generated raw CF (This approach can deal with most of the scenarios where the cdk lib's output mismatch the CF configuration).
3. To create the credential and put it into ssm, we would need to check its existence, fetch ssm will throw an exception and terminate the deployment processes even if we captured the exception. To avoid the exception being thrown, we have to read the parameter describes to check existence.
4. DBProxyTargetGroup deployment can't be processed successfully when the proxy is added to rds instance. To resolve the issue, the connection has to be bind explicitly.  https://github.com/aws/aws-cdk/issues/8919, https://github.com/aws/aws-cdk/pull/12953

## Extension
To make it more usable, we could potentially enhance the index.js file to support the optional arguments with echo

To support more features, we can create a new cli command line
```text
"bin": {
	"rds": "bin/index.js"
	"ssm": "bin/ssm.js"
},
```

## Conclusion
This AWS CDK project can save you significant time and effort when provisioning Amazon RDS instances. It automates the creation of resources and provides output values that can be used to configure your applications to use the new RDS instance. By using this project, you can quickly and easily provision RDS instances without having to manually create and configure each resource.

---
_Source: https://npm.io/package/rds-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._