@btc-embedded/cdk-extensions 0.1.1 → 0.3.0

package/.jsii

@@ -7,6 +7,9 @@
     ],
     "url": "https://btc-embedded.com"
   },
+  "bundled": {
+    "lodash": "^4"
+  },
   "dependencies": {
     "@aws-cdk-containers/ecs-service-extensions": ">=2.0.1-alpha.535",
     "aws-cdk-lib": "^2.172.0",
@@ -3941,11 +3944,58 @@
     }
   },
   "types": {
+    "@btc-embedded/cdk-extensions.ApiGateway": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "This API Gateway construct sets up an API Gateway V2 and a default HTTP API\nprotected by the provided Cognito user pool and client(s). The construct\nregisters an A record for the subdomain in the provided hosted zone. It also\ncreates a VPC Link (and security group) for the API Gateway to connect to\nservices in the VPC.\n\nThe relevant parameters are exposed as CloudFormation outputs so that they\ncan be used by the CDK extensions provided in this library.",
+        "stability": "experimental",
+        "summary": "API Gateway construct to be used in base platforms."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ApiGateway",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/ApiGateway.ts",
+          "line": 81
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.ApiGatewayProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/ApiGateway.ts",
+        "line": 74
+      },
+      "name": "ApiGateway",
+      "symbolId": "src/platform/ApiGateway:ApiGateway"
+    },
     "@btc-embedded/cdk-extensions.ApiGatewayExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
       "docs": {
-        "stability": "experimental"
+        "stability": "experimental",
+        "summary": "Configures the service to be reachable via an API Gateway."
       },
       "fqn": "@btc-embedded/cdk-extensions.ApiGatewayExtension",
       "initializer": {
@@ -3954,7 +4004,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/ApiGatewayExtension.ts",
-          "line": 30
+          "line": 48
         },
         "parameters": [
           {
@@ -3968,7 +4018,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/ApiGatewayExtension.ts",
-        "line": 27
+        "line": 41
       },
       "methods": [
         {
@@ -3979,7 +4029,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApiGatewayExtension.ts",
-            "line": 35
+            "line": 53
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4011,7 +4061,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ApiGatewayExtension.ts",
-            "line": 28
+            "line": 42
           },
           "name": "props",
           "type": {
@@ -4038,12 +4088,13 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "The name of the base platform stack."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ApiGatewayExtension.ts",
-            "line": 23
+            "line": 30
           },
           "name": "platformStackName",
           "type": {
@@ -4053,12 +4104,13 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "The prefix for the API Gateway endpoint."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ApiGatewayExtension.ts",
-            "line": 22
+            "line": 25
           },
           "name": "prefix",
           "type": {
@@ -4068,12 +4120,13 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "The security group ID of the API Gateway which should be allowed to connect to the service."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ApiGatewayExtension.ts",
-            "line": 24
+            "line": 35
           },
           "name": "securityGroupId",
           "type": {
@@ -4083,6 +4136,216 @@
       ],
       "symbolId": "src/extensions/ApiGatewayExtension:ApiGatewayExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.ApiGatewayProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ApiGatewayProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/ApiGateway.ts",
+        "line": 22
+      },
+      "name": "ApiGatewayProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Domain prefix for the API Gateway endpoint."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 46
+          },
+          "name": "domainPrefix",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Hosted Zone where the A record for the domain will be created."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 51
+          },
+          "name": "hostedZone",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_route53.IHostedZone"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the stack, used for prefixing the output parameter names."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 26
+          },
+          "name": "stackName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Specify the Cognito User Pool to be used for authorizing requests on the API Gateway."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 36
+          },
+          "name": "userPool",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPool"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of User Pool Clients that are allowed to access the API Gateway."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 41
+          },
+          "name": "userPoolClients",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_cognito.IUserPoolClient"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "VPC where the API GW Security group and VPC Link will be created."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 31
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "default: true",
+            "stability": "experimental",
+            "summary": "Enable access logs for the API Gateway."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApiGateway.ts",
+            "line": 58
+          },
+          "name": "enableAccessLogs",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/platform/ApiGateway:ApiGatewayProps"
+    },
+    "@btc-embedded/cdk-extensions.ApplicationLoadBalancer": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ApplicationLoadBalancer",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/ApplicationLoadBalancer.ts",
+          "line": 38
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/ApplicationLoadBalancer.ts",
+        "line": 31
+      },
+      "name": "ApplicationLoadBalancer",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 32
+          },
+          "name": "loadbalancer",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 34
+          },
+          "name": "loadBalancer",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer"
+          }
+        }
+      ],
+      "symbolId": "src/platform/ApplicationLoadBalancer:ApplicationLoadBalancer"
+    },
     "@btc-embedded/cdk-extensions.ApplicationLoadBalancerExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4374,58 +4637,210 @@
       ],
       "symbolId": "src/extensions/ApplicationLoadBalancerExtension:ApplicationLoadBalancerExtensionProps"
     },
