cdk-rds-sql 3.3.0 → 3.4.1

package/.jsii

@@ -7,16 +7,16 @@
     ]
   },
   "bundled": {
-    "@aws-sdk/client-secrets-manager": "^3.578.0",
-    "@types/aws-lambda": "^8.10.138",
+    "@aws-sdk/client-secrets-manager": "^3.650.0",
+    "@types/aws-lambda": "^8.10.145",
     "exponential-backoff": "^3.1.1",
     "ms": "^2.1.3",
     "node-pg-format": "^1.3.5",
-    "pg": "^8.11.5",
+    "pg": "^8.12.0",
     "source-map-support": "^0.5.21"
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.124.0",
+    "aws-cdk-lib": "^2.144.0",
     "constructs": "^10.3.0"
   },
   "dependencyClosure": {
@@ -505,10 +505,23 @@
             }
           }
         },
+        "aws-cdk-lib.aws_bcmdataexports": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.BCMDataExports"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.bcmdataexports"
+            },
+            "python": {
+              "module": "aws_cdk.aws_bcmdataexports"
+            }
+          }
+        },
         "aws-cdk-lib.aws_bedrock": {
           "targets": {
             "dotnet": {
-              "namespace": "Amazon.CDK.AWS.Bedrock"
+              "package": "Amazon.CDK.AWS.Bedrock"
             },
             "java": {
               "package": "software.amazon.awscdk.services.bedrock"
@@ -609,6 +622,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_cleanroomsml": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.CleanRoomsML"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.cleanroomsml"
+            },
+            "python": {
+              "module": "aws_cdk.aws_cleanroomsml"
+            }
+          }
+        },
         "aws-cdk-lib.aws_cloud9": {
           "targets": {
             "dotnet": {
@@ -740,6 +766,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_codeconnections": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.CodeConnections"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.codeconnections"
+            },
+            "python": {
+              "module": "aws_cdk.aws_codeconnections"
+            }
+          }
+        },
         "aws-cdk-lib.aws_codedeploy": {
           "targets": {
             "dotnet": {
@@ -1013,6 +1052,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_deadline": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.Deadline"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.deadline"
+            },
+            "python": {
+              "module": "aws_cdk.aws_deadline"
+            }
+          }
+        },
         "aws-cdk-lib.aws_detective": {
           "targets": {
             "dotnet": {
@@ -2534,6 +2586,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_paymentcryptography": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.PaymentCryptography"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.paymentcryptography"
+            },
+            "python": {
+              "module": "aws_cdk.aws_paymentcryptography"
+            }
+          }
+        },
         "aws-cdk-lib.aws_pcaconnectorad": {
           "targets": {
             "dotnet": {
@@ -2612,6 +2677,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_qbusiness": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.QBusiness"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.qbusiness"
+            },
+            "python": {
+              "module": "aws_cdk.aws_qbusiness"
+            }
+          }
+        },
         "aws-cdk-lib.aws_qldb": {
           "targets": {
             "dotnet": {
@@ -2820,6 +2898,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_route53profiles": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.Route53Profiles"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.route53profiles"
+            },
+            "python": {
+              "module": "aws_cdk.aws_route53profiles"
+            }
+          }
+        },
         "aws-cdk-lib.aws_route53recoverycontrol": {
           "targets": {
             "dotnet": {
@@ -3041,6 +3132,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_securitylake": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.SecurityLake"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.securitylake"
+            },
+            "python": {
+              "module": "aws_cdk.aws_securitylake"
+            }
+          }
+        },
         "aws-cdk-lib.aws_servicecatalog": {
           "targets": {
             "dotnet": {
@@ -3210,19 +3314,6 @@
             }
           }
         },
