cdk-rds-sql 4.1.1 → 6.0.0

package/.jsii

@@ -7,16 +7,10 @@
     ]
   },
   "bundled": {
-    "@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.13.3",
-    "source-map-support": "^0.5.21"
+    "@types/aws-lambda": "^8.10.148"
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.144.0",
+    "aws-cdk-lib": "^2.171.1",
     "constructs": "^10.3.0"
   },
   "dependencyClosure": {
@@ -98,6 +92,36 @@
         }
       }
     },
+    "@aws-cdk/cloud-assembly-schema": {
+      "targets": {
+        "dotnet": {
+          "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png",
+          "namespace": "Amazon.CDK.CloudAssembly.Schema",
+          "packageId": "Amazon.CDK.CloudAssembly.Schema"
+        },
+        "go": {
+          "moduleName": "github.com/cdklabs/cloud-assembly-schema-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "cdk-cloud-assembly-schema",
+            "groupId": "software.amazon.awscdk"
+          },
+          "package": "software.amazon.awscdk.cloudassembly.schema"
+        },
+        "js": {
+          "npm": "@aws-cdk/cloud-assembly-schema"
+        },
+        "python": {
+          "classifiers": [
+            "Framework :: AWS CDK",
+            "Framework :: AWS CDK :: 2"
+          ],
+          "distName": "aws-cdk.cloud-assembly-schema",
+          "module": "aws_cdk.cloud_assembly_schema"
+        }
+      }
+    },
     "aws-cdk-lib": {
       "submodules": {
         "aws-cdk-lib.alexa_ask": {
@@ -230,8 +254,32 @@
             }
           }
         },
-        "aws-cdk-lib.aws_apigatewayv2_authorizers": {},
-        "aws-cdk-lib.aws_apigatewayv2_integrations": {},
+        "aws-cdk-lib.aws_apigatewayv2_authorizers": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AwsApigatewayv2Authorizers"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.aws_apigatewayv2_authorizers"
+            },
+            "python": {
+              "module": "aws_cdk.aws_apigatewayv2_authorizers"
+            }
+          }
+        },
+        "aws-cdk-lib.aws_apigatewayv2_integrations": {
+          "targets": {
+            "dotnet": {
+              "namespace": "Amazon.CDK.AwsApigatewayv2Integrations"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.aws_apigatewayv2_integrations"
+            },
+            "python": {
+              "module": "aws_cdk.aws_apigatewayv2_integrations"
+            }
+          }
+        },
         "aws-cdk-lib.aws_appconfig": {
           "targets": {
             "dotnet": {
@@ -297,6 +345,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_applicationsignals": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.ApplicationSignals"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.applicationsignals"
+            },
+            "python": {
+              "module": "aws_cdk.aws_applicationsignals"
+            }
+          }
+        },
         "aws-cdk-lib.aws_appmesh": {
           "targets": {
             "dotnet": {
@@ -349,6 +410,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_apptest": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.AppTest"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.apptest"
+            },
+            "python": {
+              "module": "aws_cdk.aws_apptest"
+            }
+          }
+        },
         "aws-cdk-lib.aws_aps": {
           "targets": {
             "dotnet": {
@@ -948,6 +1022,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_connectcampaignsv2": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.ConnectCampaignsV2"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.connectcampaignsv2"
+            },
+            "python": {
+              "module": "aws_cdk.aws_connectcampaignsv2"
+            }
+          }
+        },
         "aws-cdk-lib.aws_controltower": {
           "targets": {
             "dotnet": {
@@ -2118,6 +2205,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_launchwizard": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.LaunchWizard"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.launchwizard"
+            },
+            "python": {
+              "module": "aws_cdk.aws_launchwizard"
+            }
+          }
+        },
         "aws-cdk-lib.aws_lex": {
           "targets": {
             "dotnet": {
@@ -2612,6 +2712,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_pcaconnectorscep": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.PCAConnectorSCEP"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.pcaconnectorscep"
+            },
+            "python": {
+              "module": "aws_cdk.aws_pcaconnectorscep"
+            }
+          }
+        },
         "aws-cdk-lib.aws_personalize": {
           "targets": {
             "dotnet": {
@@ -2729,6 +2842,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_rbin": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.Rbin"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.rbin"
+            },
+            "python": {
+              "module": "aws_cdk.aws_rbin"
+            }
+          }
+        },
         "aws-cdk-lib.aws_rds": {
           "targets": {
             "dotnet": {
@@ -3327,6 +3453,19 @@
             }
           }
         },
