@btc-embedded/cdk-extensions 0.19.0 → 0.20.1

package/.jsii

@@ -7856,6 +7856,211 @@
       ],
       "symbolId": "src/extensions/DomainEventMessagingExtension:DomainEventMessagingExtension"
     },
+    "@btc-embedded/cdk-extensions.EcsCluster": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "This construct provides a standardized way to create ECS clusters with support for:\n- KMS encryption for ECS Exec command sessions\n- Fargate Spot capacity providers\n- Configurable capacity provider strategies with base and weight values\n\nThe cluster exports its name and VPC ID as stack parameters, allowing other stacks\nto import and reference the cluster using the `fromBasePlatform` static method.",
+        "stability": "experimental",
+        "summary": "A CDK construct that creates and configures an Amazon ECS cluster with optional features."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EcsCluster",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/EcsCluster.ts",
+          "line": 68
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.EcsClusterProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@btc-embedded/cdk-extensions.IEcsCluster"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/EcsCluster.ts",
+        "line": 35
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 36
+          },
+          "name": "fromBasePlatform",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "stackName",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.IEcsCluster"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "EcsCluster",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 66
+          },
+          "name": "cluster",
+          "overrides": "@btc-embedded/cdk-extensions.IEcsCluster",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.ICluster"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EcsCluster:EcsCluster"
+    },
+    "@btc-embedded/cdk-extensions.EcsClusterProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EcsClusterProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/EcsCluster.ts",
+        "line": 7
+      },
+      "name": "EcsClusterProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The VPC in which to create the ECS cluster."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 9
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The base value for the capacity provider strategy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 15
+          },
+          "name": "capacityProvidersBase",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The weight value for the capacity provider strategy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 17
+          },
+          "name": "capacityProvidersWeight",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Whether to create a KMS key for execute command encryption."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 11
+          },
+          "name": "createKmsExecCommandKey",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Whether to enable Fargate Spot capacity provider."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 13
+          },
+          "name": "enableFargateSpotCapacityProvider",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EcsCluster:EcsClusterProps"
+    },
     "@btc-embedded/cdk-extensions.EfsAccessMode": {
       "assembly": "@btc-embedded/cdk-extensions",
       "docs": {
@@ -9579,6 +9784,37 @@
       ],
       "symbolId": "src/platform/DocumentDB:IDocumentDB"
     },
+    "@btc-embedded/cdk-extensions.IEcsCluster": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.IEcsCluster",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/EcsCluster.ts",
+        "line": 20
+      },
+      "name": "IEcsCluster",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EcsCluster.ts",
+            "line": 21
+          },
+          "name": "cluster",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.ICluster"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EcsCluster:IEcsCluster"
+    },
     "@btc-embedded/cdk-extensions.IEfsFileSystem": {
       "assembly": "@btc-embedded/cdk-extensions",
       "docs": {
@@ -9762,6 +9998,37 @@
       ],
       "symbolId": "src/platform/Vpc:IVpc"
     },
+    "@btc-embedded/cdk-extensions.IVpcV2": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.IVpcV2",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/VpcV2.ts",
+        "line": 30
+      },
+      "name": "IVpcV2",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 31
+          },
+          "name": "vpcInstance",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/platform/VpcV2:IVpcV2"
+    },
     "@btc-embedded/cdk-extensions.ImportLogGroupOption": {
       "assembly": "@btc-embedded/cdk-extensions",
       "datatype": true,
@@ -12268,16 +12535,17 @@
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
       "docs": {
-        "stability": "experimental"
+        "deprecated": "This class is deprecated. Use {@link VpcV2 } and {@link EcsCluster } classes instead.",
+        "stability": "deprecated"
       },
       "fqn": "@btc-embedded/cdk-extensions.Vpc",
       "initializer": {
         "docs": {
-          "stability": "experimental"
+          "stability": "deprecated"
         },
         "locationInModule": {
           "filename": "src/platform/Vpc.ts",
-          "line": 74
+          "line": 77
         },
         "parameters": [
           {
@@ -12316,16 +12584,16 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/platform/Vpc.ts",
-        "line": 28
+        "line": 31
       },
       "methods": [
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "deprecated"
           },
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 29
+            "line": 32
           },
           "name": "fromBasePlatform",
           "parameters": [
@@ -12360,12 +12628,12 @@
       "properties": [
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "deprecated"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 63
+            "line": 66
           },
           "name": "clusterName",
           "overrides": "@btc-embedded/cdk-extensions.IVpc",
@@ -12375,12 +12643,12 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "deprecated"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 62
+            "line": 65
           },
           "name": "fqdn",
           "overrides": "@btc-embedded/cdk-extensions.IVpc",
@@ -12390,11 +12658,11 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "deprecated"
           },
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 61
+            "line": 64
           },
           "name": "cluster",
           "type": {
@@ -12403,11 +12671,11 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "deprecated"
           },
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 60
+            "line": 63
           },
           "name": "vpcInstance",
           "type": {
@@ -12513,8 +12781,201 @@
         }
       ],
       "symbolId": "src/platform/Vpc:VpcProps"
+    },
+    "@btc-embedded/cdk-extensions.VpcV2": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "Supports importing by VPC ID, VPC name, or creating a new VPC with a specified CIDR block.",
+        "stability": "experimental",
+        "summary": "A construct that creates or imports an existing VPC."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.VpcV2",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/VpcV2.ts",
+          "line": 61
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.VpcV2Props"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@btc-embedded/cdk-extensions.IVpcV2"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/VpcV2.ts",
+        "line": 38
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 39
+          },
+          "name": "fromBasePlatform",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "stackName",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.IVpcV2"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "VpcV2",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 59
+          },
+          "name": "vpcInstance",
+          "overrides": "@btc-embedded/cdk-extensions.IVpcV2",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/platform/VpcV2:VpcV2"
+    },
+    "@btc-embedded/cdk-extensions.VpcV2Props": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.VpcV2Props",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/VpcV2.ts",
+        "line": 10
+      },
+      "name": "VpcV2Props",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to 2.",
+            "stability": "experimental",
+            "summary": "The maximum number of Availability Zones to use when creating a new VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 27
+          },
+          "name": "maxAzs",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Required when creating a new VPC.",
+            "stability": "experimental",
+            "summary": "The IP address allocation strategy for creating a new VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 23
+          },
+          "name": "vpcCidr",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IIpAddresses"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "If provided, the VPC will be looked up by ID.",
+            "stability": "experimental",
+            "summary": "The ID of an existing VPC to import."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 14
+          },
+          "name": "vpcId",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "If importing an existing VPC, it will be looked up by this name.\nIf creating a new VPC, this will be used as the VPC name.",
+            "stability": "experimental",
+            "summary": "The name of the VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/VpcV2.ts",
+            "line": 19
+          },
+          "name": "vpcName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/platform/VpcV2:VpcV2Props"
     }
   },
-  "version": "0.19.0",
-  "fingerprint": "PTtUL8ij1itbN5bUSf2QnGCFLUp9zagwh/oAeirhWiI="
+  "version": "0.20.1",
+  "fingerprint": "5SR/cRAtkktltShy4QYYtlp7h+qJJtuma53MOp6Viu4="
 }