-        "aws-cdk-lib.aws_ssmguiconnect": {
-          "targets": {
-            "dotnet": {
-              "package": "Amazon.CDK.AWS.SSMGuiConnect"
-            },
-            "java": {
-              "package": "software.amazon.awscdk.services.ssmguiconnect"
-            },
-            "python": {
-              "module": "aws_cdk.aws_ssmguiconnect"
-            }
-          }
-        },
         "aws-cdk-lib.aws_ssmincidents": {
           "targets": {
             "dotnet": {
@@ -3671,7 +3762,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/berenddeboer/cdk-rds-sql.git",
-  "jsiiVersion": "1.98.0 (build 00b106d)",
+  "jsiiVersion": "1.103.1 (build bef2dea)",
   "keywords": [
     "aurora",
     "aws",
@@ -3690,7 +3781,7 @@
   },
   "name": "cdk-rds-sql",
   "readme": {
-    "markdown": "# About\n\nThis CDK construct library makes it possible to create databases,\nschemas, and roles in an Aurora Serverless or database cluster created\nin that stack. Both Aurora Serverless v1 and v2 are supported.\n\nThis construct library is intended to be used in enterprise\nenvironments, and works in isolated subnets.\n\n<p align=\"left\">\n  <a href=\"https://github.com/semantic-release/semantic-release\"><img src=\"https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release\" alt=semantic-release: angular\"></a>\n  <a href=\"https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml\"><img src=\"https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml/badge.svg\" alt=\"Release badge\"></a>\n</p>\n\n# Requirements\n\n- CDK v2.\n\n# Installation\n\n     npm i cdk-rds-sql\n\n# Usage\n\n## Provider\n\nFirst setup your VPC and create your cluster:\n\n```ts\nimport { Duration, RemovalPolicy } from \"aws-cdk-lib\"\nimport * as ec2 from \"aws-cdk-lib/aws-ec2\"\nimport * as rds from \"aws-cdk-lib/aws-rds\"\n\nconst vpc = ec2.Vpc.fromLookup(this, \"Vpc\", {\n  vpcId: this.node.tryGetContext(\"vpc-id\"),\n})\n\nconst cluster = new rds.ServerlessCluster(this, \"Cluster\", {\n  vpc: vpc,\n  vpcSubnets: {\n    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n  },\n  engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n  parameterGroup: rds.ParameterGroup.fromParameterGroupName(\n    this,\n    \"ParameterGroup\",\n    \"default.aurora-postgresql11\"\n  ),\n  removalPolicy: RemovalPolicy.DESTROY,\n  scaling: {\n    autoPause: Duration.minutes(60),\n    minCapacity: rds.AuroraCapacityUnit.ACU_2,\n    maxCapacity: rds.AuroraCapacityUnit.ACU_2,\n  },\n})\n```\n\nThen create a provider which will connect to your database:\n\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\nThe provider will setup a lambda, which normally lives in the same VPC\nas the database. You can give a different VPC, as long as that VPC has\naccess to the VPC of the database. Only the provider lambda will talk\nto your database.\n\nThe provider will by default use the private isolated subnet of the\nVPC. This is a breaking change from the past, where the provider used\nthe default strategy, which may not have been the private isolated\nsubnet. But from an enterprise security point of view having third\nparty code run in an isolated network by default is better.\n\nYour isolated network must have a VPC endpoint to AWS Secrets Manager\nand possibly KMS as well. If you want to use a subnet with egress\naccess in case you have no such VPC endpoints, specify the subnet as\nfollows:\n\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  vpcSubnet: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,\n  },\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\n## Roles\n\nCreate a postgres role (user) as follows:\n\n```ts\nimport { Role } from \"cdk-rds-sql\"\n\nconst role = new Role(this, \"Role\", {\n  provider: provider,\n  roleName: \"myrole\",\n  databaseName: \"mydb\",\n})\n```\n\nThis will automatically create a secret just like `ServerlessCluster`\ndoes, with all the connection info needed for this user. It's secret value is a JSON like:\n\n```json\n{\n  \"dbClusterIdentifier\": \"teststack-clustereb1186t9-sh4wpqfdyfvu\",\n  \"password\": \"very-long-and-boring\",\n  \"dbname\": \"mydb\",\n  \"engine\": \"postgres\",\n  \"port\": 5432,\n  \"host\": \"teststack-clustereb1186t9-sh4wpqfdyfvu.cluster-cgudolabssna.us-east-1.rds.amazonaws.com\",\n  \"username\": \"myrole\"\n}\n```\n\nYou can access the secret via `role.secret`.\n\nInstead of `databaseName` you can also specify `database` to reference\nan existing database. The role will not be created until the database\nhas been created.\n\n## Database\n\nCreate a database as follows:\n\n```ts\nimport { Database } from \"cdk-rds-sql\"\n\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n})\n```\n\nYou can provide an owner, which makes it easy to create database owned\nby a new user:\n\n```ts\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n  owner: role,\n})\n```\n\n## Schema\n\nCreate a schema in the default database as follows:\n\n```ts\nimport { Schema } from \"cdk-rds-sql\"\n\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n})\n```\n\nOr in another database:\n\n```ts\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n})\n\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n  databaseName: database.databaseName,\n})\n```\n\n## Sql\n\nYou can insert arbitrary SQL into your database with the `Sql` construct:\n\n```ts\nimport { Sql } from \"cdk-rds-sql\"\n\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: \"create table t (i int)\",\n})\n```\n\nCreate a table if it does not exist, and grant a role privileges:\n\n```ts\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: `\ncreate table if not exists t (i int);\ngrant select on t to myrole;\n`,\n})\n```\n\nRollback sql on stack deletion:\n\n```ts\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: `\ncreate table if not exists t (i int);\ngrant select on t to myrole;\n`,\n  rollback: `\nDO $$BEGIN\n  IF EXISTS (select from pg_database WHERE datname = 't') THEN\n    IF EXISTS (select from pg_catalog.pg_roles WHERE rolname = 'myrole') THEN\n      revoke select t from myrole;\n    END IF;\n    drop table t;\n  END IF;\nEND$$;\n`\n})\n```\n\n\nNote that there is no synchronisation between various `Sql`\nconstructs, in particular the order in your code does not determine\nthe order in which your SQL is executed. This happens in parallel,\nunless you specify an explicit dependency via `sql.node.addDepency()`.\n\nThere are a lot of concerns when using `Sql`:\n\n- When you update your Sql, your previous Sql is not \"rolled back\",\n  the new Sql is simply executed again.\n- When you delete your `Sql` construct the rollback is executed if specified\n- When permission are granted via `Sql` they must be removed via rollback to succesfully remove the role\n- Currently the `Sql` constructs has less than 5 minutes to execute\n  its work.\n- It is unknown how large your SQL can be.\n\n## Dependencies\n\nThis library manages dependencies, there is no need to specify\ndependencies except possibly for `Sql` constructs.\n\n# Working on this code\n\nThis code is managed by\n[projen](https://github.com/projen/projen/blob/main/README.md). In\naddition [pre-commit](https://pre-commit.com/) is used.\n\nSo after git clone and `npm ci` you would do:\n\n```\npre-commit install --install-hooks --hook-type commit-msg --hook-type pre-commit\n```\n\nto install the pre-commit hooks.\n\n## Testing\n\nTest code via projen with:\n\n    npx projen test\n\nYou can run the sample stack with:\n\n    npx cdk deploy --context vpc-id=vpc-0123456789 TestServerlessV1Stack\n\nOr for v2:\n\n    npx cdk deploy TestServerlessV2Stack\n\nIf you want to use an existing vpc:\n\n    npx cdk deploy --context vpc-id=vpc-0123456789 TestServerlessV2Stack\n\n# To do\n\n- Update role: will not revoke connect to previous database if database name has changed.\n- If the cluster is configured for autopausing, wake cluster up before doing any SQL operations.\n- We rename roles and database on update: is that actually the best\n  thing? More change to get us into an irrecoverable situation??\n"
+    "markdown": "# About\n\nThis CDK construct library makes it possible to create databases,\nschemas, and roles in an Aurora Serverless (v1 and v2 are supported), RDS Database Cluster or Database Instance created\nin that stack.\n\nThis construct library is intended to be used in enterprise\nenvironments, and works in isolated subnets.\n\n<p align=\"left\">\n  <a href=\"https://github.com/semantic-release/semantic-release\"><img src=\"https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release\" alt=semantic-release: angular\"></a>\n  <a href=\"https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml\"><img src=\"https://github.com/berenddeboer/cdk-rds-sql/actions/workflows/release.yml/badge.svg\" alt=\"Release badge\"></a>\n</p>\n\n# Requirements\n\n- CDK v2.\n\n# Installation\n\n     npm i cdk-rds-sql\n\n# Usage\n\n## Provider\n\nFirst setup your VPC and create your cluster:\n\n```ts\nimport { Duration, RemovalPolicy } from \"aws-cdk-lib\"\nimport * as ec2 from \"aws-cdk-lib/aws-ec2\"\nimport * as rds from \"aws-cdk-lib/aws-rds\"\n\nconst vpc = ec2.Vpc.fromLookup(this, \"Vpc\", {\n  vpcId: this.node.tryGetContext(\"vpc-id\"),\n})\n\nconst cluster = new rds.ServerlessCluster(this, \"Cluster\", {\n  vpc: vpc,\n  vpcSubnets: {\n    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n  },\n  engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n  parameterGroup: rds.ParameterGroup.fromParameterGroupName(\n    this,\n    \"ParameterGroup\",\n    \"default.aurora-postgresql11\"\n  ),\n  removalPolicy: RemovalPolicy.DESTROY,\n  scaling: {\n    autoPause: Duration.minutes(60),\n    minCapacity: rds.AuroraCapacityUnit.ACU_2,\n    maxCapacity: rds.AuroraCapacityUnit.ACU_2,\n  },\n})\n```\n\nThen create a provider which will connect to your database. For a cluster:\n\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\nFor an instance:\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  instance: instance,\n  secret: cluster.secret!,\n})\n```\n\nThe provider will setup a lambda, which normally lives in the same VPC\nas the database. You can give a different VPC, as long as that VPC has\naccess to the VPC of the database. Only the provider lambda will talk\nto your database.\n\nThe provider will by default use the private isolated subnet of the\nVPC. This is a breaking change from the past, where the provider used\nthe default strategy, which may not have been the private isolated\nsubnet. But from an enterprise security point of view having third\nparty code run in an isolated network by default is better.\n\nYour isolated network must have a VPC endpoint to AWS Secrets Manager\nand possibly KMS as well. If you want to use a subnet with egress\naccess in case you have no such VPC endpoints, specify the subnet as\nfollows:\n\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  vpcSubnet: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,\n  },\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\n## Roles\n\nCreate a postgres role (user) for a cluster as follows:\n\n```ts\nimport { Role } from \"cdk-rds-sql\"\n\nconst role = new Role(this, \"Role\", {\n  provider: provider,\n  roleName: \"myrole\",\n  databaseName: \"mydb\",\n})\n```\n\nThis will automatically create a secret just like `ServerlessCluster`\ndoes, with all the connection info needed for this user. It's secret value is a JSON like:\n\n```json\n{\n  \"dbClusterIdentifier\": \"teststack-clustereb1186t9-sh4wpqfdyfvu\",\n  \"password\": \"very-long-and-boring\",\n  \"dbname\": \"mydb\",\n  \"engine\": \"postgres\",\n  \"port\": 5432,\n  \"host\": \"teststack-clustereb1186t9-sh4wpqfdyfvu.cluster-cgudolabssna.us-east-1.rds.amazonaws.com\",\n  \"username\": \"myrole\"\n}\n```\n\nYou can access the secret via `role.secret`.\n\nInstead of `databaseName` you can also specify `database` to reference\nan existing database. The role will not be created until the database\nhas been created.\n\n## Database\n\nCreate a database as follows:\n\n```ts\nimport { Database } from \"cdk-rds-sql\"\n\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n})\n```\n\nYou can provide an owner, which makes it easy to create database owned\nby a new user:\n\n```ts\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n  owner: role,\n})\n```\n\n## Schema\n\nCreate a schema in the default database as follows:\n\n```ts\nimport { Schema } from \"cdk-rds-sql\"\n\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n})\n```\n\nOr in another database:\n\n```ts\nconst database = new Database(this, \"Database\", {\n  provider: provider,\n  databaseName: \"mydb\",\n})\n\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n  databaseName: database.databaseName,\n})\n```\n\n## Sql\n\nYou can insert arbitrary SQL into your database with the `Sql` construct:\n\n```ts\nimport { Sql } from \"cdk-rds-sql\"\n\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: \"create table t (i int)\",\n})\n```\n\nCreate a table if it does not exist, and grant a role privileges:\n\n```ts\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: `\ncreate table if not exists t (i int);\ngrant select on t to myrole;\n`,\n})\n```\n\nRollback sql on stack deletion:\n\n```ts\nconst sql = new Sql(this, \"Sql\", {\n  provider: provider,\n  database: database,\n  statement: `\ncreate table if not exists t (i int);\ngrant select on t to myrole;\n`,\n  rollback: `\nDO $$BEGIN\n  IF EXISTS (select from pg_database WHERE datname = 't') THEN\n    IF EXISTS (select from pg_catalog.pg_roles WHERE rolname = 'myrole') THEN\n      revoke select t from myrole;\n    END IF;\n    drop table t;\n  END IF;\nEND$$;\n`\n})\n```\n\n\nNote that there is no synchronisation between various `Sql`\nconstructs, in particular the order in your code does not determine\nthe order in which your SQL is executed. This happens in parallel,\nunless you specify an explicit dependency via `sql.node.addDepency()`.\n\nThere are a lot of concerns when using `Sql`:\n\n- When you update your Sql, your previous Sql is not \"rolled back\",\n  the new Sql is simply executed again.\n- When you delete your `Sql` construct the rollback is executed if specified\n- When permission are granted via `Sql` they must be removed via rollback to succesfully remove the role\n- Currently the `Sql` constructs has less than 5 minutes to execute\n  its work.\n- It is unknown how large your SQL can be.\n\n## Dependencies\n\nThis library manages dependencies, there is no need to specify\ndependencies except possibly for `Sql` constructs.\n\n# Working on this code\n\nThis code is managed by\n[projen](https://github.com/projen/projen/blob/main/README.md). In\naddition [pre-commit](https://pre-commit.com/) is used.\n\nSo after git clone and `npm ci` you would do:\n\n```\npre-commit install --install-hooks --hook-type commit-msg --hook-type pre-commit\n```\n\nto install the pre-commit hooks.\n\n## Testing\n\nTest code via projen with:\n\n    npx projen test\n\nYou can run the sample stack with:\n\n    npx cdk deploy --context vpc-id=vpc-0123456789 TestServerlessV1Stack\n\nOr for v2:\n\n    npx cdk deploy TestServerlessV2Stack\n\nIf you want to use an existing vpc:\n\n    npx cdk deploy --context vpc-id=vpc-0123456789 TestServerlessV2Stack\n\n# To do\n\n- Update role: will not revoke connect to previous database if database name has changed.\n- If the cluster is configured for autopausing, wake cluster up before doing any SQL operations.\n- We rename roles and database on update: is that actually the best\n  thing? More change to get us into an irrecoverable situation??\n"
   },
   "repository": {
     "type": "git",
@@ -3917,7 +4008,7 @@
         },
         "locationInModule": {
           "filename": "src/provider.ts",
-          "line": 74
+          "line": 78
         },
         "parameters": [
           {
@@ -3943,7 +4034,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/provider.ts",
-        "line": 68
+        "line": 72
       },
       "methods": [
         {
@@ -3952,7 +4043,7 @@
           },
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 104
+            "line": 108
           },
           "name": "newCustomResourceHandler",
           "parameters": [
@@ -3992,7 +4083,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 72
+            "line": 76
           },
           "name": "cluster",
           "type": {
@@ -4001,6 +4092,9 @@
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
                 },
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
+                },
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IServerlessCluster"
                 }
@@ -4015,7 +4109,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 71
+            "line": 75
           },
           "name": "handler",
           "type": {
@@ -4029,7 +4123,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 70
+            "line": 74
           },
           "name": "secret",
           "type": {
@@ -4043,7 +4137,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 69
+            "line": 73
           },
           "name": "serviceToken",
           "type": {
@@ -4063,7 +4157,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/provider.ts",
-        "line": 13
+        "line": 17
       },
       "name": "RdsSqlProps",
       "properties": [
@@ -4076,7 +4170,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 33
+            "line": 37
           },
           "name": "cluster",
           "type": {
@@ -4085,6 +4179,9 @@
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
                 },
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
+                },
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IServerlessCluster"
                 }
