@btc-embedded/cdk-extensions 0.22.3 → 0.22.5

package/.jsii

@@ -9969,6 +9969,64 @@
       ],
       "symbolId": "src/platform/CognitoUserPool:AppOpenIdParameters"
     },
+    "@btc-embedded/cdk-extensions.ApplicationContainer": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.Container",
+      "docs": {
+        "example": "// Full health check control (escape hatch)\nnew ApplicationContainer({\n  cpu: 1024,\n  memoryMiB: 2048,\n  image: EcrImage.fromDockerImageAsset(image),\n  trafficPort: 3000,\n  healthCheck: {\n    command: ['CMD-SHELL', 'custom-health-check.sh'],\n    interval: Duration.seconds(30),\n  },\n});",
+        "remarks": "This extension extends the upstream Container class and provides:\n1. Simplified health check API via `healthCheckEndpoint`\n2. Full access to all ContainerDefinitionOptions (user, privileged, workingDirectory, etc.)\n3. Drop-in replacement for Container with additional features\n\n**Replaces the need for:** Container + ModifyContainerDefinitionExtension",
+        "stability": "experimental",
+        "summary": "An application container with built-in support for simplified health checks and all container definition options."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ApplicationContainer",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/ApplicationContainer.ts",
+          "line": 108
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "The settings for the container."
+            },
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.ApplicationContainerProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/ApplicationContainer.ts",
+        "line": 107
+      },
+      "name": "ApplicationContainer",
+      "symbolId": "src/extensions/ApplicationContainer:ApplicationContainer"
+    },
+    "@btc-embedded/cdk-extensions.ApplicationContainerProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "remarks": "**Required properties:**\n- cpu: How much CPU the container requires\n- memoryMiB: How much memory in megabytes the container requires\n- image: The image to run\n- trafficPort: What port the image listens for traffic on",
+        "stability": "experimental",
+        "summary": "Properties for ApplicationContainer. All properties from EnhancedContainerProps are supported."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ApplicationContainerProps",
+      "interfaces": [
+        "@btc-embedded/cdk-extensions.EnhancedContainerProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/extensions/ApplicationContainer.ts",
+        "line": 56
+      },
+      "name": "ApplicationContainerProps",
+      "symbolId": "src/extensions/ApplicationContainer:ApplicationContainerProps"
+    },
     "@btc-embedded/cdk-extensions.ApplicationLoadBalancer": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
@@ -12217,8 +12275,8 @@
       "fqn": "@btc-embedded/cdk-extensions.ContainerDependency",
       "kind": "interface",
       "locationInModule": {
-        "filename": "src/extensions/ExtraContainerExtension.ts",
-        "line": 11
+        "filename": "src/extensions/container-common.ts",
+        "line": 10
       },
       "name": "ContainerDependency",
       "properties": [
@@ -12230,8 +12288,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 15
+            "filename": "src/extensions/container-common.ts",
+            "line": 14
           },
           "name": "ext",
           "type": {
@@ -12248,8 +12306,8 @@
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 24
+            "filename": "src/extensions/container-common.ts",
+            "line": 23
           },
           "name": "condition",
           "optional": true,
@@ -12258,67 +12316,7 @@
           }
         }
       ],
-      "symbolId": "src/extensions/ExtraContainerExtension:ContainerDependency"
-    },
-    "@btc-embedded/cdk-extensions.ContainerProps": {
-      "assembly": "@btc-embedded/cdk-extensions",
-      "datatype": true,
-      "docs": {
-        "stability": "experimental"
-      },
-      "fqn": "@btc-embedded/cdk-extensions.ContainerProps",
-      "interfaces": [
-        "aws-cdk-lib.aws_ecs.ContainerDefinitionOptions"
-      ],
-      "kind": "interface",
-      "locationInModule": {
-        "filename": "src/extensions/ExtraContainerExtension.ts",
-        "line": 27
-      },
-      "name": "ContainerProps",
-      "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "experimental",
-            "summary": "Specify additional container dependencies which should be added after the container has been created in the task definition."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 39
-          },
-          "name": "containerDependencies",
-          "optional": true,
-          "type": {
-            "collection": {
-              "elementtype": {
-                "fqn": "@btc-embedded/cdk-extensions.ContainerDependency"
-              },
-              "kind": "array"
-            }
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "default": "- A log group is automatically created for you if the `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` feature flag is set.",
-            "stability": "experimental",
-            "summary": "The log group into which application container logs should be routed."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 33
-          },
-          "name": "logGroup",
-          "optional": true,
-          "type": {
-            "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
-          }
-        }
-      ],
-      "symbolId": "src/extensions/ExtraContainerExtension:ContainerProps"
+      "symbolId": "src/extensions/container-common:ContainerDependency"
     },
     "@btc-embedded/cdk-extensions.DeactivatableServiceExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
