cdk-rds-sql 1.0.1 → 1.1.1

package/.jsii

@@ -7,7 +7,7 @@
     ]
   },
   "bundled": {
-    "@aws-sdk/client-secrets-manager": "^3.171.0",
+    "@aws-sdk/client-secrets-manager": "^3.180.0",
     "aws-lambda": "^1.0.7",
     "ms": "^2.1.3",
     "node-pg-format": "^1.3.5",
@@ -15,7 +15,7 @@
     "source-map-support": "^0.5.21"
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.41.0",
+    "aws-cdk-lib": "^2.43.1",
     "constructs": "^10.1.104"
   },
   "dependencyClosure": {
@@ -737,6 +737,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_controltower": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AWS.ControlTower"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.controltower"
+            },
+            "python": {
+              "module": "aws_cdk.aws_controltower"
+            }
+          }
+        },
         "aws-cdk-lib.aws_cur": {
           "targets": {
             "dotnet": {
@@ -1855,6 +1868,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_m2": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AWS.M2"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.m2"
+            },
+            "python": {
+              "module": "aws_cdk.aws_m2"
+            }
+          }
+        },
         "aws-cdk-lib.aws_macie": {
           "targets": {
             "dotnet": {
@@ -2713,6 +2739,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_supportapp": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AWS.SupportApp"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.supportapp"
+            },
+            "python": {
+              "module": "aws_cdk.aws_supportapp"
+            }
+          }
+        },
         "aws-cdk-lib.aws_synthetics": {
           "targets": {
             "dotnet": {
@@ -3031,7 +3070,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/berenddeboer/cdk-rds-sql.git",
-  "jsiiVersion": "1.67.0 (build 2c027f5)",
+  "jsiiVersion": "1.69.0 (build f656c31)",
   "keywords": [
     "aurora",
     "aws",
@@ -3050,7 +3089,7 @@
   },
   "name": "cdk-rds-sql",
   "readme": {
-    "markdown": "# About\n\nThis CDK construct library makes it possible create databases,\nschemas, and roles to an Aurora Serverless database created in that\nstack.\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-postgresql10\"\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 will live in the same VPC, or\nat minimum in a VPC that can get access to the database. The provider\nwill automatically setup a connection to the given cluster.\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  cluster: cluster,\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\n## Database\n\nCreate a datdabse 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  databaseName: database.databaseName,\n  statement: \"create table t (i int)\",\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- The same when you delete your `Sql` construct: nothing is rolled\n  back in the database.\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 synth --context vpc-id=vpc-0123456789\n\n# To do\n\n- Add `.from()` functions to make everything more type-safe, and make\n  it impossible to import database from other stacks or created\n  outside the stack.\n"
+    "markdown": "# About\n\nThis CDK construct library makes it possible create databases,\nschemas, and roles to an Aurora Serverless database created in that\nstack.\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-postgresql10\"\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 will live in the same VPC, or\nat minimum in a VPC that can get access to the database. The provider\nwill automatically setup a connection to the given cluster.\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  cluster: cluster,\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\n## Database\n\nCreate a datdabse 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\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- The same when you delete your `Sql` construct: nothing is rolled\n  back in the database.\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\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",
@@ -3076,7 +3115,7 @@
         },
         "locationInModule": {
           "filename": "src/database.ts",
-          "line": 27
+          "line": 51
         },
         "parameters": [
           {
@@ -3099,11 +3138,54 @@
           }
         ]
       },
+      "interfaces": [
+        "cdk-rds-sql.IDatabase"
+      ],
       "kind": "class",
       "locationInModule": {
         "filename": "src/database.ts",
-        "line": 24
+        "line": 39
       },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "Use for importing existing databases.",
+            "stability": "stable",
+            "summary": "Return a Database based upon name only."
+          },
+          "locationInModule": {
+            "filename": "src/database.ts",
+            "line": 43
+          },
+          "name": "fromDatabaseName",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "databaseName",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk-rds-sql.IDatabase"
+            }
+          },
+          "static": true
+        }
+      ],
       "name": "Database",
       "properties": [
         {
@@ -3113,9 +3195,10 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 25
+            "line": 49
           },
           "name": "databaseName",
+          "overrides": "cdk-rds-sql.IDatabase",
           "type": {
             "primitive": "string"
           }
@@ -3133,7 +3216,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/database.ts",
-        "line": 7
+        "line": 19
       },
       "name": "DatabaseProps",
       "properties": [
@@ -3146,7 +3229,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 16
+            "line": 11
           },
           "name": "databaseName",
           "type": {
@@ -3162,7 +3245,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 11
+            "line": 23
           },
           "name": "provider",
           "type": {
@@ -3178,7 +3261,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 21
+            "line": 16
           },
           "name": "owner",
           "optional": true,