@@ -4102,7 +4199,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 40
+            "line": 44
           },
           "name": "secret",
           "type": {
@@ -4120,7 +4217,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 21
+            "line": 25
           },
           "name": "vpc",
           "type": {
@@ -4138,7 +4235,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 65
+            "line": 69
           },
           "name": "functionProps",
           "optional": true,
@@ -4157,7 +4254,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 54
+            "line": 58
           },
           "name": "logger",
           "optional": true,
@@ -4175,7 +4272,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 47
+            "line": 51
           },
           "name": "timeout",
           "optional": true,
@@ -4193,7 +4290,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 28
+            "line": 32
           },
           "name": "vpcSubnets",
           "optional": true,
@@ -4257,7 +4354,7 @@
         },
         "locationInModule": {
           "filename": "src/role.ts",
-          "line": 68
+          "line": 69
         },
         "parameters": [
           {
@@ -4283,7 +4380,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 57
+        "line": 58
       },
       "name": "Role",
       "properties": [
@@ -4295,7 +4392,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 61
+            "line": 62
           },
           "name": "roleName",
           "type": {
@@ -4310,7 +4407,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 66
+            "line": 67
           },
           "name": "secret",
           "type": {
@@ -4330,7 +4427,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 9
+        "line": 10
       },
       "name": "RoleProps",
       "properties": [
@@ -4343,7 +4440,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 13
+            "line": 14
           },
           "name": "provider",
           "type": {
@@ -4359,7 +4456,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 18
+            "line": 19
           },
           "name": "roleName",
           "type": {
@@ -4377,7 +4474,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 29
+            "line": 30
           },
           "name": "database",
           "optional": true,
@@ -4396,7 +4493,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 40
+            "line": 41
           },
           "name": "databaseName",
           "optional": true,