@@ -14432,6 +14430,122 @@
       ],
       "symbolId": "src/extensions/EfsMountExtension:EfsMountExtensionProperties"
     },
+    "@btc-embedded/cdk-extensions.EnhancedContainerProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "remarks": "This interface is used by both ApplicationContainer and ExtraContainerExtension\nto provide a consistent API for container configuration.",
+        "stability": "experimental",
+        "summary": "Enhanced container properties that combine the required props from Container with all options from ContainerDefinitionOptions."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EnhancedContainerProps",
+      "interfaces": [
+        "aws-cdk-lib.aws_ecs.ContainerDefinitionOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/extensions/container-common.ts",
+        "line": 33
+      },
+      "name": "EnhancedContainerProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Specify additional container dependencies which should be added after the\ncontainer has been created in the task definition.",
+            "stability": "experimental",
+            "summary": "Container dependencies (used by ExtraContainerExtension)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/container-common.ts",
+            "line": 69
+          },
+          "name": "containerDependencies",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@btc-embedded/cdk-extensions.ContainerDependency"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no health check",
+            "remarks": "A curl-based health check will be auto-generated using the container's traffic port.\n\nExample: \"/health\" becomes:\n  curl -f http://localhost:3000/health || exit 1\n\nCannot be used with `healthCheck`.",
+            "stability": "experimental",
+            "summary": "Simplified health check - just specify the HTTP endpoint path."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/container-common.ts",
+            "line": 62
+          },
+          "name": "healthCheckEndpoint",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- A log group is automatically created for you if the `ECS_SERVICE_EXTENSIONS_ENABLE_DEFAULT_LOG_DRIVER` feature flag is set.",
+            "stability": "experimental",
+            "summary": "The log group into which application container logs should be routed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/container-common.ts",
+            "line": 49
+          },
+          "name": "logGroup",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "How much memory in megabytes the container requires."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/container-common.ts",
+            "line": 37
+          },
+          "name": "memoryMiB",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "What port the image listens for traffic on."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/container-common.ts",
+            "line": 42
+          },
+          "name": "trafficPort",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/container-common:EnhancedContainerProps"
+    },
     "@btc-embedded/cdk-extensions.EnvironmentVariableNames": {
       "assembly": "@btc-embedded/cdk-extensions",
       "datatype": true,
@@ -15180,7 +15294,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/ExtraContainerExtension.ts",
-          "line": 57
+          "line": 38
         },
         "parameters": [
           {
@@ -15203,7 +15317,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/ExtraContainerExtension.ts",
-        "line": 53
+        "line": 34
       },
       "methods": [
         {
@@ -15214,7 +15328,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 67
+            "line": 48
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -15243,7 +15357,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 76
+            "line": 57
           },
           "name": "useTaskDefinition",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -15266,7 +15380,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 54
+            "line": 35
           },
           "name": "containerName",
           "type": {
@@ -15280,7 +15394,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 63
+            "line": 44
           },
           "name": "dbAccess",
           "type": {
@@ -15294,7 +15408,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 118
+            "line": 115
           },
           "name": "healthCondition",
           "type": {
@@ -15308,7 +15422,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 55
+            "line": 36
           },
           "name": "props",
           "type": {
@@ -15328,34 +15442,37 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/extensions/ExtraContainerExtension.ts",
-        "line": 42
+        "line": 12
       },
       "name": "ExtraContainerExtensionProps",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "Container configuration using the enhanced container properties."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 43
+            "line": 16
           },
           "name": "container",
           "type": {
-            "fqn": "@btc-embedded/cdk-extensions.ContainerProps"
+            "fqn": "@btc-embedded/cdk-extensions.EnhancedContainerProps"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental"
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Whether this container needs database access."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 50
+            "line": 31
           },
           "name": "dbAccess",
           "optional": true,
@@ -15366,14 +15483,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Defaults to ContainerDependencyCondition.HEALTHY.",
+            "default": "ContainerDependencyCondition.HEALTHY",
             "stability": "experimental",
             "summary": "Specify the condition when this container should be considered healthy such that the main container can start."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/ExtraContainerExtension.ts",
-            "line": 49
+            "line": 24
           },
           "name": "healthCheckCondition",
           "optional": true,
@@ -19658,6 +19775,6 @@
       "symbolId": "src/platform/VpcV2:VpcV2Props"
     }
   },
-  "version": "0.22.3",
-  "fingerprint": "3ye4Xlv2ACmAtam4xKpWFQAb5stOVxC+B8MIcw6Q2lE="
+  "version": "0.22.5",
+  "fingerprint": "Do5FlF/4SIHmmIY4cIwzbrjJRVR2mLVpJNbeoGyCFkk="
 }