+        "aws-cdk-lib.aws_ssmquicksetup": {
+          "targets": {
+            "dotnet": {
+              "package": "Amazon.CDK.AWS.SSMQuickSetup"
+            },
+            "java": {
+              "package": "software.amazon.awscdk.services.ssmquicksetup"
+            },
+            "python": {
+              "module": "aws_cdk.aws_ssmquicksetup"
+            }
+          }
+        },
         "aws-cdk-lib.aws_sso": {
           "targets": {
             "dotnet": {
@@ -3574,19 +3713,7 @@
             }
           }
         },
-        "aws-cdk-lib.cloud_assembly_schema": {
-          "targets": {
-            "dotnet": {
-              "namespace": "Amazon.CDK.CloudAssembly.Schema"
-            },
-            "java": {
-              "package": "software.amazon.awscdk.cloudassembly.schema"
-            },
-            "python": {
-              "module": "aws_cdk.cloud_assembly_schema"
-            }
-          }
-        },
+        "aws-cdk-lib.cloud_assembly_schema": {},
         "aws-cdk-lib.cloudformation_include": {
           "targets": {
             "dotnet": {
@@ -3762,7 +3889,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/berenddeboer/cdk-rds-sql.git",
-  "jsiiVersion": "1.103.1 (build bef2dea)",
+  "jsiiVersion": "5.7.10 (build 5114b23)",
   "keywords": [
     "aurora",
     "aws",
@@ -3781,7 +3908,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 (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\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  vpcSubnets: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,\n  },\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\n### Disabling SSL\n\nThe default connection to RDS is ssl enabled (this used to be disabled\nin versions below 4).\n\nYou can disable ssl by setting the `ssl` option to `false`:\n\n```ts\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  instance: instance,\n  secret: cluster.secret!,\n  ssl: false, // default is true\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\nOne may need a role permitted for using schema:\n\n```ts\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n  databaseName: database.databaseName,\n  role: role,\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\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 v2, RDS Database Cluster or\nDatabase Instance. Both PostgreSQL and MySQL databases 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. 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\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. Your 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  vpcSubnets: {\n    subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,\n  },\n  cluster: cluster,\n  secret: cluster.secret!,\n})\n```\n\n### Disabling SSL\n\nThe default connection to RDS is ssl enabled (this used to be disabled\nin versions below 4).\n\nYou can disable ssl by setting the `ssl` option to `false`:\n\n```ts\nconst provider = new Provider(this, \"Provider\", {\n  vpc: vpc,\n  instance: instance,\n  secret: cluster.secret!,\n  ssl: false, // default is true\n})\n```\n\n## Roles\n\nCreate a postgres role (or mysql 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\nIf you want to make the role the owner of a new database, just specify\nthe `databaseName` here, and create the database later.\n\n### MySQL support\n\nIn MySQL users are created with '%' as value for the host. It is hard\nto do this better:\n\n- Determine the CIDR blocks used by a VPC is not trivial.\n- For imported VPCs you cannot specify the IPv6 CIDR.\n- CIDRs might change without the system knowing, meaning applications\n  could lose access to the database at random times, such as when a\n  container is restarted.\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\nOne may need a role permitted for using schema:\n\n```ts\nnew Schema(this, \"Schema\", {\n  provider: provider,\n  schemaName: \"myschema\",\n  databaseName: database.databaseName,\n  role: role,\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\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# Parameters\n\nSome lambda constructs, in particular [Bref](https://bref.sh/), do not\nsupport secrets out of the box. This construct allows you to create\nSSM parameters in addition to a secret:\n\n```ts\nconst role = new Role(this, \"Role\", {\n  provider: provider,\n  roleName: \"myrole\",\n  databaseName: \"mydb\",\n  parameterPrefix: \"/my-app/\",\n})\n```\n\nThis will create `/my-app/username`, `/my-app/password` and such.\n\nTo access parameters you will need IAM permissions such as:\n\n```ts\ninitialPolicy: [\n  new iam.PolicyStatement({\n\tactions: [\"ssm:GetParameter\", \"ssm:GetParameters\"],\n\tresources: [\n\t  // Grant access to all parameters under the base path\n\t  `arn:aws:ssm:${this.region}:${this.account}:parameter/my-app/*`,\n\t],\n\teffect: iam.Effect.ALLOW,\n  })\n],\n```\n\nNote that your VPC will need an SSM Parameters interface endpoint to support this.\n\n# IPv6\n\nIf you use the provider in an IPv6 subnet you probably need these settings:\n\n```ts\nimport { Provider } from \"cdk-rds-sql\"\n\nconst provider = new Provider(this, \"Provider\", {\n  ...\n  functionProps: {\n\tipv6AllowedForDualStack: true,\n\tallowAllIpv6Outbound: true,\n  },\n}\n```\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 projen integ:deploy:serverless\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",
@@ -4008,7 +4135,7 @@
         },
         "locationInModule": {
           "filename": "src/provider.ts",
-          "line": 85
+          "line": 89
         },
         "parameters": [
           {
@@ -4034,7 +4161,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/provider.ts",
-        "line": 79
+        "line": 76
       },
       "methods": [
         {
@@ -4043,7 +4170,7 @@
           },
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 115
+            "line": 134
           },
           "name": "newCustomResourceHandler",
           "parameters": [
@@ -4083,7 +4210,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 83
+            "line": 80
           },
           "name": "cluster",
           "type": {
@@ -4094,14 +4221,27 @@
                 },
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
-                },
-                {
-                  "fqn": "aws-cdk-lib.aws_rds.IServerlessCluster"
                 }
               ]
             }
           }
         },