@@ -3189,6 +3272,37 @@
       ],
       "symbolId": "src/database:DatabaseProps"
     },
+    "cdk-rds-sql.IDatabase": {
+      "assembly": "cdk-rds-sql",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk-rds-sql.IDatabase",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/database.ts",
+        "line": 26
+      },
+      "name": "IDatabase",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/database.ts",
+            "line": 27
+          },
+          "name": "databaseName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/database:IDatabase"
+    },
     "cdk-rds-sql.Provider": {
       "assembly": "cdk-rds-sql",
       "base": "constructs.Construct",
@@ -3430,7 +3544,7 @@
         },
         "locationInModule": {
           "filename": "src/role.ts",
-          "line": 49
+          "line": 52
         },
         "parameters": [
           {
@@ -3456,7 +3570,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 38
+        "line": 41
       },
       "name": "Role",
       "properties": [
@@ -3468,7 +3582,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 42
+            "line": 45
           },
           "name": "roleName",
           "type": {
@@ -3483,7 +3597,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 47
+            "line": 50
           },
           "name": "secret",
           "type": {
@@ -3503,7 +3617,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 9
+        "line": 10
       },
       "name": "RoleProps",
       "properties": [
@@ -3516,7 +3630,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 28
+            "line": 31
           },
           "name": "cluster",
           "type": {
@@ -3527,48 +3641,50 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "Database name this user is expected to use."
+            "summary": "Provider."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 23
+            "line": 14
           },
-          "name": "databaseName",
+          "name": "provider",
           "type": {
-            "primitive": "string"
+            "fqn": "cdk-rds-sql.Provider"
           }
         },
         {
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "Provider."
+            "summary": "SQL."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 13
+            "line": 19
           },
-          "name": "provider",
+          "name": "roleName",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
+            "default": "no connection to any database is granted",
             "stability": "stable",
-            "summary": "SQL."
+            "summary": "Ootional database name this user is expected to use."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 18
+            "line": 26
           },
-          "name": "roleName",
+          "name": "database",
+          "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "cdk-rds-sql.IDatabase"
           }
         },
         {
@@ -3581,7 +3697,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 35
+            "line": 38
           },
           "name": "encryptionKey",
           "optional": true,
@@ -3605,7 +3721,7 @@
         },
         "locationInModule": {
           "filename": "src/schema.ts",
-          "line": 28
+          "line": 29
         },
         "parameters": [
           {
@@ -3631,7 +3747,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/schema.ts",
-        "line": 25
+        "line": 26
       },
       "name": "Schema",
       "properties": [
@@ -3642,7 +3758,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/schema.ts",
-            "line": 26
+            "line": 27
           },
           "name": "schemaName",
           "type": {
@@ -3662,7 +3778,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/schema.ts",
-        "line": 6
+        "line": 7
       },
       "name": "SchemaProps",
       "properties": [
@@ -3675,7 +3791,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/schema.ts",
-            "line": 10
+            "line": 11
           },
           "name": "provider",
           "type": {
@@ -3691,7 +3807,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/schema.ts",
-            "line": 22
+            "line": 23
           },
           "name": "schemaName",
           "type": {
@@ -3708,12 +3824,12 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/schema.ts",
-            "line": 17
+            "line": 18
           },
-          "name": "databaseName",
+          "name": "database",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "cdk-rds-sql.IDatabase"
           }
         }
       ],
@@ -3732,7 +3848,7 @@
         },
         "locationInModule": {
           "filename": "src/sql.ts",
-          "line": 26
+          "line": 27
         },
         "parameters": [
           {
@@ -3758,7 +3874,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/sql.ts",
-        "line": 25
+        "line": 26
       },
       "name": "Sql",
       "symbolId": "src/sql:Sql"
@@ -3773,7 +3889,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/sql.ts",
-        "line": 6
+        "line": 7
       },
       "name": "SqlProps",
       "properties": [
@@ -3786,7 +3902,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/sql.ts",
-            "line": 10
+            "line": 11
           },
           "name": "provider",
           "type": {
@@ -3803,12 +3919,12 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/sql.ts",
-            "line": 17
+            "line": 18
           },