@@ -4414,7 +4511,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 47
+            "line": 48
           },
           "name": "encryptionKey",
           "optional": true,
@@ -4432,7 +4529,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 54
+            "line": 55
           },
           "name": "secretName",
           "optional": true,
@@ -4700,6 +4797,6 @@
       "symbolId": "src/sql:SqlProps"
     }
   },
-  "version": "3.3.0",
-  "fingerprint": "CaRJUZ8xZGDl1EEhd9DRLPBws0WxsrfKfee2ShSxKbA="
+  "version": "3.4.1",
+  "fingerprint": "SR2830B6Ok7qbtdRE5HnjDtDRYf6EhHxm4VEQPV9aUc="
 }

package/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_language_version:
 fail_fast: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.6.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer

package/README.md

@@ -1,8 +1,8 @@
 # About
 
 This CDK construct library makes it possible to create databases,
-schemas, and roles in an Aurora Serverless or database cluster created
-in that stack. Both Aurora Serverless v1 and v2 are supported.
+schemas, and roles in an Aurora Serverless (v1 and v2 are supported), RDS Database Cluster or Database Instance created
+in that stack.
 
 This construct library is intended to be used in enterprise
 environments, and works in isolated subnets.
@@ -55,7 +55,7 @@ const cluster = new rds.ServerlessCluster(this, "Cluster", {
 })
 ```
 
-Then create a provider which will connect to your database:
+Then create a provider which will connect to your database. For a cluster:
 
 ```ts
 import { Provider } from "cdk-rds-sql"