+        {
+          "docs": {
+            "default": "- if we cannot determine this \"postgres\"",
+            "stability": "stable",
+            "summary": "The engine like \"postgres\" or \"mysql\"."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 87
+          },
+          "name": "engine",
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "docs": {
             "stability": "stable"
@@ -4109,7 +4249,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 82
+            "line": 79
           },
           "name": "handler",
           "type": {
@@ -4123,7 +4263,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 81
+            "line": 78
           },
           "name": "secret",
           "type": {
@@ -4137,7 +4277,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 80
+            "line": 77
           },
           "name": "serviceToken",
           "type": {
@@ -4157,7 +4297,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/provider.ts",
-        "line": 17
+        "line": 14
       },
       "name": "RdsSqlProps",
       "properties": [
@@ -4170,7 +4310,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 37
+            "line": 34
           },
           "name": "cluster",
           "type": {
@@ -4181,9 +4321,6 @@
                 },
                 {
                   "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
-                },
-                {
-                  "fqn": "aws-cdk-lib.aws_rds.IServerlessCluster"
                 }
               ]
             }
@@ -4199,7 +4336,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 44
+            "line": 41
           },
           "name": "secret",
           "type": {
@@ -4217,7 +4354,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 25
+            "line": 22
           },
           "name": "vpc",
           "type": {
@@ -4235,7 +4372,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 69
+            "line": 66
           },
           "name": "functionProps",
           "optional": true,
@@ -4254,7 +4391,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 58
+            "line": 55
           },
           "name": "logger",
           "optional": true,
@@ -4272,7 +4409,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 76
+            "line": 73
           },
           "name": "ssl",
           "optional": true,
@@ -4290,7 +4427,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 51
+            "line": 48
           },
           "name": "timeout",
           "optional": true,
@@ -4308,7 +4445,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 32
+            "line": 29
           },
           "name": "vpcSubnets",
           "optional": true,
@@ -4354,6 +4491,12 @@
             "stability": "stable"
           },
           "name": "DATABASE"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "PARAMETER_PASSWORD"
         }
       ],
       "name": "RdsSqlResource",