-          "name": "databaseName",
+          "name": "database",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "cdk-rds-sql.IDatabase"
           }
         },
         {
@@ -3820,7 +3936,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/sql.ts",
-            "line": 22
+            "line": 23
           },
           "name": "statement",
           "optional": true,
@@ -3832,6 +3948,6 @@
       "symbolId": "src/sql:SqlProps"
     }
   },
-  "version": "1.0.1",
-  "fingerprint": "xd5l5D0F3gWHGA/dNvWEpl0VUfEOIuy/cCZzbFG1m9Y="
+  "version": "1.1.1",
+  "fingerprint": "10S8iJf38MZT3c0zV9U9P1Tf+WfVXvVT2ZGFz3O3/+w="
 }

package/.pre-commit-config.yaml

@@ -40,8 +40,8 @@ repos:
       - id: synth
         name: synth
         language: system
-        entry: sh -c 'npx cdk synth --quiet'
-        files: (bin|src)/.*\.ts$
+        entry: sh -c 'npx cdk synth --quiet --context vpc-id=$VPC_ID'
+        files: src/.*\.ts$
   - repo: local
     hooks:
       - id: compile-project

package/.projenrc.ts

@@ -13,7 +13,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
   repositoryUrl: "https://github.com/berenddeboer/cdk-rds-sql.git",
   projenrcTs: true,
   constructsVersion: "10.1.104",