-    "@btc-embedded/cdk-extensions.CloudMapExtension": {
+    "@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps": {
       "assembly": "@btc-embedded/cdk-extensions",
-      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "datatype": true,
       "docs": {
         "stability": "experimental"
       },
-      "fqn": "@btc-embedded/cdk-extensions.CloudMapExtension",
-      "initializer": {
-        "docs": {
-          "stability": "experimental"
-        },
-        "locationInModule": {
-          "filename": "src/extensions/CloudMapExtension.ts",
-          "line": 25
-        },
-        "parameters": [
-          {
-            "name": "props",
-            "type": {
-              "fqn": "@btc-embedded/cdk-extensions.CloudMapExtensionProps"
-            }
-          }
-        ]
-      },
-      "kind": "class",
+      "fqn": "@btc-embedded/cdk-extensions.ApplicationLoadBalancerProps",
+      "kind": "interface",
       "locationInModule": {
-        "filename": "src/extensions/CloudMapExtension.ts",
-        "line": 22
+        "filename": "src/platform/ApplicationLoadBalancer.ts",
+        "line": 23
       },
-      "methods": [
+      "name": "ApplicationLoadBalancerProps",
+      "properties": [
         {
+          "abstract": true,
           "docs": {
-            "stability": "experimental",
-            "summary": "Adjust the security group of the given service to allow traffic from this service."
+            "stability": "experimental"
           },
+          "immutable": true,
           "locationInModule": {
-            "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 118
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 24
           },
-          "name": "connectToService",
-          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
-          "parameters": [
-            {
-              "name": "service",
-              "type": {
-                "fqn": "@aws-cdk-containers/ecs-service-extensions.Service"
-              }
-            },
-            {
-              "name": "_connectToProps",
-              "optional": true,
-              "type": {
+          "name": "fqdn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 26
+          },
+          "name": "userPool",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPool"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 27
+          },
+          "name": "userPoolClient",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPoolClient"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 28
+          },
+          "name": "userPoolDomain",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPoolDomain"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 25
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/platform/ApplicationLoadBalancer:ApplicationLoadBalancerProps"
+    },
+    "@btc-embedded/cdk-extensions.CloudMap": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.CloudMap",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/CloudMap.ts",
+          "line": 19
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.CloudMapProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/CloudMap.ts",
+        "line": 17
+      },
+      "name": "CloudMap",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 18
+          },
+          "name": "namespace",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_servicediscovery.PrivateDnsNamespace"
+          }
+        }
+      ],
+      "symbolId": "src/platform/CloudMap:CloudMap"
+    },
+    "@btc-embedded/cdk-extensions.CloudMapExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.CloudMapExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/CloudMapExtension.ts",
+          "line": 25
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.CloudMapExtensionProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/CloudMapExtension.ts",
+        "line": 22
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Adjust the security group of the given service to allow traffic from this service."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/CloudMapExtension.ts",
+            "line": 118
+          },
+          "name": "connectToService",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "service",
+              "type": {
+                "fqn": "@aws-cdk-containers/ecs-service-extensions.Service"
+              }
+            },
+            {
+              "name": "_connectToProps",
+              "optional": true,
+              "type": {
                 "fqn": "@aws-cdk-containers/ecs-service-extensions.ConnectToProps"
               }
             }
@@ -4537,6 +4952,54 @@
       ],
       "symbolId": "src/extensions/CloudMapExtension:CloudMapExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.CloudMapProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.CloudMapProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/CloudMap.ts",
+        "line": 12
+      },
+      "name": "CloudMapProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 14
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 13
+          },
+          "name": "privateDnsNamespace",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps"
+          }
+        }
+      ],
+      "symbolId": "src/platform/CloudMap:CloudMapProps"
+    },
     "@btc-embedded/cdk-extensions.ContainerProps": {
       "assembly": "@btc-embedded/cdk-extensions",
       "datatype": true,
@@ -4575,6 +5038,287 @@
       ],
       "symbolId": "src/extensions/ExtraContainerExtension:ContainerProps"
     },
