cdk-rds-sql 7.1.0 → 7.2.1

package/.claude/settings.json

@@ -0,0 +1,25 @@
+{
+  "hooks": {
+    "Stop": [
+      {
+        "hooks": [
+          {
+            "type": "command",
+            "command": "cd $CLAUDE_PROJECT_DIR && npx projen typecheck"
+          }
+        ]
+      }
+    ],
+    "PostToolUse": [
+      {
+        "matcher": "Edit|MultiEdit|Write",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "touch $CLAUDE_PROJECT_DIR/.claude/hooks/.edited"
+          }
+        ]
+      }
+    ]
+  }
+}

package/.conform.yaml

@@ -29,6 +29,10 @@ policies:
           - "schema"
           - "role"
           - "sql"
+          - "iam-grant"
+          - "dsql"
+          - "postgres"
+          - "mysql"
         descriptionLength: 160
   - type: license
     spec:

package/.jsii

@@ -4106,7 +4106,7 @@
         },
         "locationInModule": {
           "filename": "src/database.ts",
-          "line": 62
+          "line": 51
         },
         "parameters": [
           {
@@ -4135,7 +4135,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/database.ts",
-        "line": 50
+        "line": 39
       },
       "methods": [
         {
@@ -4146,7 +4146,7 @@
           },
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 54
+            "line": 43
           },
           "name": "fromDatabaseName",
           "parameters": [
@@ -4186,7 +4186,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 60
+            "line": 49
           },
           "name": "databaseName",
           "overrides": "cdk-rds-sql.IDatabase",
@@ -4197,6 +4197,41 @@
       ],
       "symbolId": "src/database:Database"
     },
+    "cdk-rds-sql.DatabaseEngine": {
+      "assembly": "cdk-rds-sql",
+      "docs": {
+        "stability": "stable",
+        "summary": "Supported database engines."
+      },
+      "fqn": "cdk-rds-sql.DatabaseEngine",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/provider.ts",
+        "line": 97
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "POSTGRES"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "MYSQL"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "DSQL"
+        }
+      ],
+      "name": "DatabaseEngine",
+      "symbolId": "src/provider:DatabaseEngine"
+    },
     "cdk-rds-sql.DatabaseProps": {
       "assembly": "cdk-rds-sql",
       "datatype": true,
@@ -4207,7 +4242,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/database.ts",
-        "line": 30
+        "line": 19
       },
       "name": "DatabaseProps",
       "properties": [
@@ -4220,7 +4255,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 22
+            "line": 11
           },
           "name": "databaseName",
           "type": {
@@ -4236,11 +4271,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 34
+            "line": 23
           },
           "name": "provider",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "fqn": "cdk-rds-sql.IProvider"
           }
         },
         {
@@ -4252,7 +4287,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 27
+            "line": 16
           },
           "name": "owner",
           "optional": true,
@@ -4272,7 +4307,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/database.ts",
-        "line": 37
+        "line": 26
       },
       "name": "IDatabase",
       "properties": [
@@ -4284,7 +4319,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/database.ts",
-            "line": 38
+            "line": 27
           },
           "name": "databaseName",
           "type": {
@@ -4294,6 +4329,111 @@
       ],
       "symbolId": "src/database:IDatabase"
     },
+    "cdk-rds-sql.IProvider": {
+      "assembly": "cdk-rds-sql",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk-rds-sql.IProvider",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/provider.ts",
+        "line": 103
+      },
+      "name": "IProvider",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 107
+          },
+          "name": "engine",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 105
+          },
+          "name": "handler",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_lambda.IFunction"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 104
+          },
+          "name": "serviceToken",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 108
+          },
+          "name": "cluster",
+          "optional": true,
+          "type": {
+            "union": {
+              "types": [
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
+                },
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
+                },
+                {
+                  "fqn": "aws-cdk-lib.aws_dsql.CfnCluster"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 106
+          },
+          "name": "secret",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret"
+          }
+        }
+      ],
+      "symbolId": "src/provider:IProvider"
+    },
     "cdk-rds-sql.IamGrant": {
       "assembly": "cdk-rds-sql",
       "base": "aws-cdk-lib.CustomResource",
@@ -4307,7 +4447,7 @@
         },
         "locationInModule": {
           "filename": "src/iam-grant.ts",
-          "line": 32
+          "line": 24
         },
         "parameters": [
           {
@@ -4333,7 +4473,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/iam-grant.ts",
-        "line": 31
+        "line": 23
       },
       "name": "IamGrant",
       "symbolId": "src/iam-grant:IamGrant"
@@ -4348,7 +4488,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/iam-grant.ts",
-        "line": 7
+        "line": 6
       },
       "name": "IamGrantProps",
       "properties": [
@@ -4361,11 +4501,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/iam-grant.ts",
-            "line": 11
+            "line": 10
           },
           "name": "provider",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "fqn": "cdk-rds-sql.IProvider"
           }
         },
         {
@@ -4377,7 +4517,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/iam-grant.ts",
-            "line": 21
+            "line": 20
           },
           "name": "resourceArn",
           "type": {
@@ -4393,7 +4533,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/iam-grant.ts",
-            "line": 16
+            "line": 15
           },
           "name": "roleName",
           "type": {
@@ -4416,7 +4556,7 @@
         },
         "locationInModule": {
           "filename": "src/provider.ts",
-          "line": 107
+          "line": 158
         },
         "parameters": [
           {
@@ -4439,19 +4579,59 @@
           }
         ]
       },