@@ -67,6 +67,17 @@ const provider = new Provider(this, "Provider", {
 })
 ```
 
+For an instance:
+```ts
+import { Provider } from "cdk-rds-sql"
+
+const provider = new Provider(this, "Provider", {
+  vpc: vpc,
+  instance: instance,
+  secret: cluster.secret!,
+})
+```
+
 The provider will setup a lambda, which normally lives in the same VPC
 as the database. You can give a different VPC, as long as that VPC has
 access to the VPC of the database. Only the provider lambda will talk
@@ -98,7 +109,7 @@ const provider = new Provider(this, "Provider", {
 
 ## Roles
 
-Create a postgres role (user) as follows:
+Create a postgres role (user) for a cluster as follows:
 
 ```ts
 import { Role } from "cdk-rds-sql"

package/lib/database.js

@@ -40,5 +40,5 @@ class Database extends aws_cdk_lib_1.CustomResource {
 }
 exports.Database = Database;
 _a = JSII_RTTI_SYMBOL_1;
-Database[_a] = { fqn: "cdk-rds-sql.Database", version: "3.3.0" };
+Database[_a] = { fqn: "cdk-rds-sql.Database", version: "3.4.1" };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YWJhc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZGF0YWJhc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw2Q0FBNEM7QUFDNUMsMkNBQXNDO0FBQ3RDLGlDQUF1QztBQTJCdkMsTUFBTSxnQkFBaUIsU0FBUSxzQkFBUztJQUd0QyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLEtBQXlCO1FBQ2pFLEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUE7UUFDaEIsSUFBSSxDQUFDLFlBQVksR0FBRyxLQUFLLENBQUMsWUFBWSxDQUFBO0lBQ3hDLENBQUM7Q0FDRjtBQUVELE1BQWEsUUFBUyxTQUFRLDRCQUFjO0lBWTFDLFlBQVksS0FBZ0IsRUFBRSxFQUFVLEVBQUUsS0FBb0I7UUFDNUQsS0FBSyxDQUFDLEtBQUssRUFBRSxFQUFFLEVBQUU7WUFDZixZQUFZLEVBQUUsS0FBSyxDQUFDLFFBQVEsQ0FBQyxZQUFZO1lBQ3pDLFVBQVUsRUFBRTtnQkFDVixRQUFRLEVBQUUscUJBQWMsQ0FBQyxRQUFRO2dCQUNqQyxVQUFVLEVBQUUsS0FBSyxDQUFDLFlBQVk7Z0JBQzlCLFNBQVMsRUFBRSxLQUFLLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxTQUFTO2dCQUMxQyxLQUFLLEVBQUUsS0FBSyxDQUFDLEtBQUssRUFBRSxRQUFRO2FBQzdCO1NBQ0YsQ0FBQyxDQUFBO1FBQ0YsSUFBSSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFBO1FBQ3ZDLElBQUksQ0FBQyxZQUFZLEdBQUcsS0FBSyxDQUFDLFlBQVksQ0FBQTtRQUN0QyxJQUFJLEtBQUssQ0FBQyxLQUFLLEVBQUU7WUFDZixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUE7U0FDckM7SUFDSCxDQUFDO0lBMUJEOztPQUVHO0lBQ0gsTUFBTSxDQUFDLGdCQUFnQixDQUFDLEtBQWdCLEVBQUUsRUFBVSxFQUFFLFlBQW9CO1FBQ3hFLE9BQU8sSUFBSSxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFO1lBQ3JDLFlBQVksRUFBRSxZQUFZO1NBQzNCLENBQUMsQ0FBQTtJQUNKLENBQUM7O0FBUkgsNEJBNEJDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ3VzdG9tUmVzb3VyY2UgfSBmcm9tIFwiYXdzLWNkay1saWJcIlxuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSBcImNvbnN0cnVjdHNcIlxuaW1wb3J0IHsgUmRzU3FsUmVzb3VyY2UgfSBmcm9tIFwiLi9lbnVtXCJcbmltcG9ydCB7IFByb3ZpZGVyIH0gZnJvbSBcIi4vcHJvdmlkZXJcIlxuaW1wb3J0IHsgUm9sZSB9IGZyb20gXCIuL3JvbGVcIlxuXG5pbnRlcmZhY2UgRGF0YWJhc2VBdHRyaWJ1dGVzIHtcbiAgLyoqXG4gICAqIE5hbWUgb2YgZGF0YWJhc2UgdG8gY3JlYXRlLlxuICAgKi9cbiAgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcblxuICAvKipcbiAgICogT3B0aW9uYWwgZGF0YWJhc2Ugb3duZXIuXG4gICAqL1xuICByZWFkb25seSBvd25lcj86IFJvbGVcbn1cblxuZXhwb3J0IGludGVyZmFjZSBEYXRhYmFzZVByb3BzIGV4dGVuZHMgRGF0YWJhc2VBdHRyaWJ1dGVzIHtcbiAgLyoqXG4gICAqIFByb3ZpZGVyLlxuICAgKi9cbiAgcmVhZG9ubHkgcHJvdmlkZXI6IFByb3ZpZGVyXG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgSURhdGFiYXNlIHtcbiAgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcbn1cblxuY2xhc3MgSW1wb3J0ZWREYXRhYmFzZSBleHRlbmRzIENvbnN0cnVjdCBpbXBsZW1lbnRzIElEYXRhYmFzZSB7XG4gIHB1YmxpYyByZWFkb25seSBkYXRhYmFzZU5hbWU6IHN0cmluZ1xuXG4gIGNvbnN0cnVjdG9yKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIHByb3BzOiBEYXRhYmFzZUF0dHJpYnV0ZXMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQpXG4gICAgdGhpcy5kYXRhYmFzZU5hbWUgPSBwcm9wcy5kYXRhYmFzZU5hbWVcbiAgfVxufVxuXG5leHBvcnQgY2xhc3MgRGF0YWJhc2UgZXh0ZW5kcyBDdXN0b21SZXNvdXJjZSBpbXBsZW1lbnRzIElEYXRhYmFzZSB7XG4gIC8qKlxuICAgKiBSZXR1cm4gYSBEYXRhYmFzZSBiYXNlZCB1cG9uIG5hbWUgb25seS4gVXNlIGZvciBpbXBvcnRpbmcgZXhpc3RpbmcgZGF0YWJhc2VzLlxuICAgKi9cbiAgc3RhdGljIGZyb21EYXRhYmFzZU5hbWUoc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgZGF0YWJhc2VOYW1lOiBzdHJpbmcpOiBJRGF0YWJhc2Uge1xuICAgIHJldHVybiBuZXcgSW1wb3J0ZWREYXRhYmFzZShzY29wZSwgaWQsIHtcbiAgICAgIGRhdGFiYXNlTmFtZTogZGF0YWJhc2VOYW1lLFxuICAgIH0pXG4gIH1cblxuICBwdWJsaWMgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcblxuICBjb25zdHJ1Y3RvcihzY29wZTogQ29uc3RydWN0LCBpZDogc3RyaW5nLCBwcm9wczogRGF0YWJhc2VQcm9wcykge1xuICAgIHN1cGVyKHNjb3BlLCBpZCwge1xuICAgICAgc2VydmljZVRva2VuOiBwcm9wcy5wcm92aWRlci5zZXJ2aWNlVG9rZW4sXG4gICAgICBwcm9wZXJ0aWVzOiB7XG4gICAgICAgIFJlc291cmNlOiBSZHNTcWxSZXNvdXJjZS5EQVRBQkFTRSxcbiAgICAgICAgUmVzb3VyY2VJZDogcHJvcHMuZGF0YWJhc2VOYW1lLFxuICAgICAgICBTZWNyZXRBcm46IHByb3BzLnByb3ZpZGVyLnNlY3JldC5zZWNyZXRBcm4sXG4gICAgICAgIE93bmVyOiBwcm9wcy5vd25lcj8ucm9sZU5hbWUsXG4gICAgICB9LFxuICAgIH0pXG4gICAgdGhpcy5ub2RlLmFkZERlcGVuZGVuY3kocHJvcHMucHJvdmlkZXIpXG4gICAgdGhpcy5kYXRhYmFzZU5hbWUgPSBwcm9wcy5kYXRhYmFzZU5hbWVcbiAgICBpZiAocHJvcHMub3duZXIpIHtcbiAgICAgIHRoaXMubm9kZS5hZGREZXBlbmRlbmN5KHByb3BzLm93bmVyKVxuICAgIH1cbiAgfVxufVxuIl19