+    "@btc-embedded/cdk-extensions.DefaultUserPoolClients": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Create default user pool clients for the frontend and API access."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.DefaultUserPoolClients",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/DefaultUserPoolClients.ts",
+          "line": 26
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/DefaultUserPoolClients.ts",
+        "line": 22
+      },
+      "name": "DefaultUserPoolClients",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 24
+          },
+          "name": "apiClient",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPoolClient"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 23
+          },
+          "name": "frontendClient",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPoolClient"
+          }
+        }
+      ],
+      "symbolId": "src/platform/DefaultUserPoolClients:DefaultUserPoolClients"
+    },
+    "@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.DefaultUserPoolClientsProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/DefaultUserPoolClients.ts",
+        "line": 12
+      },
+      "name": "DefaultUserPoolClientsProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 15
+          },
+          "name": "callbackUrls",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 16
+          },
+          "name": "fqdn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 14
+          },
+          "name": "logoutUrls",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DefaultUserPoolClients.ts",
+            "line": 13
+          },
+          "name": "userPool",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cognito.IUserPool"
+          }
+        }
+      ],
+      "symbolId": "src/platform/DefaultUserPoolClients:DefaultUserPoolClientsProps"
+    },
+    "@btc-embedded/cdk-extensions.DocumentDB": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.DocumentDB",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/DocumentDB.ts",
+          "line": 23
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.DocumentDBProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/DocumentDB.ts",
+        "line": 20
+      },
+      "name": "DocumentDB",
+      "symbolId": "src/platform/DocumentDB:DocumentDB"
+    },
+    "@btc-embedded/cdk-extensions.DocumentDBProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.DocumentDBProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/DocumentDB.ts",
+        "line": 13
+      },
+      "name": "DocumentDBProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DocumentDB.ts",
+            "line": 16
+          },
+          "name": "secretName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DocumentDB.ts",
+            "line": 14
+          },
+          "name": "stackName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DocumentDB.ts",
+            "line": 15
+          },
+          "name": "username",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/DocumentDB.ts",
+            "line": 17
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/platform/DocumentDB:DocumentDBProps"
+    },
     "@btc-embedded/cdk-extensions.DocumentDbAccessExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4588,7 +5332,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/DocumentDbAccessExtension.ts",
-          "line": 52
+          "line": 56
         },
         "parameters": [
           {
@@ -4602,7 +5346,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/DocumentDbAccessExtension.ts",
-        "line": 49
+        "line": 51
       },
       "methods": [
         {
@@ -4612,11 +5356,37 @@
           },
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 57
+            "line": 72
           },
           "name": "addHooks",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
         },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "A hook that is called for each extension ahead of time to allow for any initial setup, such as creating resources in advance."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/DocumentDbAccessExtension.ts",
+            "line": 61
+          },
+          "name": "prehook",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "parent",
+              "type": {
+                "fqn": "@aws-cdk-containers/ecs-service-extensions.Service"
+              }
+            },
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            }
+          ]
+        },
         {
           "docs": {
             "remarks": "It is generally used to\ncreate any final resources which might depend on the service itself.",
@@ -4625,7 +5395,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 75
+            "line": 90
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4657,12 +5427,25 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 50
+            "line": 52
           },
           "name": "props",
           "type": {
             "fqn": "@btc-embedded/cdk-extensions.DocumentDbAccessExtensionProps"
           }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/extensions/DocumentDbAccessExtension.ts",
+            "line": 54
+          },
+          "name": "secretArn",
+          "type": {
+            "primitive": "string"
+          }
         }
       ],
       "symbolId": "src/extensions/DocumentDbAccessExtension:DocumentDbAccessExtension"
@@ -4677,7 +5460,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/extensions/DocumentDbAccessExtension.ts",
-        "line": 12
+        "line": 14
       },
       "name": "DocumentDbAccessExtensionProps",
       "properties": [
@@ -4689,9 +5472,9 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 13
+            "line": 15
           },
-          "name": "secretArn",
+          "name": "basePlatformStackName",
           "type": {
             "primitive": "string"
           }
@@ -4704,7 +5487,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 14
+            "line": 16
           },
           "name": "securityGroupId",
           "type": {
@@ -5254,6 +6037,68 @@
       "name": "LogExtension",
       "symbolId": "src/extensions/LogExtension:LogExtension"
     },
+    "@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.PrivateDnsNamespaceProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/CloudMap.ts",
+        "line": 6
+      },
+      "name": "PrivateDnsNamespaceProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 7
+          },
+          "name": "arn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 8
+          },
+          "name": "id",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/CloudMap.ts",
+            "line": 9
+          },
+          "name": "namespace",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/platform/CloudMap:PrivateDnsNamespaceProps"
+    },
     "@btc-embedded/cdk-extensions.TcpKeepAliveExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -5380,6 +6225,6 @@
       "symbolId": "src/extensions/TcpKeepAliveExtension:TcpKeepAliveExtensionProps"
     }
   },
-  "version": "0.1.1",
-  "fingerprint": "YC5Pj963HAa3uY2DqRHUcX0h2nfiwatGZth1J0TfbGc="
+  "version": "0.3.0",
+  "fingerprint": "0AM71TVyNCK8jiZYx/YZthuh2Wlbpn7NP2IzsB+Tk5I="
 }