+      "interfaces": [
+        "cdk-rds-sql.IProvider"
+      ],
       "kind": "class",
       "locationInModule": {
         "filename": "src/provider.ts",
-        "line": 94
+        "line": 134
       },
       "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Import an existing provider Lambda function."
+          },
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 138
+          },
+          "name": "fromProviderAttributes",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "attrs",
+              "type": {
+                "fqn": "cdk-rds-sql.ProviderAttributes"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "cdk-rds-sql.IProvider"
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
             "stability": "stable"
           },
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 186
+            "line": 241
           },
           "name": "newCustomResourceHandler",
           "parameters": [
@@ -4484,6 +4664,38 @@
       ],
       "name": "Provider",
       "properties": [
+        {
+          "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": 156
+          },
+          "name": "engine",
+          "overrides": "cdk-rds-sql.IProvider",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 148
+          },
+          "name": "handler",
+          "overrides": "cdk-rds-sql.IProvider",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_lambda.IFunction"
+          }
+        },
         {
           "docs": {
             "stability": "stable"
@@ -4491,9 +4703,26 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 98
+            "line": 146
+          },
+          "name": "serviceToken",
+          "overrides": "cdk-rds-sql.IProvider",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 149
           },
           "name": "cluster",
+          "optional": true,
+          "overrides": "cdk-rds-sql.IProvider",
           "type": {
             "union": {
               "types": [
@@ -4512,65 +4741,118 @@
         },
         {
           "docs": {
-            "default": "- if we cannot determine this \"postgres\"",
-            "stability": "stable",
-            "summary": "The engine like \"postgres\" or \"mysql\"."
+            "stability": "stable"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 105
+            "line": 147
+          },
+          "name": "secret",
+          "optional": true,
+          "overrides": "cdk-rds-sql.IProvider",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret"
+          }
+        }
+      ],
+      "symbolId": "src/provider:Provider"
+    },
+    "cdk-rds-sql.ProviderAttributes": {
+      "assembly": "cdk-rds-sql",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "cdk-rds-sql.ProviderAttributes",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/provider.ts",
+        "line": 111
+      },
+      "name": "ProviderAttributes",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/provider.ts",
+            "line": 119
           },
           "name": "engine",
           "type": {
-            "primitive": "string"
+            "fqn": "cdk-rds-sql.DatabaseEngine"
           }
         },
         {
+          "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "When importing a provider, cluster details are often not available.\nHowever, some operations like role creation require cluster endpoint\ninformation to build connection secrets.\n\nIf you plan to create roles with the imported provider, you must\nprovide the cluster reference. If you only plan to use existing\nroles, databases, schemas, or SQL operations, this can be omitted.",
+            "stability": "stable",
+            "summary": "Optional cluster information for role creation."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 97
+            "line": 131
           },
-          "name": "handler",
+          "name": "cluster",
+          "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.aws_lambda.IFunction"
+            "union": {
+              "types": [
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseCluster"
+                },
+                {
+                  "fqn": "aws-cdk-lib.aws_rds.IDatabaseInstance"
+                },
+                {
+                  "fqn": "aws-cdk-lib.aws_dsql.CfnCluster"
+                }
+              ]
+            }
           }
         },
         {
+          "abstract": true,
           "docs": {
-            "stability": "stable"
+            "remarks": "Use functionArn for cross-account or cross-region scenarios.\nUse functionName for same-account, same-region scenarios.",
+            "stability": "stable",
+            "summary": "Either the ARN or name of the Lambda function."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 95
+            "line": 117
           },
-          "name": "serviceToken",
+          "name": "functionArn",
+          "optional": true,
           "type": {
             "primitive": "string"
           }
         },
         {
+          "abstract": true,
           "docs": {
             "stability": "stable"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/provider.ts",
-            "line": 96
+            "line": 118
           },
-          "name": "secret",
+          "name": "functionName",
           "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret"
+            "primitive": "string"
           }
         }
       ],
-      "symbolId": "src/provider:Provider"
+      "symbolId": "src/provider:ProviderAttributes"
     },
     "cdk-rds-sql.RdsSqlProps": {
       "assembly": "cdk-rds-sql",
@@ -4905,7 +5187,7 @@
           },
           "name": "provider",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "fqn": "cdk-rds-sql.IProvider"
           }
         },
         {
@@ -5124,7 +5406,7 @@
           },
           "name": "provider",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "fqn": "cdk-rds-sql.IProvider"
           }
         },
         {
@@ -5253,7 +5535,7 @@
           },
           "name": "provider",
           "type": {
-            "fqn": "cdk-rds-sql.Provider"
+            "fqn": "cdk-rds-sql.IProvider"
           }
         },
         {
@@ -5312,6 +5594,6 @@
       "symbolId": "src/sql:SqlProps"
     }
   },
-  "version": "7.1.0",
-  "fingerprint": "Br67rMWoquyfP4fkoXFhxUY052ccvSQ97cHjBsTGprI="
+  "version": "7.2.1",
+  "fingerprint": "V/1Cl37RinHsBGbf7esxVt0QFBU027gOfzZQzSmfsMU="
 }