@btc-embedded/cdk-extensions 0.5.6 → 0.5.7

package/.gitlab-ci.yml

@@ -23,7 +23,7 @@ release:
     - git config user.name "Gitlab Bot"
     - git config user.email "gitlab-bot@$CI_SERVER_FQDN"
   script:
-    - git checkout $CI_COMMIT_SHA
+    - git checkout $CI_COMMIT_BRANCH
     - yarn install
     - npx projen release
     - mv $temp_checkout_dir/dist  $CI_PROJECT_DIR/dist 

package/.jsii

@@ -3916,7 +3916,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/btc-embedded/cdk-extensions.git",
-  "jsiiVersion": "5.5.14 (build 992ecef)",
+  "jsiiVersion": "5.5.22 (build 06fa7a6)",
   "keywords": [
     "cdk"
   ],
@@ -4939,6 +4939,24 @@
       ],
       "symbolId": "src/extensions/CloudMapExtension:CloudMapExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.ContainerDefinitionExtensionProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ContainerDefinitionExtensionProps",
+      "interfaces": [
+        "aws-cdk-lib.aws_ecs.ContainerDefinitionOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/extensions/ModifyContainerDefinitionExtension.ts",
+        "line": 23
+      },
+      "name": "ContainerDefinitionExtensionProps",
+      "symbolId": "src/extensions/ModifyContainerDefinitionExtension:ContainerDefinitionExtensionProps"
+    },
     "@btc-embedded/cdk-extensions.ContainerDependency": {
       "assembly": "@btc-embedded/cdk-extensions",
       "datatype": true,
@@ -6081,6 +6099,306 @@
       "name": "LogExtension",
       "symbolId": "src/extensions/LogExtension:LogExtension"
     },
+    "@btc-embedded/cdk-extensions.ModifyContainerDefinitionExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "remarks": "Some container properties are not exposed the upstream ECS Container\nextension. This extension allows you to adjust the container definition\noptions after the Container extension has been added to the service.",
+        "see": "ContainerDefinitionOptions",
+        "stability": "experimental",
+        "summary": "An extension that allows modifying the main container definition options."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ModifyContainerDefinitionExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/ModifyContainerDefinitionExtension.ts",
+          "line": 38
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.ContainerDefinitionExtensionProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/ModifyContainerDefinitionExtension.ts",
+        "line": 35
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "A hook that allows the extension to add hooks to other extensions that are registered."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/ModifyContainerDefinitionExtension.ts",
+            "line": 43
+          },
+          "name": "addHooks",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
+        }
+      ],
+      "name": "ModifyContainerDefinitionExtension",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/ModifyContainerDefinitionExtension.ts",
+            "line": 36
+          },
+          "name": "props",
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.ContainerDefinitionExtensionProps"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/ModifyContainerDefinitionExtension:ModifyContainerDefinitionExtension"
+    },
+    "@btc-embedded/cdk-extensions.ModifyTaskDefinitionExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "stability": "experimental",
+        "summary": "An extension that allows modifying the task definition properties."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ModifyTaskDefinitionExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/ModifyTaskDefinitionExtension.ts",
+          "line": 10
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "aws-cdk-lib.aws_ecs.TaskDefinitionProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/ModifyTaskDefinitionExtension.ts",
+        "line": 7
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "For example, the App Mesh\nextension needs to configure an Envoy proxy in the task definition,\nor the Application extension wants to set the overall resource for\nthe task.",
+            "stability": "experimental",
+            "summary": "This is a hook which allows extensions to modify the settings of the task definition prior to it being created."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/ModifyTaskDefinitionExtension.ts",
+            "line": 15
+          },
+          "name": "modifyTaskDefinitionProps",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "props",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_ecs.TaskDefinitionProps"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_ecs.TaskDefinitionProps"
+            }
+          }
+        }
+      ],
+      "name": "ModifyTaskDefinitionExtension",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/ModifyTaskDefinitionExtension.ts",
+            "line": 8
+          },
+          "name": "props",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.TaskDefinitionProps"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/ModifyTaskDefinitionExtension:ModifyTaskDefinitionExtension"
+    },
+    "@btc-embedded/cdk-extensions.OpenTelemetryExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Adds the OpenTelemetry collector as a sidecar to the ECS task."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.OpenTelemetryExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/OpenTelemetryExtension.ts",
+          "line": 63
+        },
+        "parameters": [
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/OpenTelemetryExtension.ts",
+        "line": 60
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "A hook that allows the extension to add hooks to other extensions that are registered."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/OpenTelemetryExtension.ts",
+            "line": 88
+          },
+          "name": "addHooks",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension"
+        },
+        {
+          "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/OpenTelemetryExtension.ts",
+            "line": 68
+          },
+          "name": "useTaskDefinition",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "taskDefinition",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_ecs.TaskDefinition"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "OpenTelemetryExtension",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/OpenTelemetryExtension.ts",
+            "line": 61
+          },
+          "name": "props",
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/OpenTelemetryExtension:OpenTelemetryExtension"
+    },
+    "@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.OpenTelemetryExtensionProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/extensions/OpenTelemetryExtension.ts",
+        "line": 17
+      },
+      "name": "OpenTelemetryExtensionProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Extra environment settings to pass to the service container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/OpenTelemetryExtension.ts",
+            "line": 35
+          },
+          "name": "extraEnvSettings",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- use the service id",
+            "stability": "experimental",
+            "summary": "The name of the service to use in the OTel attributes."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/OpenTelemetryExtension.ts",
+            "line": 23
+          },
+          "name": "serviceName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- use the stack name",
+            "stability": "experimental",
+            "summary": "The namespace of the service to use in the OTel attributes."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/OpenTelemetryExtension.ts",
+            "line": 30
+          },
+          "name": "serviceNamespace",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/extensions/OpenTelemetryExtension:OpenTelemetryExtensionProps"
+    },
     "@btc-embedded/cdk-extensions.PostgresDbAccessExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7135,6 +7453,6 @@
       "symbolId": "src/platform/Vpc:VpcProps"
     }
   },
-  "version": "0.5.6",
-  "fingerprint": "RHbued//KKt01401n6oUVmKhKGUWyvPsVjjNfL2S/fY="
+  "version": "0.5.7",
+  "fingerprint": "ZD/WS/v/ZVO3YVxBFgkXw0AqF1CEn/5WR90OQiiFWvU="
 }