@btc-embedded/cdk-extensions 0.14.11 → 0.14.13

package/.jsii

@@ -5,7 +5,7 @@
     "roles": [
       "author"
     ],
-    "url": "https://btc-embedded.com"
+    "url": "https://www.btc-embedded.com"
   },
   "bundled": {
     "yaml": "^2.8.1"
@@ -3931,7 +3931,7 @@
   },
   "name": "@btc-embedded/cdk-extensions",
   "readme": {
-    "markdown": "# replace this"
+    "markdown": "# @btc-embedded/cdk-extensions\n\nA collection of reusable AWS CDK (Cloud Development Kit) extensions and constructs for building cloud infrastructure with TypeScript.\n\n## Features\n\n- **CDK Constructs**: Includes ready-to-use constructs for API Gateway, Application Load Balancer, Cognito, VPC, DocumentDB, and more.\n- **ECS Service Extensions**: Provides ECS service extensions for advanced container orchestration.\n- **Utilities**: Common utilities and helpers for stack parameters, value imports, and configuration parsing.\n- **Modular Extensions**: Easily extend AWS resources with features like logging, OpenTelemetry, EFS, Cloud Map, and custom containers.\n\n## Installation\n\n```sh\nyarn install @btc-embedded/cdk-extensions\n```\n\n## Usage Example\n\n```typescript\nimport { ApiGateway } from \"@btc-embedded/cdk-extensions\";\n\n// Use constructs and extensions in your CDK app\n```\n\n## Documentation\n\n- [API Reference](./API.md)\n\n## License\n\nApache-2.0 © BTC Embedded Systems AG\n"
   },
   "repository": {
     "type": "git",
@@ -4617,7 +4617,7 @@
         },
         "locationInModule": {
           "filename": "src/platform/ApplicationLoadBalancer.ts",
-          "line": 42
+          "line": 44
         },
         "parameters": [
           {
@@ -4643,7 +4643,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancer.ts",
-        "line": 35
+        "line": 36
       },
       "name": "ApplicationLoadBalancer",
       "properties": [
@@ -4654,7 +4654,21 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 36
+            "line": 38
+          },
+          "name": "listener",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationListener"
+          }
+        },
+        {
+          "docs": {
+            "stability": "deprecated"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/ApplicationLoadBalancer.ts",
+            "line": 37
           },
           "name": "loadbalancer",
           "type": {
@@ -4668,7 +4682,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 38
+            "line": 40
           },
           "name": "loadBalancer",
           "type": {
@@ -4692,7 +4706,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-          "line": 89
+          "line": 90
         },
         "parameters": [
           {
@@ -4706,7 +4720,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-        "line": 79
+        "line": 80
       },
       "methods": [
         {
@@ -4716,7 +4730,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 95
+            "line": 96
           },
           "name": "addHooks",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
@@ -4728,7 +4742,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 164
+            "line": 168
           },
           "name": "modifyServiceProps",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4753,7 +4767,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 117
+            "line": 118
           },
           "name": "prehook",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4765,7 +4779,7 @@
               }
             },
             {
-              "name": "scope",
+              "name": "_scope",
               "type": {
                 "fqn": "constructs.Construct"
               }
@@ -4780,7 +4794,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 171
+            "line": 175
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -4812,7 +4826,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 87
+            "line": 88
           },
           "name": "fqdn",
           "type": {
@@ -4825,7 +4839,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 83
+            "line": 84
           },
           "name": "userPool",
           "type": {
@@ -4838,7 +4852,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 84
+            "line": 85
           },
           "name": "userPoolClient",
           "type": {
@@ -4851,7 +4865,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
-            "line": 85
+            "line": 86
           },
           "name": "userPoolDomain",
           "type": {
@@ -4951,6 +4965,22 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/ApplicationLoadBalancerExtension.ts",
+            "line": 43
+          },
+          "name": "listener",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationListener"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -5113,7 +5143,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtensionV2.ts",
-            "line": 114
+            "line": 113
           },
           "name": "modifyServiceProps",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -5150,7 +5180,7 @@
               }
             },
             {
-              "name": "scope",
+              "name": "_scope",
               "type": {
                 "fqn": "constructs.Construct"
               }
@@ -5165,7 +5195,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ApplicationLoadBalancerExtensionV2.ts",
-            "line": 121
+            "line": 120
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -5242,7 +5272,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancer.ts",
-        "line": 24
+        "line": 25
       },
       "name": "ApplicationLoadBalancerProps",
       "properties": [
@@ -5254,7 +5284,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 25
+            "line": 26
           },
           "name": "fqdn",
           "type": {
@@ -5269,7 +5299,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 30
+            "line": 31
           },
           "name": "hostedZone",
           "type": {
@@ -5284,7 +5314,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 27
+            "line": 28
           },
           "name": "userPool",
           "type": {
@@ -5299,7 +5329,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 28
+            "line": 29
           },
           "name": "userPoolClient",
           "type": {
@@ -5314,7 +5344,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 29
+            "line": 30
           },
           "name": "userPoolDomain",
           "type": {
@@ -5329,7 +5359,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancer.ts",
-            "line": 26
+            "line": 27
           },
           "name": "vpc",
           "type": {
@@ -7337,7 +7367,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 60
+            "line": 59
           },
           "name": "addHooks",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
