feat: extra database connection properties - take 2

README.md

@@ -107,6 +107,24 @@ const provider = new Provider(this, "Provider", {
 })
 ```
 
+### Additional connection options
+
+Additional options can be passed to the provider.
+The available options can be found [here](https://node-postgres.com/apis/client).
+
+> Keep in mind that certain properties (e.g., username, password, host) are forcibly by this resource. If you provide them in `connectionProps`, they will be ignored.
+```ts
+const provider = new Provider(this, "Provider", {
+  vpc: vpc,
+  instance: instance,
+  secret: cluster.secret!,
+  connectionProps: {
+    ssl: true
+  }
+})
+```
+
+
 ## Roles
 
 Create a postgres role (user) for a cluster as follows:

src/database.ts

@@ -56,6 +56,7 @@ export class Database extends CustomResource implements IDatabase {
         ResourceId: props.databaseName,
         SecretArn: props.provider.secret.secretArn,
         Owner: props.owner?.roleName,
+        ConnectionProps: props.provider.connectionProps,
       },
     })
     this.node.addDependency(props.provider)

src/handler.ts

@@ -247,6 +247,7 @@ export const handler = async (
   const resource: RdsSqlResource = event.ResourceProperties.Resource
   const resourceId = event.ResourceProperties.ResourceId
   const databaseName = event.ResourceProperties.DatabaseName
+  const connectionProps = event.ResourceProperties.ConnectionProps || {}
 
   if (!Object.keys(jumpTable).includes(event.ResourceProperties.Resource)) {
     throw `Resource type '${resource}' not recognised.`
@@ -310,14 +311,17 @@ export const handler = async (
     } else {
       database = databaseName ?? secretValues.dbname // connect to given database if possible, else to database mentioned in secret
     }
-    const params = {
+    const baseParams = {
       host: secretValues.host,
       port: secretValues.port,
       user: secretValues.username,
       password: secretValues.password,
       database: database,
       connectionTimeoutMillis: 30000, // return an error if a connection could not be established within 30 seconds
     }
+    // merge the base params with the new params provided
+    // directly to the resource
+    const params = { ...connectionProps, ...baseParams }
     log(
       `Connecting to host ${params.host}: ${params.port}, database ${params.database} as ${params.user}`
     )

src/provider.ts

@@ -67,18 +67,28 @@ export interface RdsSqlProps {
    * @default - empty
    */
   readonly functionProps?: NodejsFunctionProps
+
+  /**
+   * Additional properties when establishing the database sql
+   * connection.
+   *
+   * @default - empty object
+   */
+  readonly connectionProps?: any
 }
 
 export class Provider extends Construct {
   public readonly serviceToken: string
   public readonly secret: ISecret
   public readonly handler: IFunction
   public readonly cluster: IServerlessCluster | IDatabaseCluster | IDatabaseInstance
+  public readonly connectionProps?: any
 
   constructor(scope: Construct, id: string, props: RdsSqlProps) {
     super(scope, id)
     this.secret = props.secret
     this.cluster = props.cluster
+    this.connectionProps = props.connectionProps
 
     const functionName = "RdsSql" + slugify("28b9e791-af60-4a33-bca8-ffb6f30ef8c5")
     this.handler =

src/role.custom-resource.ts

@@ -53,6 +53,7 @@ export class Role extends CustomResource {
         SecretArn: props.provider.secret.secretArn,
         PasswordArn: props.passwordArn,
         DatabaseName: props.database ? props.database.databaseName : props.databaseName,
+        ConnectionProps: props.provider.connectionProps,
       },
     })
     this.node.addDependency(props.provider)

src/schema.ts

@@ -34,6 +34,7 @@ export class Schema extends CustomResource {
         ResourceId: props.schemaName,
         SecretArn: props.provider.secret.secretArn,
         DatabaseName: props.database ? props.database.databaseName : undefined,
+        ConnectionProps: props.provider.connectionProps,
       },
     })
     this.node.addDependency(props.provider)

src/sql.ts

@@ -38,6 +38,7 @@ export class Sql extends CustomResource {
         DatabaseName: props.database ? props.database.databaseName : undefined,
         Statement: props.statement,
         Rollback: props.rollback,
+        ConnectionProps: props.provider.connectionProps,
       },
     })
     this.node.addDependency(props.provider)