cdk-rds-sql 8.1.5__tar.gz → 8.2.0__tar.gz

{cdk_rds_sql-8.1.5/src/cdk_rds_sql.egg-info → cdk_rds_sql-8.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-rds-sql
-Version: 8.1.5
+Version: 8.2.0
 Summary: A CDK construct that allows creating roles or users and databases on Aurora Serverless PostgreSQL or MySQL/MariaDB clusters, as well as AWS DSQL clusters.
 Home-page: https://github.com/berenddeboer/cdk-rds-sql.git
 Author: Berend de Boer<berend@pobox.com>
@@ -172,6 +172,31 @@ has been created.
 If you want to make the role the owner of a new database, just specify
 the `databaseName` here, and create the database later.
 
+### Connection limit (MySQL/MariaDB)
+
+Cap how many connections a MySQL or MariaDB user may open:
+
+```python
+const role = new Role(this, "Role", {
+  provider: provider,
+  roleName: "myrole",
+  databaseName: "mydb",
+  maxUserConnections: 5,
+})
+```
+
+Create and update then run:
+
+```sql
+ALTER USER 'myrole'@'%' WITH MAX_USER_CONNECTIONS 5
+```
+
+Omit `maxUserConnections` to leave the user unlimited, which is the
+existing behaviour. Omitting it does not clear a limit that was already
+applied; set `0` to restore the server default (unlimited unless the
+global `max_user_connections` is set). PostgreSQL and DSQL throw if
+this property is set.
+
 ### IAM Authentication
 
 Instead of password-based authentication, you can create roles that

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0}/README.md

@@ -145,6 +145,31 @@ has been created.
 If you want to make the role the owner of a new database, just specify
 the `databaseName` here, and create the database later.
 
+### Connection limit (MySQL/MariaDB)
+
+Cap how many connections a MySQL or MariaDB user may open:
+
+```python
+const role = new Role(this, "Role", {
+  provider: provider,
+  roleName: "myrole",
+  databaseName: "mydb",
+  maxUserConnections: 5,
+})
+```
+
+Create and update then run:
+
+```sql
+ALTER USER 'myrole'@'%' WITH MAX_USER_CONNECTIONS 5
+```
+
+Omit `maxUserConnections` to leave the user unlimited, which is the
+existing behaviour. Omitting it does not clear a limit that was already
+applied; set `0` to restore the server default (unlimited unless the
+global `max_user_connections` is set). PostgreSQL and DSQL throw if
+this property is set.
+
 ### IAM Authentication
 
 Instead of password-based authentication, you can create roles that

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "cdk-rds-sql",
-    "version": "8.1.5",
+    "version": "8.2.0",
     "description": "A CDK construct that allows creating roles or users and databases on Aurora Serverless PostgreSQL or MySQL/MariaDB clusters, as well as AWS DSQL clusters.",
     "license": "Apache-2.0",
     "url": "https://github.com/berenddeboer/cdk-rds-sql.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "cdk_rds_sql._jsii": [
-            "cdk-rds-sql@8.1.5.jsii.tgz"
+            "cdk-rds-sql@8.2.0.jsii.tgz"
         ],
         "cdk_rds_sql": [
             "py.typed"

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0}/src/cdk_rds_sql/__init__.py

@@ -146,6 +146,31 @@ has been created.
 If you want to make the role the owner of a new database, just specify
 the `databaseName` here, and create the database later.
 
+### Connection limit (MySQL/MariaDB)
+
+Cap how many connections a MySQL or MariaDB user may open:
+
+```python
+const role = new Role(this, "Role", {
+  provider: provider,
+  roleName: "myrole",
+  databaseName: "mydb",
+  maxUserConnections: 5,
+})
+```
+
+Create and update then run:
+
+```sql
+ALTER USER 'myrole'@'%' WITH MAX_USER_CONNECTIONS 5
+```
+
+Omit `maxUserConnections` to leave the user unlimited, which is the
+existing behaviour. Omitting it does not clear a limit that was already
+applied; set `0` to restore the server default (unlimited unless the
+global `max_user_connections` is set). PostgreSQL and DSQL throw if
+this property is set.
+
 ### IAM Authentication
 
 Instead of password-based authentication, you can create roles that
@@ -1314,6 +1339,7 @@ class Role(
         database_name: typing.Optional[builtins.str] = None,
         enable_iam_auth: typing.Optional[builtins.bool] = None,
         encryption_key: typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"] = None,
+        max_user_connections: typing.Optional[jsii.Number] = None,
         parameter_prefix: typing.Optional[builtins.str] = None,
         secret_name: typing.Optional[builtins.str] = None,
     ) -> None:
@@ -1326,6 +1352,7 @@ class Role(
         :param database_name: Optional database name this user is expected to use. If the database exists, connect privileges are granted. Specify one of ``database`` or ``databaseName``. This is the name that will be stored in the role's secret as the database name to use.
         :param enable_iam_auth: Enable IAM authentication for this role. When enabled, the role will be created without a password and configured for AWS IAM database authentication. No secret will be created for this role. Note: For DSQL clusters, this property is ignored as DSQL always uses IAM authentication. Default: false - use password authentication
         :param encryption_key: A new secret is created for this user. Optionally encrypt it with the given key.
+        :param max_user_connections: Maximum simultaneous connections for this MySQL/MariaDB user. When set, create and update run ``ALTER USER '<roleName>'@'%' WITH MAX_USER_CONNECTIONS <n>``. A later change, including a smaller number, is applied on update. ``0`` restores the server default (unlimited unless the global ``max_user_connections`` is set). Omit the property to leave the user unlimited. Omitting it does not clear a limit that was already applied; set ``0`` to do that. PostgreSQL and DSQL do not support this property and throw if it is set. Default: undefined - no connection limit is applied
         :param parameter_prefix: Prefix for SSM parameters to store credentials in Parameter Store. When defined, credentials will also be stored as parameters. The parameter names such as "password" is simply appended to ``parameterPrefix``, so make sure the prefix ends with a slash if you have your parameter names slash separated. The password parameter is refreshed when CloudFormation updates the generated secret resource. Default: - credentials are only stored in Secrets Manager
         :param secret_name: A new secret is created for this user. Optionally add secret name to the secret.
         '''
@@ -1340,6 +1367,7 @@ class Role(
             database_name=database_name,
             enable_iam_auth=enable_iam_auth,
             encryption_key=encryption_key,
+            max_user_connections=max_user_connections,
             parameter_prefix=parameter_prefix,
             secret_name=secret_name,
         )
@@ -1378,6 +1406,7 @@ class Role(
         "database_name": "databaseName",
         "enable_iam_auth": "enableIamAuth",
         "encryption_key": "encryptionKey",
+        "max_user_connections": "maxUserConnections",
         "parameter_prefix": "parameterPrefix",
         "secret_name": "secretName",
     },
@@ -1392,6 +1421,7 @@ class RoleProps:
         database_name: typing.Optional[builtins.str] = None,
         enable_iam_auth: typing.Optional[builtins.bool] = None,
         encryption_key: typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"] = None,
+        max_user_connections: typing.Optional[jsii.Number] = None,
         parameter_prefix: typing.Optional[builtins.str] = None,
         secret_name: typing.Optional[builtins.str] = None,
     ) -> None:
@@ -1402,6 +1432,7 @@ class RoleProps:
         :param database_name: Optional database name this user is expected to use. If the database exists, connect privileges are granted. Specify one of ``database`` or ``databaseName``. This is the name that will be stored in the role's secret as the database name to use.
         :param enable_iam_auth: Enable IAM authentication for this role. When enabled, the role will be created without a password and configured for AWS IAM database authentication. No secret will be created for this role. Note: For DSQL clusters, this property is ignored as DSQL always uses IAM authentication. Default: false - use password authentication
         :param encryption_key: A new secret is created for this user. Optionally encrypt it with the given key.
+        :param max_user_connections: Maximum simultaneous connections for this MySQL/MariaDB user. When set, create and update run ``ALTER USER '<roleName>'@'%' WITH MAX_USER_CONNECTIONS <n>``. A later change, including a smaller number, is applied on update. ``0`` restores the server default (unlimited unless the global ``max_user_connections`` is set). Omit the property to leave the user unlimited. Omitting it does not clear a limit that was already applied; set ``0`` to do that. PostgreSQL and DSQL do not support this property and throw if it is set. Default: undefined - no connection limit is applied
         :param parameter_prefix: Prefix for SSM parameters to store credentials in Parameter Store. When defined, credentials will also be stored as parameters. The parameter names such as "password" is simply appended to ``parameterPrefix``, so make sure the prefix ends with a slash if you have your parameter names slash separated. The password parameter is refreshed when CloudFormation updates the generated secret resource. Default: - credentials are only stored in Secrets Manager
         :param secret_name: A new secret is created for this user. Optionally add secret name to the secret.
         '''
@@ -1413,6 +1444,7 @@ class RoleProps:
             check_type(argname="argument database_name", value=database_name, expected_type=type_hints["database_name"])
             check_type(argname="argument enable_iam_auth", value=enable_iam_auth, expected_type=type_hints["enable_iam_auth"])
             check_type(argname="argument encryption_key", value=encryption_key, expected_type=type_hints["encryption_key"])
+            check_type(argname="argument max_user_connections", value=max_user_connections, expected_type=type_hints["max_user_connections"])
             check_type(argname="argument parameter_prefix", value=parameter_prefix, expected_type=type_hints["parameter_prefix"])
             check_type(argname="argument secret_name", value=secret_name, expected_type=type_hints["secret_name"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
@@ -1427,6 +1459,8 @@ class RoleProps:
             self._values["enable_iam_auth"] = enable_iam_auth
         if encryption_key is not None:
             self._values["encryption_key"] = encryption_key
+        if max_user_connections is not None:
+            self._values["max_user_connections"] = max_user_connections
         if parameter_prefix is not None:
             self._values["parameter_prefix"] = parameter_prefix
         if secret_name is not None:
@@ -1497,6 +1531,26 @@ class RoleProps:
         result = self._values.get("encryption_key")
         return typing.cast(typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"], result)
 
+    @builtins.property
+    def max_user_connections(self) -> typing.Optional[jsii.Number]:
+        '''Maximum simultaneous connections for this MySQL/MariaDB user.
+
+        When set, create and update run
+        ``ALTER USER '<roleName>'@'%' WITH MAX_USER_CONNECTIONS <n>``.
+        A later change, including a smaller number, is applied on update.
+        ``0`` restores the server default (unlimited unless the global
+        ``max_user_connections`` is set).
+
+        Omit the property to leave the user unlimited. Omitting it does not
+        clear a limit that was already applied; set ``0`` to do that.
+
+        PostgreSQL and DSQL do not support this property and throw if it is set.
+
+        :default: undefined - no connection limit is applied
+        '''
+        result = self._values.get("max_user_connections")
+        return typing.cast(typing.Optional[jsii.Number], result)
+
     @builtins.property
     def parameter_prefix(self) -> typing.Optional[builtins.str]:
         '''Prefix for SSM parameters to store credentials in Parameter Store. When defined, credentials will also be stored as parameters.
@@ -1966,6 +2020,7 @@ def _typecheckingstub__062afab8717d46f6fc2a31188b28d9e663190b2080174cc7f1ddd691f
     database_name: typing.Optional[builtins.str] = None,
     enable_iam_auth: typing.Optional[builtins.bool] = None,
     encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.IKey] = None,
+    max_user_connections: typing.Optional[jsii.Number] = None,
     parameter_prefix: typing.Optional[builtins.str] = None,
     secret_name: typing.Optional[builtins.str] = None,
 ) -> None:
@@ -1980,6 +2035,7 @@ def _typecheckingstub__a7ed79cdb7903207b3240698f6bcb0582905979c1519e2b49d66fa6fb
     database_name: typing.Optional[builtins.str] = None,
     enable_iam_auth: typing.Optional[builtins.bool] = None,
     encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.IKey] = None,
+    max_user_connections: typing.Optional[jsii.Number] = None,
     parameter_prefix: typing.Optional[builtins.str] = None,
     secret_name: typing.Optional[builtins.str] = None,
 ) -> None:

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0}/src/cdk_rds_sql/_jsii/__init__.py

@@ -32,7 +32,7 @@ import aws_cdk._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "cdk-rds-sql", "8.1.5", __name__[0:-6], "cdk-rds-sql@8.1.5.jsii.tgz"
+    "cdk-rds-sql", "8.2.0", __name__[0:-6], "cdk-rds-sql@8.2.0.jsii.tgz"
 )
 
 __all__ = [

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0/src/cdk_rds_sql.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdk-rds-sql
-Version: 8.1.5
+Version: 8.2.0
 Summary: A CDK construct that allows creating roles or users and databases on Aurora Serverless PostgreSQL or MySQL/MariaDB clusters, as well as AWS DSQL clusters.
 Home-page: https://github.com/berenddeboer/cdk-rds-sql.git
 Author: Berend de Boer<berend@pobox.com>
@@ -172,6 +172,31 @@ has been created.
 If you want to make the role the owner of a new database, just specify
 the `databaseName` here, and create the database later.
 
+### Connection limit (MySQL/MariaDB)
+
+Cap how many connections a MySQL or MariaDB user may open:
+
+```python
+const role = new Role(this, "Role", {
+  provider: provider,
+  roleName: "myrole",
+  databaseName: "mydb",
+  maxUserConnections: 5,
+})
+```
+
+Create and update then run:
+
+```sql
+ALTER USER 'myrole'@'%' WITH MAX_USER_CONNECTIONS 5
+```
+
+Omit `maxUserConnections` to leave the user unlimited, which is the
+existing behaviour. Omitting it does not clear a limit that was already
+applied; set `0` to restore the server default (unlimited unless the
+global `max_user_connections` is set). PostgreSQL and DSQL throw if
+this property is set.
+
 ### IAM Authentication
 
 Instead of password-based authentication, you can create roles that

{cdk_rds_sql-8.1.5 → cdk_rds_sql-8.2.0}/src/cdk_rds_sql.egg-info/SOURCES.txt

@@ -11,4 +11,4 @@ src/cdk_rds_sql.egg-info/dependency_links.txt
 src/cdk_rds_sql.egg-info/requires.txt
 src/cdk_rds_sql.egg-info/top_level.txt
 src/cdk_rds_sql/_jsii/__init__.py
-src/cdk_rds_sql/_jsii/cdk-rds-sql@8.1.5.jsii.tgz
+src/cdk_rds_sql/_jsii/cdk-rds-sql@8.2.0.jsii.tgz