-  cdkVersion: "2.41.0",
+  cdkVersion: "2.43.1",
   disableTsconfig: true,
   tsconfigDev: {
     compilerOptions: {

package/README.md

@@ -164,7 +164,7 @@ import { Sql } from "cdk-rds-sql"
 
 const sql = new Sql(this, "Sql", {
   provider: provider,
-  databaseName: database.databaseName,
+  database: database,
   statement: "create table t (i int)",
 })
 ```
@@ -211,10 +211,11 @@ Test code via projen with:
 
 You can run the sample stack with:
 
-    npx cdk synth --context vpc-id=vpc-0123456789
+    npx cdk deploy --context vpc-id=vpc-0123456789
 
 # To do
 
-- Add `.from()` functions to make everything more type-safe, and make
-  it impossible to import database from other stacks or created
-  outside the stack.
+- Update role: will not revoke connect to previous database if database name has changed.
+- If the cluster is configured for autopausing, wake cluster up before doing any SQL operations.
+- We rename roles and database on update: is that actually the best
+  thing? More change to get us into an irrecoverable situation??

package/cdk.json

@@ -22,7 +22,6 @@
     "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
     "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
     "@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
-    "@aws-cdk/core:target-partitions": ["aws", "aws-cn"],
-    "vpc-id": "vpc-0f42b9b4c9c371d3f"
+    "@aws-cdk/core:target-partitions": ["aws", "aws-cn"]
   }
 }

package/lib/database.d.ts

@@ -2,11 +2,7 @@ import { CustomResource } from "aws-cdk-lib";
 import { Construct } from "constructs";
 import { Provider } from "./provider";
 import { Role } from "./role";
-export interface DatabaseProps {
-    /**
-     * Provider.
-     */
-    readonly provider: Provider;
+interface DatabaseAttributes {
     /**
      * Name of database to create.
      */
@@ -16,7 +12,21 @@ export interface DatabaseProps {
      */
     readonly owner?: Role;
 }
-export declare class Database extends CustomResource {
+export interface DatabaseProps extends DatabaseAttributes {
+    /**
+     * Provider.
+     */
+    readonly provider: Provider;
+}
+export interface IDatabase {
+    readonly databaseName: string;
+}
+export declare class Database extends CustomResource implements IDatabase {
+    /**
+     * Return a Database based upon name only. Use for importing existing databases.
+     */
+    static fromDatabaseName(scope: Construct, id: string, databaseName: string): IDatabase;
     readonly databaseName: string;
     constructor(scope: Construct, id: string, props: DatabaseProps);
 }
+export {};

package/lib/database.js

@@ -4,7 +4,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Database = void 0;
 const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
 const aws_cdk_lib_1 = require("aws-cdk-lib");
+const constructs_1 = require("constructs");
 const enum_1 = require("./enum");
+class ImportedDatabase extends constructs_1.Construct {
+    constructor(scope, id, props) {
+        super(scope, id);
+        this.databaseName = props.databaseName;
+    }
+}
 class Database extends aws_cdk_lib_1.CustomResource {
     constructor(scope, id, props) {
         super(scope, id, {
@@ -22,8 +29,16 @@ class Database extends aws_cdk_lib_1.CustomResource {
             this.node.addDependency(props.owner);
         }
     }
+    /**
+     * Return a Database based upon name only. Use for importing existing databases.
+     */
+    static fromDatabaseName(scope, id, databaseName) {
+        return new ImportedDatabase(scope, id, {
+            databaseName: databaseName,
+        });
+    }
 }
 exports.Database = Database;
 _a = JSII_RTTI_SYMBOL_1;
-Database[_a] = { fqn: "cdk-rds-sql.Database", version: "1.0.1" };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YWJhc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZGF0YWJhc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw2Q0FBNEM7QUFFNUMsaUNBQXVDO0FBcUJ2QyxNQUFhLFFBQVMsU0FBUSw0QkFBYztJQUcxQyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLEtBQW9CO1FBQzVELEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFO1lBQ2YsWUFBWSxFQUFFLEtBQUssQ0FBQyxRQUFRLENBQUMsWUFBWTtZQUN6QyxVQUFVLEVBQUU7Z0JBQ1YsUUFBUSxFQUFFLHFCQUFjLENBQUMsUUFBUTtnQkFDakMsVUFBVSxFQUFFLEtBQUssQ0FBQyxZQUFZO2dCQUM5QixTQUFTLEVBQUUsS0FBSyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsU0FBUztnQkFDMUMsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLLEVBQUUsUUFBUTthQUM3QjtTQUNGLENBQUMsQ0FBQTtRQUNGLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUN2QyxJQUFJLENBQUMsWUFBWSxHQUFHLEtBQUssQ0FBQyxZQUFZLENBQUE7UUFDdEMsSUFBSSxLQUFLLENBQUMsS0FBSyxFQUFFO1lBQ2YsSUFBSSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFBO1NBQ3JDO0lBQ0gsQ0FBQzs7QUFsQkgsNEJBbUJDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ3VzdG9tUmVzb3VyY2UgfSBmcm9tIFwiYXdzLWNkay1saWJcIlxuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSBcImNvbnN0cnVjdHNcIlxuaW1wb3J0IHsgUmRzU3FsUmVzb3VyY2UgfSBmcm9tIFwiLi9lbnVtXCJcbmltcG9ydCB7IFByb3ZpZGVyIH0gZnJvbSBcIi4vcHJvdmlkZXJcIlxuaW1wb3J0IHsgUm9sZSB9IGZyb20gXCIuL3JvbGVcIlxuXG5leHBvcnQgaW50ZXJmYWNlIERhdGFiYXNlUHJvcHMge1xuICAvKipcbiAgICogUHJvdmlkZXIuXG4gICAqL1xuICByZWFkb25seSBwcm92aWRlcjogUHJvdmlkZXJcblxuICAvKipcbiAgICogTmFtZSBvZiBkYXRhYmFzZSB0byBjcmVhdGUuXG4gICAqL1xuICByZWFkb25seSBkYXRhYmFzZU5hbWU6IHN0cmluZ1xuXG4gIC8qKlxuICAgKiBPcHRpb25hbCBkYXRhYmFzZSBvd25lci5cbiAgICovXG4gIHJlYWRvbmx5IG93bmVyPzogUm9sZVxufVxuXG5leHBvcnQgY2xhc3MgRGF0YWJhc2UgZXh0ZW5kcyBDdXN0b21SZXNvdXJjZSB7XG4gIHB1YmxpYyByZWFkb25seSBkYXRhYmFzZU5hbWU6IHN0cmluZ1xuXG4gIGNvbnN0cnVjdG9yKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIHByb3BzOiBEYXRhYmFzZVByb3BzKSB7XG4gICAgc3VwZXIoc2NvcGUsIGlkLCB7XG4gICAgICBzZXJ2aWNlVG9rZW46IHByb3BzLnByb3ZpZGVyLnNlcnZpY2VUb2tlbixcbiAgICAgIHByb3BlcnRpZXM6IHtcbiAgICAgICAgUmVzb3VyY2U6IFJkc1NxbFJlc291cmNlLkRBVEFCQVNFLFxuICAgICAgICBSZXNvdXJjZUlkOiBwcm9wcy5kYXRhYmFzZU5hbWUsXG4gICAgICAgIFNlY3JldEFybjogcHJvcHMucHJvdmlkZXIuc2VjcmV0LnNlY3JldEFybixcbiAgICAgICAgT3duZXI6IHByb3BzLm93bmVyPy5yb2xlTmFtZSxcbiAgICAgIH0sXG4gICAgfSlcbiAgICB0aGlzLm5vZGUuYWRkRGVwZW5kZW5jeShwcm9wcy5wcm92aWRlcilcbiAgICB0aGlzLmRhdGFiYXNlTmFtZSA9IHByb3BzLmRhdGFiYXNlTmFtZVxuICAgIGlmIChwcm9wcy5vd25lcikge1xuICAgICAgdGhpcy5ub2RlLmFkZERlcGVuZGVuY3kocHJvcHMub3duZXIpXG4gICAgfVxuICB9XG59XG4iXX0=
+Database[_a] = { fqn: "cdk-rds-sql.Database", version: "1.1.1" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0YWJhc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvZGF0YWJhc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw2Q0FBNEM7QUFDNUMsMkNBQXNDO0FBQ3RDLGlDQUF1QztBQTJCdkMsTUFBTSxnQkFBaUIsU0FBUSxzQkFBUztJQUd0QyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLEtBQXlCO1FBQ2pFLEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUE7UUFDaEIsSUFBSSxDQUFDLFlBQVksR0FBRyxLQUFLLENBQUMsWUFBWSxDQUFBO0lBQ3hDLENBQUM7Q0FDRjtBQUVELE1BQWEsUUFBUyxTQUFRLDRCQUFjO0lBWTFDLFlBQVksS0FBZ0IsRUFBRSxFQUFVLEVBQUUsS0FBb0I7UUFDNUQsS0FBSyxDQUFDLEtBQUssRUFBRSxFQUFFLEVBQUU7WUFDZixZQUFZLEVBQUUsS0FBSyxDQUFDLFFBQVEsQ0FBQyxZQUFZO1lBQ3pDLFVBQVUsRUFBRTtnQkFDVixRQUFRLEVBQUUscUJBQWMsQ0FBQyxRQUFRO2dCQUNqQyxVQUFVLEVBQUUsS0FBSyxDQUFDLFlBQVk7Z0JBQzlCLFNBQVMsRUFBRSxLQUFLLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxTQUFTO2dCQUMxQyxLQUFLLEVBQUUsS0FBSyxDQUFDLEtBQUssRUFBRSxRQUFRO2FBQzdCO1NBQ0YsQ0FBQyxDQUFBO1FBQ0YsSUFBSSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxDQUFBO1FBQ3ZDLElBQUksQ0FBQyxZQUFZLEdBQUcsS0FBSyxDQUFDLFlBQVksQ0FBQTtRQUN0QyxJQUFJLEtBQUssQ0FBQyxLQUFLLEVBQUU7WUFDZixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUE7U0FDckM7SUFDSCxDQUFDO0lBMUJEOztPQUVHO0lBQ0gsTUFBTSxDQUFDLGdCQUFnQixDQUFDLEtBQWdCLEVBQUUsRUFBVSxFQUFFLFlBQW9CO1FBQ3hFLE9BQU8sSUFBSSxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFO1lBQ3JDLFlBQVksRUFBRSxZQUFZO1NBQzNCLENBQUMsQ0FBQTtJQUNKLENBQUM7O0FBUkgsNEJBNEJDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ3VzdG9tUmVzb3VyY2UgfSBmcm9tIFwiYXdzLWNkay1saWJcIlxuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSBcImNvbnN0cnVjdHNcIlxuaW1wb3J0IHsgUmRzU3FsUmVzb3VyY2UgfSBmcm9tIFwiLi9lbnVtXCJcbmltcG9ydCB7IFByb3ZpZGVyIH0gZnJvbSBcIi4vcHJvdmlkZXJcIlxuaW1wb3J0IHsgUm9sZSB9IGZyb20gXCIuL3JvbGVcIlxuXG5pbnRlcmZhY2UgRGF0YWJhc2VBdHRyaWJ1dGVzIHtcbiAgLyoqXG4gICAqIE5hbWUgb2YgZGF0YWJhc2UgdG8gY3JlYXRlLlxuICAgKi9cbiAgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcblxuICAvKipcbiAgICogT3B0aW9uYWwgZGF0YWJhc2Ugb3duZXIuXG4gICAqL1xuICByZWFkb25seSBvd25lcj86IFJvbGVcbn1cblxuZXhwb3J0IGludGVyZmFjZSBEYXRhYmFzZVByb3BzIGV4dGVuZHMgRGF0YWJhc2VBdHRyaWJ1dGVzIHtcbiAgLyoqXG4gICAqIFByb3ZpZGVyLlxuICAgKi9cbiAgcmVhZG9ubHkgcHJvdmlkZXI6IFByb3ZpZGVyXG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgSURhdGFiYXNlIHtcbiAgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcbn1cblxuY2xhc3MgSW1wb3J0ZWREYXRhYmFzZSBleHRlbmRzIENvbnN0cnVjdCBpbXBsZW1lbnRzIElEYXRhYmFzZSB7XG4gIHB1YmxpYyByZWFkb25seSBkYXRhYmFzZU5hbWU6IHN0cmluZ1xuXG4gIGNvbnN0cnVjdG9yKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIHByb3BzOiBEYXRhYmFzZUF0dHJpYnV0ZXMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQpXG4gICAgdGhpcy5kYXRhYmFzZU5hbWUgPSBwcm9wcy5kYXRhYmFzZU5hbWVcbiAgfVxufVxuXG5leHBvcnQgY2xhc3MgRGF0YWJhc2UgZXh0ZW5kcyBDdXN0b21SZXNvdXJjZSBpbXBsZW1lbnRzIElEYXRhYmFzZSB7XG4gIC8qKlxuICAgKiBSZXR1cm4gYSBEYXRhYmFzZSBiYXNlZCB1cG9uIG5hbWUgb25seS4gVXNlIGZvciBpbXBvcnRpbmcgZXhpc3RpbmcgZGF0YWJhc2VzLlxuICAgKi9cbiAgc3RhdGljIGZyb21EYXRhYmFzZU5hbWUoc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgZGF0YWJhc2VOYW1lOiBzdHJpbmcpOiBJRGF0YWJhc2Uge1xuICAgIHJldHVybiBuZXcgSW1wb3J0ZWREYXRhYmFzZShzY29wZSwgaWQsIHtcbiAgICAgIGRhdGFiYXNlTmFtZTogZGF0YWJhc2VOYW1lLFxuICAgIH0pXG4gIH1cblxuICBwdWJsaWMgcmVhZG9ubHkgZGF0YWJhc2VOYW1lOiBzdHJpbmdcblxuICBjb25zdHJ1Y3RvcihzY29wZTogQ29uc3RydWN0LCBpZDogc3RyaW5nLCBwcm9wczogRGF0YWJhc2VQcm9wcykge1xuICAgIHN1cGVyKHNjb3BlLCBpZCwge1xuICAgICAgc2VydmljZVRva2VuOiBwcm9wcy5wcm92aWRlci5zZXJ2aWNlVG9rZW4sXG4gICAgICBwcm9wZXJ0aWVzOiB7XG4gICAgICAgIFJlc291cmNlOiBSZHNTcWxSZXNvdXJjZS5EQVRBQkFTRSxcbiAgICAgICAgUmVzb3VyY2VJZDogcHJvcHMuZGF0YWJhc2VOYW1lLFxuICAgICAgICBTZWNyZXRBcm46IHByb3BzLnByb3ZpZGVyLnNlY3JldC5zZWNyZXRBcm4sXG4gICAgICAgIE93bmVyOiBwcm9wcy5vd25lcj8ucm9sZU5hbWUsXG4gICAgICB9LFxuICAgIH0pXG4gICAgdGhpcy5ub2RlLmFkZERlcGVuZGVuY3kocHJvcHMucHJvdmlkZXIpXG4gICAgdGhpcy5kYXRhYmFzZU5hbWUgPSBwcm9wcy5kYXRhYmFzZU5hbWVcbiAgICBpZiAocHJvcHMub3duZXIpIHtcbiAgICAgIHRoaXMubm9kZS5hZGREZXBlbmRlbmN5KHByb3BzLm93bmVyKVxuICAgIH1cbiAgfVxufVxuIl19