cloudsnorkel.cdk-rds-sanitized-snapshots 0.0.0__py3-none-any.whl → 0.1.6__py3-none-any.whl

cloudsnorkel/cdk_rds_sanitized_snapshots/__init__.py

@@ -1,4 +1,4 @@
-'''
+r'''
 # CDK Construct for RDS Sanitized Snapshots
 
 [![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-rds-sanitized-snapshots?label=npm&logo=npm)](https://www.npmjs.com/package/@cloudsnorkel/cdk-rds-sanitized-snapshots)
@@ -42,9 +42,44 @@ The step function does the following to create the snapshot:
 9. Optionally share the snapshot with other accounts (if you have separate accounts for developers/QA)
 10. Delete temporary database and snapshot
 
-## Example
+## Usage
+
+1. Confirm you're using CDK v2
+2. Install the appropriate package
+
+   1. [Python](https://pypi.org/project/cloudsnorkel.cdk-rds-sanitized-snapshots)
+
+      ```
+      pip install cloudsnorkel.cdk-rds-sanitized-snapshots
+      ```
+   2. [TypeScript or JavaScript](https://www.npmjs.com/package/@cloudsnorkel/cdk-rds-sanitized-snapshots)
+
+      ```
+      npm i @cloudsnorkel/cdk-rds-sanitized-snapshots
+      ```
+   3. [Java](https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.rds.sanitized-snapshots%22)
+
+      ```xml
+      <dependency>
+      <groupId>com.cloudsnorkel</groupId>
+      <artifactId>cdk.rds.sanitized-snapshots</artifactId>
+      </dependency>
+      ```
+   4. [Go](https://pkg.go.dev/github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots)
+
+      ```
+      go get github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots
+      ```
+   5. [.NET](https://www.nuget.org/packages/CloudSnorkel.Cdk.Rds.SanitizedSnapshots/)
+
+      ```
+      dotnet add package CloudSnorkel.Cdk.Rds.SanitizedSnapshots
+      ```
+3. Use `RdsSanitizedSnapshotter` construct in your code (starting with default arguments is fine)
 
-```typescript
+### Code Sample
+
+```python
 let vpc: ec2.Vpc;
 let databaseInstance: rds.DatabaseInstance;
 
@@ -74,6 +109,9 @@ on giving other accounts access to the key.
 npm run bundle && npm run integ:default:deploy
 ```
 '''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -84,15 +122,32 @@ import jsii
 import publication
 import typing_extensions
 
+import typeguard
+from importlib.metadata import version as _metadata_package_version
+TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
+
+def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
+    if TYPEGUARD_MAJOR_VERSION <= 2:
+        return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
+    else:
+        if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
+           pass
+        else:
+            if TYPEGUARD_MAJOR_VERSION == 3:
+                typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
+                typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
+            else:
+                typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
+
 from ._jsii import *
 
-import aws_cdk.aws_ec2
-import aws_cdk.aws_ecs
-import aws_cdk.aws_events
-import aws_cdk.aws_kms
-import aws_cdk.aws_rds
-import aws_cdk.aws_stepfunctions
-import constructs
+import aws_cdk.aws_ec2 as _aws_cdk_aws_ec2_ceddda9d
+import aws_cdk.aws_ecs as _aws_cdk_aws_ecs_ceddda9d
+import aws_cdk.aws_events as _aws_cdk_aws_events_ceddda9d
+import aws_cdk.aws_kms as _aws_cdk_aws_kms_ceddda9d
+import aws_cdk.aws_rds as _aws_cdk_aws_rds_ceddda9d
+import aws_cdk.aws_stepfunctions as _aws_cdk_aws_stepfunctions_ceddda9d
+import constructs as _constructs_77d1e7e8
 
 
 @jsii.interface(
@@ -103,7 +158,7 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
     :stability: experimental
     '''
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="script")
     def script(self) -> builtins.str:
         '''(experimental) SQL script used to sanitize the database. It will be executed against the temporary database.
@@ -114,18 +169,20 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="vpc")
-    def vpc(self) -> aws_cdk.aws_ec2.IVpc:
+    def vpc(self) -> "_aws_cdk_aws_ec2_ceddda9d.IVpc":
         '''(experimental) VPC where temporary database and sanitizing task will be created.
 
         :stability: experimental
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseCluster")
-    def database_cluster(self) -> typing.Optional[aws_cdk.aws_rds.IDatabaseCluster]:
+    def database_cluster(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseCluster"]:
         '''(experimental) Database cluster to snapshot and sanitize.
 
         Only one of ``databaseCluster`` and ``databaseInstance`` can be specified.
@@ -134,9 +191,11 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseInstance")
-    def database_instance(self) -> typing.Optional[aws_cdk.aws_rds.IDatabaseInstance]:
+    def database_instance(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseInstance"]:
         '''(experimental) Database instance to snapshot and sanitize.
 
         Only one of ``databaseCluster`` and ``databaseInstance`` can be specified.
@@ -145,18 +204,33 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseKey")
-    def database_key(self) -> typing.Optional[aws_cdk.aws_kms.IKey]:
+    def database_key(self) -> typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"]:
         '''(experimental) KMS key used to encrypt original database, if any.
 
         :stability: experimental
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
+    @jsii.member(jsii_name="databaseName")
+    def database_name(self) -> typing.Optional[builtins.str]:
+        '''(experimental) Name of database to connect to inside the RDS cluster or instance.
+
+        This database will be used to execute the SQL script.
+
+        :default: 'postgres' for PostgreSQL and not set for MySQL
+
+        :stability: experimental
+        '''
+        ...
+
+    @builtins.property
     @jsii.member(jsii_name="dbSubnets")
-    def db_subnets(self) -> typing.Optional[aws_cdk.aws_ec2.SubnetSelection]:
+    def db_subnets(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"]:
         '''(experimental) VPC subnets to use for temporary databases.
 
         :default: ec2.SubnetType.PRIVATE_ISOLATED
@@ -165,9 +239,9 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="fargateCluster")
-    def fargate_cluster(self) -> typing.Optional[aws_cdk.aws_ecs.ICluster]:
+    def fargate_cluster(self) -> typing.Optional["_aws_cdk_aws_ecs_ceddda9d.ICluster"]:
         '''(experimental) Cluster where sanitization task will be executed.
 
         :default: a new cluster running on given VPC
@@ -176,27 +250,38 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="sanitizeSubnets")
-    def sanitize_subnets(self) -> typing.Optional[aws_cdk.aws_ec2.SubnetSelection]:
+    def sanitize_subnets(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"]:
         '''(experimental) VPC subnets to use for sanitization task.
 
-        :default: ec2.SubnetType.PRIVATE_WITH_NAT
+        :default: ec2.SubnetType.PRIVATE_WITH_EGRESS
 
         :stability: experimental
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="schedule")
-    def schedule(self) -> typing.Optional[aws_cdk.aws_events.Schedule]:
+    def schedule(self) -> typing.Optional["_aws_cdk_aws_events_ceddda9d.Schedule"]:
         '''(experimental) The schedule or rate (frequency) that determines when the sanitized snapshot runs automatically.
 
         :stability: experimental
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
+    @jsii.member(jsii_name="shareAccounts")
+    def share_accounts(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''(experimental) List of accounts the sanitized snapshot should be shared with.
+
+        :stability: experimental
+        '''
+        ...
+
+    @builtins.property
     @jsii.member(jsii_name="snapshotHistoryLimit")
     def snapshot_history_limit(self) -> typing.Optional[jsii.Number]:
         '''(experimental) Limit the number of snapshot history.
@@ -207,16 +292,16 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="snapshotKey")
-    def snapshot_key(self) -> typing.Optional[aws_cdk.aws_kms.IKey]:
+    def snapshot_key(self) -> typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"]:
         '''(experimental) Optional KMS key to encrypt target snapshot.
 
         :stability: experimental
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="snapshotPrefix")
     def snapshot_prefix(self) -> typing.Optional[builtins.str]:
         '''(experimental) Prefix for sanitized snapshot name.
@@ -229,7 +314,7 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="tempPrefix")
     def temp_prefix(self) -> typing.Optional[builtins.str]:
         '''(experimental) Prefix for all temporary snapshots and databases.
@@ -242,6 +327,21 @@ class IRdsSanitizedSnapshotter(typing_extensions.Protocol):
         '''
         ...
 
+    @builtins.property
+    @jsii.member(jsii_name="useExistingSnapshot")
+    def use_existing_snapshot(self) -> typing.Optional[builtins.bool]:
+        '''(experimental) Use the latest available snapshot instead of taking a new one.
+
+        This can be used to shorten the process at the cost of using a possibly older snapshot.
+
+        This will use the latest snapshot whether it's an automatic system snapshot or a manual snapshot.
+
+        :default: false
+
+        :stability: experimental
+        '''
+        ...
+
 
 class _IRdsSanitizedSnapshotterProxy:
     '''
@@ -250,7 +350,7 @@ class _IRdsSanitizedSnapshotterProxy:
 
     __jsii_type__: typing.ClassVar[str] = "@cloudsnorkel/cdk-rds-sanitized-snapshots.IRdsSanitizedSnapshotter"
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="script")
     def script(self) -> builtins.str:
         '''(experimental) SQL script used to sanitize the database. It will be executed against the temporary database.
@@ -261,89 +361,119 @@ class _IRdsSanitizedSnapshotterProxy:
         '''
         return typing.cast(builtins.str, jsii.get(self, "script"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="vpc")
-    def vpc(self) -> aws_cdk.aws_ec2.IVpc:
+    def vpc(self) -> "_aws_cdk_aws_ec2_ceddda9d.IVpc":
         '''(experimental) VPC where temporary database and sanitizing task will be created.
 
         :stability: experimental
         '''
-        return typing.cast(aws_cdk.aws_ec2.IVpc, jsii.get(self, "vpc"))
+        return typing.cast("_aws_cdk_aws_ec2_ceddda9d.IVpc", jsii.get(self, "vpc"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseCluster")
-    def database_cluster(self) -> typing.Optional[aws_cdk.aws_rds.IDatabaseCluster]:
+    def database_cluster(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseCluster"]:
         '''(experimental) Database cluster to snapshot and sanitize.
 
         Only one of ``databaseCluster`` and ``databaseInstance`` can be specified.
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_rds.IDatabaseCluster], jsii.get(self, "databaseCluster"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseCluster"], jsii.get(self, "databaseCluster"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseInstance")
-    def database_instance(self) -> typing.Optional[aws_cdk.aws_rds.IDatabaseInstance]:
+    def database_instance(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseInstance"]:
         '''(experimental) Database instance to snapshot and sanitize.
 
         Only one of ``databaseCluster`` and ``databaseInstance`` can be specified.
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_rds.IDatabaseInstance], jsii.get(self, "databaseInstance"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_rds_ceddda9d.IDatabaseInstance"], jsii.get(self, "databaseInstance"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="databaseKey")
-    def database_key(self) -> typing.Optional[aws_cdk.aws_kms.IKey]:
+    def database_key(self) -> typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"]:
         '''(experimental) KMS key used to encrypt original database, if any.
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_kms.IKey], jsii.get(self, "databaseKey"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"], jsii.get(self, "databaseKey"))
+
+    @builtins.property
+    @jsii.member(jsii_name="databaseName")
+    def database_name(self) -> typing.Optional[builtins.str]:
+        '''(experimental) Name of database to connect to inside the RDS cluster or instance.
 
-    @builtins.property # type: ignore[misc]
+        This database will be used to execute the SQL script.
+
+        :default: 'postgres' for PostgreSQL and not set for MySQL
+
+        :stability: experimental
+        '''
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "databaseName"))
+
+    @builtins.property
     @jsii.member(jsii_name="dbSubnets")
-    def db_subnets(self) -> typing.Optional[aws_cdk.aws_ec2.SubnetSelection]:
+    def db_subnets(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"]:
         '''(experimental) VPC subnets to use for temporary databases.
 
         :default: ec2.SubnetType.PRIVATE_ISOLATED
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_ec2.SubnetSelection], jsii.get(self, "dbSubnets"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"], jsii.get(self, "dbSubnets"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="fargateCluster")
-    def fargate_cluster(self) -> typing.Optional[aws_cdk.aws_ecs.ICluster]:
+    def fargate_cluster(self) -> typing.Optional["_aws_cdk_aws_ecs_ceddda9d.ICluster"]:
         '''(experimental) Cluster where sanitization task will be executed.
 
         :default: a new cluster running on given VPC
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_ecs.ICluster], jsii.get(self, "fargateCluster"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_ecs_ceddda9d.ICluster"], jsii.get(self, "fargateCluster"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="sanitizeSubnets")
-    def sanitize_subnets(self) -> typing.Optional[aws_cdk.aws_ec2.SubnetSelection]:
+    def sanitize_subnets(
+        self,
+    ) -> typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"]:
         '''(experimental) VPC subnets to use for sanitization task.
 
-        :default: ec2.SubnetType.PRIVATE_WITH_NAT
+        :default: ec2.SubnetType.PRIVATE_WITH_EGRESS
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_ec2.SubnetSelection], jsii.get(self, "sanitizeSubnets"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_ec2_ceddda9d.SubnetSelection"], jsii.get(self, "sanitizeSubnets"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="schedule")
-    def schedule(self) -> typing.Optional[aws_cdk.aws_events.Schedule]:
+    def schedule(self) -> typing.Optional["_aws_cdk_aws_events_ceddda9d.Schedule"]:
         '''(experimental) The schedule or rate (frequency) that determines when the sanitized snapshot runs automatically.
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_events.Schedule], jsii.get(self, "schedule"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_events_ceddda9d.Schedule"], jsii.get(self, "schedule"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
+    @jsii.member(jsii_name="shareAccounts")
+    def share_accounts(self) -> typing.Optional[typing.List[builtins.str]]:
+        '''(experimental) List of accounts the sanitized snapshot should be shared with.
+
+        :stability: experimental
+        '''
+        return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "shareAccounts"))
+
+    @builtins.property
     @jsii.member(jsii_name="snapshotHistoryLimit")
     def snapshot_history_limit(self) -> typing.Optional[jsii.Number]:
         '''(experimental) Limit the number of snapshot history.
@@ -354,16 +484,16 @@ class _IRdsSanitizedSnapshotterProxy:
         '''
         return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "snapshotHistoryLimit"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="snapshotKey")
-    def snapshot_key(self) -> typing.Optional[aws_cdk.aws_kms.IKey]:
+    def snapshot_key(self) -> typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"]:
         '''(experimental) Optional KMS key to encrypt target snapshot.
 
         :stability: experimental
         '''
-        return typing.cast(typing.Optional[aws_cdk.aws_kms.IKey], jsii.get(self, "snapshotKey"))
+        return typing.cast(typing.Optional["_aws_cdk_aws_kms_ceddda9d.IKey"], jsii.get(self, "snapshotKey"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="snapshotPrefix")
     def snapshot_prefix(self) -> typing.Optional[builtins.str]:
         '''(experimental) Prefix for sanitized snapshot name.
@@ -376,7 +506,7 @@ class _IRdsSanitizedSnapshotterProxy:
         '''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "snapshotPrefix"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="tempPrefix")
     def temp_prefix(self) -> typing.Optional[builtins.str]:
         '''(experimental) Prefix for all temporary snapshots and databases.
@@ -389,12 +519,27 @@ class _IRdsSanitizedSnapshotterProxy:
         '''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "tempPrefix"))
 
+    @builtins.property
+    @jsii.member(jsii_name="useExistingSnapshot")
+    def use_existing_snapshot(self) -> typing.Optional[builtins.bool]:
+        '''(experimental) Use the latest available snapshot instead of taking a new one.
+
+        This can be used to shorten the process at the cost of using a possibly older snapshot.
+
+        This will use the latest snapshot whether it's an automatic system snapshot or a manual snapshot.
+
+        :default: false
+
+        :stability: experimental
+        '''
+        return typing.cast(typing.Optional[builtins.bool], jsii.get(self, "useExistingSnapshot"))
+
 # Adding a "__jsii_proxy_class__(): typing.Type" function to the interface
 typing.cast(typing.Any, IRdsSanitizedSnapshotter).__jsii_proxy_class__ = lambda : _IRdsSanitizedSnapshotterProxy
 
 
 class RdsSanitizedSnapshotter(
-    constructs.Construct,
+    _constructs_77d1e7e8.Construct,
     metaclass=jsii.JSIIMeta,
     jsii_type="@cloudsnorkel/cdk-rds-sanitized-snapshots.RdsSanitizedSnapshotter",
 ):
@@ -403,7 +548,7 @@ class RdsSanitizedSnapshotter(
     The process is handled by a step function.
 
     1. Snapshot the source database
-    2. Optionally re-ncrypt the snapshot with a different key in case you want to share it with an account that doesn't have access to the original key
+    2. Optionally re-encrypt the snapshot with a different key in case you want to share it with an account that doesn't have access to the original key
     3. Create a temporary database
     4. Run a Fargate task to connect to the temporary database and execute an arbitrary SQL script to sanitize it
     5. Snapshot the sanitized database
@@ -414,9 +559,9 @@ class RdsSanitizedSnapshotter(
 
     def __init__(
         self,
-        scope: constructs.Construct,
+        scope: "_constructs_77d1e7e8.Construct",
         id: builtins.str,
-        props: IRdsSanitizedSnapshotter,
+        props: "IRdsSanitizedSnapshotter",
     ) -> None:
         '''
         :param scope: -
@@ -425,30 +570,41 @@ class RdsSanitizedSnapshotter(
 
         :stability: experimental
         '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__1e15c41233acb14f8259c09345be1563a5d61c80585cf7e3c29c90b00f3e5879)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+            check_type(argname="argument props", value=props, expected_type=type_hints["props"])
         jsii.create(self.__class__, self, [scope, id, props])
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="props")
-    def props(self) -> IRdsSanitizedSnapshotter:
+    def props(self) -> "IRdsSanitizedSnapshotter":
         '''
         :stability: experimental
         '''
-        return typing.cast(IRdsSanitizedSnapshotter, jsii.get(self, "props"))
+        return typing.cast("IRdsSanitizedSnapshotter", jsii.get(self, "props"))
 
-    @builtins.property # type: ignore[misc]
+    @builtins.property
     @jsii.member(jsii_name="snapshotter")
-    def snapshotter(self) -> aws_cdk.aws_stepfunctions.StateMachine:
+    def snapshotter(self) -> "_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine":
         '''(experimental) Step function in charge of the entire process including snapshotting, sanitizing, and cleanup.
 
         Trigger this step function to get a new snapshot.
 
         :stability: experimental
         '''
-        return typing.cast(aws_cdk.aws_stepfunctions.StateMachine, jsii.get(self, "snapshotter"))
+        return typing.cast("_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine", jsii.get(self, "snapshotter"))
 
     @snapshotter.setter
-    def snapshotter(self, value: aws_cdk.aws_stepfunctions.StateMachine) -> None:
-        jsii.set(self, "snapshotter", value)
+    def snapshotter(
+        self,
+        value: "_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine",
+    ) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__df51411713b297623720935bb6779afc65503804a74afed6b48f5754baba7f14)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "snapshotter", value) # pyright: ignore[reportArgumentType]
 
 
 __all__ = [
@@ -457,3 +613,20 @@ __all__ = [
 ]
 
 publication.publish()
+
+def _typecheckingstub__1e15c41233acb14f8259c09345be1563a5d61c80585cf7e3c29c90b00f3e5879(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    props: IRdsSanitizedSnapshotter,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__df51411713b297623720935bb6779afc65503804a74afed6b48f5754baba7f14(
+    value: _aws_cdk_aws_stepfunctions_ceddda9d.StateMachine,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+for cls in [IRdsSanitizedSnapshotter]:
+    typing.cast(typing.Any, cls).__protocol_attrs__ = typing.cast(typing.Any, cls).__protocol_attrs__ - set(['__jsii_proxy_class__', '__jsii_type__'])

cloudsnorkel/cdk_rds_sanitized_snapshots/_jsii/__init__.py

@@ -1,3 +1,6 @@
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
 import abc
 import builtins
 import datetime
@@ -8,14 +11,31 @@ import jsii
 import publication
 import typing_extensions
 
+import typeguard
+from importlib.metadata import version as _metadata_package_version
+TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
+
+def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
+    if TYPEGUARD_MAJOR_VERSION <= 2:
+        return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
+    else:
+        if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
+           pass
+        else:
+            if TYPEGUARD_MAJOR_VERSION == 3:
+                typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
+                typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
+            else:
+                typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
+
 import aws_cdk._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "@cloudsnorkel/cdk-rds-sanitized-snapshots",
-    "0.0.0",
+    "0.1.6",
     __name__[0:-6],
-    "cdk-rds-sanitized-snapshots@0.0.0.jsii.tgz",
+    "cdk-rds-sanitized-snapshots@0.1.6.jsii.tgz",
 )
 
 __all__ = [

{cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info → cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info}/METADATA

@@ -1,30 +1,29 @@
 Metadata-Version: 2.1
 Name: cloudsnorkel.cdk-rds-sanitized-snapshots
-Version: 0.0.0
+Version: 0.1.6
 Summary: CDK construct to periodically take snapshots of RDS databases, sanitize them, and share with selected accounts.
 Home-page: https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots.git
 Author: Amir Szekely<amir@cloudsnorkel.com>
 License: Apache-2.0
 Project-URL: Source, https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots.git
-Platform: UNKNOWN
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: JavaScript
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Typing :: Typed
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved
-Requires-Python: ~=3.7
+Requires-Python: ~=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aws-cdk-lib (<3.0.0,>=2.0.0)
-Requires-Dist: constructs (<11.0.0,>=10.0.5)
-Requires-Dist: jsii (<2.0.0,>=1.61.0)
-Requires-Dist: publication (>=0.0.3)
+Requires-Dist: aws-cdk-lib <3.0.0,>=2.146.0
+Requires-Dist: constructs <11.0.0,>=10.0.5
+Requires-Dist: jsii <2.0.0,>=1.126.0
+Requires-Dist: publication >=0.0.3
+Requires-Dist: typeguard ==2.13.3
 
 # CDK Construct for RDS Sanitized Snapshots
 
@@ -69,9 +68,44 @@ The step function does the following to create the snapshot:
 9. Optionally share the snapshot with other accounts (if you have separate accounts for developers/QA)
 10. Delete temporary database and snapshot
 
-## Example
+## Usage
 
-```typescript
+1. Confirm you're using CDK v2
+2. Install the appropriate package
+
+   1. [Python](https://pypi.org/project/cloudsnorkel.cdk-rds-sanitized-snapshots)
+
+      ```
+      pip install cloudsnorkel.cdk-rds-sanitized-snapshots
+      ```
+   2. [TypeScript or JavaScript](https://www.npmjs.com/package/@cloudsnorkel/cdk-rds-sanitized-snapshots)
+
+      ```
+      npm i @cloudsnorkel/cdk-rds-sanitized-snapshots
+      ```
+   3. [Java](https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.rds.sanitized-snapshots%22)
+
+      ```xml
+      <dependency>
+      <groupId>com.cloudsnorkel</groupId>
+      <artifactId>cdk.rds.sanitized-snapshots</artifactId>
+      </dependency>
+      ```
+   4. [Go](https://pkg.go.dev/github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots)
+
+      ```
+      go get github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots
+      ```
+   5. [.NET](https://www.nuget.org/packages/CloudSnorkel.Cdk.Rds.SanitizedSnapshots/)
+
+      ```
+      dotnet add package CloudSnorkel.Cdk.Rds.SanitizedSnapshots
+      ```
+3. Use `RdsSanitizedSnapshotter` construct in your code (starting with default arguments is fine)
+
+### Code Sample
+
+```python
 let vpc: ec2.Vpc;
 let databaseInstance: rds.DatabaseInstance;
 
@@ -100,5 +134,3 @@ on giving other accounts access to the key.
 ```
 npm run bundle && npm run integ:default:deploy
 ```
-
-

cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/RECORD

@@ -0,0 +1,9 @@
+cloudsnorkel/cdk_rds_sanitized_snapshots/__init__.py,sha256=tCWwZlMfeCwsruMGSTnWjr4bUXTzq4ay-mxilSU3mxs,23793
+cloudsnorkel/cdk_rds_sanitized_snapshots/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+cloudsnorkel/cdk_rds_sanitized_snapshots/_jsii/__init__.py,sha256=zXWY1ALvWAeJRTF66SX9CubTFVZToWyrUL71jSmVeFc,1492
+cloudsnorkel/cdk_rds_sanitized_snapshots/_jsii/cdk-rds-sanitized-snapshots@0.1.6.jsii.tgz,sha256=2prnZyB6wxSmIe-WnwAHTAUN5ny7hSwfc2sPx1Kd_jM,81023
+cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/METADATA,sha256=PtzOv2BTAdt6gkN-4bx1ZfT7lQn-xfVS2iAOx1SVq-Y,6442
+cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/WHEEL,sha256=WnJ8fYhv8N4SYVK2lLYNI6N0kVATA7b0piVUNvqIIJE,91
+cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
+cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info/RECORD,,

{cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info → cloudsnorkel_cdk_rds_sanitized_snapshots-0.1.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (75.3.3)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-cloudsnorkel/cdk_rds_sanitized_snapshots/__init__.py,sha256=Y_y2uTlpcLIgwFL7CFOlz3Uvf-LD_GyF31A2_woBu8U,17272
-cloudsnorkel/cdk_rds_sanitized_snapshots/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-cloudsnorkel/cdk_rds_sanitized_snapshots/_jsii/__init__.py,sha256=uGbhnW8m9cvrYhjjhoB4a7WeOtMWpywXz5Ch6Pd9wGA,414
-cloudsnorkel/cdk_rds_sanitized_snapshots/_jsii/cdk-rds-sanitized-snapshots@0.0.0.jsii.tgz,sha256=MNLaRmvO5BdcUUT9PapFyxFbWfNJhoJ8z5ZyuxiZQSo,70445
-cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/METADATA,sha256=cWO9-t924T6xaNdOKT7iua-I7sPgisOsDj_h9jFYgr0,5260
-cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/top_level.txt,sha256=6vUrT-dcGOiRMT4Q6gEQPznoyS7nHOJ269MHpo4DEd8,13
-cloudsnorkel.cdk_rds_sanitized_snapshots-0.0.0.dist-info/RECORD,,