@@ -4372,7 +4515,7 @@
         },
         "locationInModule": {
           "filename": "src/role.ts",
-          "line": 69
+          "line": 141
         },
         "parameters": [
           {
@@ -4398,7 +4541,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 58
+        "line": 130
       },
       "name": "Role",
       "properties": [
@@ -4410,7 +4553,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 62
+            "line": 134
           },
           "name": "roleName",
           "type": {
@@ -4425,7 +4568,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 67
+            "line": 139
           },
           "name": "secret",
           "type": {
@@ -4445,7 +4588,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/role.ts",
-        "line": 10
+        "line": 13
       },
       "name": "RoleProps",
       "properties": [
@@ -4458,7 +4601,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 14
+            "line": 17
           },
           "name": "provider",
           "type": {
@@ -4474,7 +4617,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 19
+            "line": 22
           },
           "name": "roleName",
           "type": {
@@ -4484,15 +4627,14 @@
         {
           "abstract": true,
           "docs": {
-            "default": "no connection to any database is granted",
-            "remarks": "If the database exists, connect privileges are granted.\n\nSpecify none of `database` or `databaseName` or only one of them.",
+            "remarks": "If the database exists, connect privileges are granted.\n\nSpecify one of `database` or `databaseName`. This is the name\nthat will be stored in the role's secret as the database name to\nuse.",
             "stability": "stable",
             "summary": "Optional database this user is expected to use."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 30
+            "line": 33
           },
           "name": "database",
           "optional": true,
@@ -4503,15 +4645,14 @@
         {
           "abstract": true,
           "docs": {
-            "default": "no connection to any database is granted",
-            "remarks": "If the database exists, connect privileges are granted.\n\nSpecify none of `database` or `databaseName` or only one of them.",
+            "remarks": "If the database exists, connect privileges are granted.\n\nSpecify one of `database` or `databaseName`. This is the name\nthat will be stored in the role's secret as the database name to\nuse.",
             "stability": "stable",
             "summary": "Optional database name this user is expected to use."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 41
+            "line": 44
           },
           "name": "databaseName",
           "optional": true,
@@ -4529,7 +4670,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 48
+            "line": 51
           },
           "name": "encryptionKey",
           "optional": true,
@@ -4537,6 +4678,25 @@
             "fqn": "aws-cdk-lib.aws_kms.IKey"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- credentials are only stored in Secrets Manager",
+            "remarks": "The parameter names such as \"password\" is simply appended to\n`parameterPrefix`, so make sure the prefix ends with a slash if\n you have your parameter names slash separated.\n\nNote that the password from the secret is copied just once, they\nare not kept in sync.",
+            "stability": "stable",
+            "summary": "Prefix for SSM parameters to store credentials in Parameter Store. When defined, credentials will also be stored as parameters."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/role.ts",
+            "line": 73
+          },
+          "name": "parameterPrefix",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4547,7 +4707,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/role.ts",
-            "line": 55
+            "line": 58
           },
           "name": "secretName",
           "optional": true,
@@ -4832,6 +4992,6 @@
       "symbolId": "src/sql:SqlProps"
     }
   },
-  "version": "4.1.1",
-  "fingerprint": "dOse0bkFKjoyjtBdxkm6o0YSg+T9HtoUgmyePKvJqTc="
+  "version": "6.0.0",
+  "fingerprint": "yzmfzLijv0UVZGHWE9OQE9GBnxI9Xucku5NkKQ+7Obs="
 }

package/.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
-        exclude: (API.md|.mergify.yml|.projen/|.github|tsconfig.dev.json|.gitignore|LICENSE|.gitattributes|.eslintrc.json)
+        exclude: (tsconfig.json|API.md|.mergify.yml|.projen/|.github|tsconfig.dev.json|.gitignore|LICENSE|.gitattributes|.eslintrc.json)
       - id: trailing-whitespace
       - id: check-json
         exclude: (tsconfig.json|.eslintrc.json|tsconfig.dev.json)