@@ -7361,7 +7391,7 @@
               }
             },
             {
-              "name": "scope",
+              "name": "_scope",
               "type": {
                 "fqn": "constructs.Construct"
               }
@@ -7376,7 +7406,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/DocumentDbAccessExtension.ts",
-            "line": 68
+            "line": 67
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7730,6 +7760,254 @@
       ],
       "symbolId": "src/extensions/DomainEventMessagingExtension:DomainEventMessagingExtension"
     },
+    "@btc-embedded/cdk-extensions.EfsAccessMode": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Access modes for the Efs."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/extensions/EfsMountExtension.ts",
+        "line": 13
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Access is read-only."
+          },
+          "name": "READ_ONLY"
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Read-write access."
+          },
+          "name": "READ_WRITE"
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Root access is granted (includes read-write access)."
+          },
+          "name": "ROOT_ACCESS"
+        }
+      ],
+      "name": "EfsAccessMode",
+      "symbolId": "src/extensions/EfsMountExtension:EfsAccessMode"
+    },
+    "@btc-embedded/cdk-extensions.EfsMountExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "remarks": "Multiple extensions instances can be used, when different mount points are specified.",
+        "stability": "experimental",
+        "summary": "Extension that allows to mount an EFS to a given mount point."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsMountExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/EfsMountExtension.ts",
+          "line": 58
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.EfsMountExtensionProperties"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/EfsMountExtension.ts",
+        "line": 52
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "It is generally used to\ncreate any final resources which might depend on the service itself.",
+            "stability": "experimental",
+            "summary": "When this hook is implemented by extension, it allows the extension to use the service which has been created."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 98
+          },
+          "name": "useService",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "service",
+              "type": {
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_ecs.Ec2Service"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_ecs.FargateService"
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Once the task definition is created, this hook is called for each extension to give it a chance to add containers to the task definition, change the task definition's role to add permissions, etc."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 67
+          },
+          "name": "useTaskDefinition",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "taskDefinition",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_ecs.TaskDefinition"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "EfsMountExtension",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 55
+          },
+          "name": "accessMode",
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 53
+          },
+          "name": "filesystem",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 54
+          },
+          "name": "path",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 56
+          },
+          "name": "volumeName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/EfsMountExtension:EfsMountExtension"
+    },
+    "@btc-embedded/cdk-extensions.EfsMountExtensionProperties": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "EFS extension properties."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsMountExtensionProperties",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/extensions/EfsMountExtension.ts",
+        "line": 31
+      },
+      "name": "EfsMountExtensionProperties",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The access mode for the filesystem for this service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 40
+          },
+          "name": "accessMode",
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The filesystem to be mounted."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 45
+          },
+          "name": "filesystem",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The path to mount the EFS to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/EfsMountExtension.ts",
+            "line": 35
+          },
+          "name": "path",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/EfsMountExtension:EfsMountExtensionProperties"
+    },
     "@btc-embedded/cdk-extensions.EnvironmentVariableNames": {
       "assembly": "@btc-embedded/cdk-extensions",
       "datatype": true,
@@ -9007,7 +9285,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/LogExtension.ts",
-            "line": 61
+            "line": 60
           },
           "name": "addHooks",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
@@ -9031,7 +9309,7 @@
               }
             },
             {
-              "name": "scope",
+              "name": "_scope",
               "type": {
                 "fqn": "constructs.Construct"
               }
@@ -9440,7 +9718,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/PostgresDbAccessExtension.ts",
-            "line": 234
+            "line": 229
           },
           "name": "addHooks",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
@@ -9452,7 +9730,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/PostgresDbAccessExtension.ts",
-            "line": 305
+            "line": 300
           },
           "name": "modifyServiceProps",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -9489,7 +9767,7 @@
               }
             },
             {
-              "name": "scope",
+              "name": "_scope",
               "type": {
                 "fqn": "constructs.Construct"
               }
@@ -9504,7 +9782,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/PostgresDbAccessExtension.ts",
-            "line": 250
+            "line": 245
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -9533,7 +9811,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/PostgresDbAccessExtension.ts",
-            "line": 258
+            "line": 253
           },
           "name": "useTaskDefinition",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -11527,6 +11805,6 @@
       "symbolId": "src/platform/Vpc:VpcProps"
     }
   },
-  "version": "0.14.11",
-  "fingerprint": "HT/Kb76hlPsheq1FEShs7TCAYq0xXBDilBS88VnjyAs="
+  "version": "0.14.13",
+  "fingerprint": "cl6L1GAACqmSQ1xeKtJzyKWwaEuVZyl5dmlzmRvpVq4="
 }