@btc-embedded/cdk-extensions 0.20.1 → 0.20.2

package/.jsii

@@ -5388,7 +5388,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 55
+            "line": 48
           },
           "name": "healtCheckPath",
           "type": {
@@ -5404,7 +5404,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 45
+            "line": 38
           },
           "name": "hostedZone",
           "type": {
@@ -5414,66 +5414,68 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "This name is used to register an A record in the given hosted zone.",
             "stability": "experimental",
-            "summary": "The domain prefix or record name for configuring the ALB domain."
+            "summary": "The port on which the target group will receive traffic."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 30
+            "line": 43
           },
-          "name": "recordName",
+          "name": "trafficPort",
           "type": {
-            "primitive": "string"
+            "primitive": "number"
           }
         },
         {
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "The port on which the target group will receive traffic."
+            "summary": "The Cognito User Pool of this base platform."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 50
+            "line": 33
           },
-          "name": "trafficPort",
+          "name": "userPool",
           "type": {
-            "primitive": "number"
+            "fqn": "@btc-embedded/cdk-extensions.ICognitoUserPool"
           }
         },
         {
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "The Cognito User Pool of this base platform."
+            "summary": "The VPC in which the Application Load Balancer will be deployed."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 40
+            "line": 28
           },
-          "name": "userPool",
+          "name": "vpc",
           "type": {
-            "fqn": "@btc-embedded/cdk-extensions.ICognitoUserPool"
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
           }
         },
         {
           "abstract": true,
           "docs": {
+            "default": "- zone root",
+            "remarks": "This name is used to register an A record in the given hosted zone. If not\nprovided, the zone's root will be used.",
             "stability": "experimental",
-            "summary": "The VPC in which the Application Load Balancer will be deployed."
+            "summary": "The domain prefix or record name for configuring the ALB domain."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 35
+            "line": 58
           },
-          "name": "vpc",
+          "name": "recordName",
+          "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+            "primitive": "string"
           }
         }
       ],
@@ -5494,7 +5496,7 @@
         },
         "locationInModule": {
           "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-          "line": 140
+          "line": 143
         },
         "parameters": [
           {
@@ -5520,7 +5522,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-        "line": 90
+        "line": 93
       },
       "methods": [
         {
@@ -5529,7 +5531,7 @@
           },
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 91
+            "line": 94
           },
           "name": "fromBasePlatform",
           "parameters": [
@@ -5569,7 +5571,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 138
+            "line": 141
           },
           "name": "domainName",
           "overrides": "@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base",
@@ -5584,7 +5586,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 137
+            "line": 140
           },
           "name": "targetGroup",
           "overrides": "@btc-embedded/cdk-extensions.ApplicationLoadBalancerV2Base",
@@ -5640,7 +5642,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-        "line": 69
+        "line": 72
       },
       "methods": [
         {
@@ -5649,7 +5651,7 @@
           },
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 76
+            "line": 79
           },
           "name": "addTarget",
           "overrides": "@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2",
@@ -5673,7 +5675,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 74
+            "line": 77
           },
           "name": "domainName",
           "overrides": "@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2",
@@ -5689,7 +5691,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 73
+            "line": 76
           },
           "name": "targetGroup",
           "overrides": "@btc-embedded/cdk-extensions.IApplicationLoadBalancerV2",
@@ -5710,7 +5712,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-        "line": 58
+        "line": 61
       },
       "name": "ApplicationLoadBalancerV2LookupOptions",
       "properties": [
@@ -5722,7 +5724,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 59
+            "line": 62
           },
           "name": "basePlatform",
           "type": {
@@ -6028,7 +6030,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/CloudMapExtension.ts",
-          "line": 27
+          "line": 45
         },
         "parameters": [
           {
@@ -6042,7 +6044,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/CloudMapExtension.ts",
-        "line": 22
+        "line": 34
       },
       "methods": [
         {
@@ -6052,7 +6054,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 104
+            "line": 135
           },
           "name": "connectToService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -6079,7 +6081,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 33
+            "line": 51
           },
           "name": "modifyServiceProps",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -6105,7 +6107,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 62
+            "line": 80
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -6136,7 +6138,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 23
+            "line": 35
           },
           "name": "props",
           "type": {
@@ -6149,12 +6151,28 @@
           },
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 25
+            "line": 37
           },
           "name": "serviceName",
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "docs": {
+            "remarks": "Available after the service has been configured.",
+            "stability": "experimental",
+            "summary": "The exported service construct, if exportService is enabled."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/CloudMapExtension.ts",
+            "line": 43
+          },
+          "name": "exportedServiceConstruct",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.ExportedService"
+          }
         }
       ],
       "symbolId": "src/extensions/CloudMapExtension:CloudMapExtension"
@@ -6169,7 +6187,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/extensions/CloudMapExtension.ts",
-        "line": 15
+        "line": 16
       },
       "name": "CloudMapExtensionProps",
       "properties": [
@@ -6182,12 +6200,31 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/CloudMapExtension.ts",
-            "line": 19
+            "line": 20
           },
           "name": "platformStackName",
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "When enabled, the service metadata (security group, namespace, port) is\nexported as stack parameters, allowing other stacks to import and connect\nto this service using ExportedService.fromAttributes().",
+            "stability": "experimental",
+            "summary": "Whether to export this service for cross-stack consumption."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/extensions/CloudMapExtension.ts",
+            "line": 31
+          },
+          "name": "exportService",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
         }
       ],
       "symbolId": "src/extensions/CloudMapExtension:CloudMapExtensionProps"
@@ -9012,6 +9049,371 @@
       ],
       "symbolId": "src/extensions/LogExtension:ExistingLogroupOption"
     },
+    "@btc-embedded/cdk-extensions.ExportedService": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "example": "// Consumer side\nconst exportedService = ExportedService.fromAttributes(scope, id, {\n  stackName: 'my-service-stack',\n  serviceName: 'my-service',\n  port: 8080,\n});\n\nexportedService.allowFrom(myService);\nconst url = exportedService.apiUrl();",
+        "remarks": "This construct enables cross-stack service connectivity by transporting service\nmetadata (security group ID and namespace) across stack boundaries using StackParameter.\nThe port must be specified when importing the service.\n\nOn the provider side (where the service is defined), use ExportedService\nwithin the CloudMapExtension to expose the service. On the consumer side,\nuse ExportedService.fromAttributes() to import the service with the port.",
+        "stability": "experimental",
+        "summary": "Represents an ECS service exported from another CDK stack."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ExportedService",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/constructs/ExportedService.ts",
+          "line": 245
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.ExportedServiceProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@btc-embedded/cdk-extensions.IExportedService"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/constructs/ExportedService.ts",
+        "line": 174
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "This method imports the service metadata (security group and namespace)\nthat was exported by the provider stack and constructs an IExportedService\ninstance that can be used for establishing connections.",
+            "returns": "An IExportedService instance",
+            "stability": "experimental",
+            "summary": "Import an ExportedService from another stack."
+          },
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 187
+          },
+          "name": "fromAttributes",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "- The scope in which to define the construct."
+              },
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "docs": {
+                "summary": "- The construct ID."
+              },
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "docs": {
+                "summary": "- The exported service lookup options (stackName, serviceName, and port)."
+              },
+              "name": "attrs",
+              "type": {
+                "fqn": "@btc-embedded/cdk-extensions.ExportedServiceLookupOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.IExportedService"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "This method adds a security group ingress rule allowing traffic from the\ngiven service to this exported service on its configured port.",
+            "stability": "experimental",
+            "summary": "Allow an ECS service to connect to this exported service."
+          },
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 132
+          },
+          "name": "allowFrom",
+          "overrides": "@btc-embedded/cdk-extensions.IExportedService",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "- The ECS service to allow connections from."
+              },
+              "name": "service",
+              "type": {
+                "fqn": "@aws-cdk-containers/ecs-service-extensions.Service"
+              }
+            },
+            {
+              "docs": {
+                "summary": "- Optional description for the security group rule."
+              },
+              "name": "description",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "remarks": "The URL format is: http://<service-name>.<namespace>:<port>/",
+            "returns": "The internal API URL",
+            "stability": "experimental",
+            "summary": "Get the internal API URL of the service."
+          },
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 109
+          },
+          "name": "apiUrl",
+          "overrides": "@btc-embedded/cdk-extensions.IExportedService",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "ExportedService",
+      "properties": [
+        {
+          "docs": {
+            "remarks": "This allows the ExportedService to be used with the standard CDK IConnectable\npattern for security group management.",
+            "stability": "experimental",
+            "summary": "Get the connections object for this service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 119
+          },
+          "name": "connections",
+          "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.Connections"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 83
+          },
+          "name": "namespaceName",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 84
+          },
+          "name": "port",
+          "protected": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The security group of the exported ECS service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 85
+          },
+          "name": "securityGroup",
+          "overrides": "@btc-embedded/cdk-extensions.IExportedService",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 82
+          },
+          "name": "serviceName",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/ExportedService:ExportedService"
+    },
+    "@btc-embedded/cdk-extensions.ExportedServiceLookupOptions": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for importing an ExportedService from another stack."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ExportedServiceLookupOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/ExportedService.ts",
+        "line": 15
+      },
+      "name": "ExportedServiceLookupOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The port on which the service is listening."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 29
+          },
+          "name": "port",
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the exported ECS service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 24
+          },
+          "name": "serviceName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the stack where the service was exported."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 19
+          },
+          "name": "stackName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/ExportedService:ExportedServiceLookupOptions"
+    },
+    "@btc-embedded/cdk-extensions.ExportedServiceProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for creating a new ExportedService."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.ExportedServiceProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/ExportedService.ts",
+        "line": 55
+      },
+      "name": "ExportedServiceProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The namespace name where the service is registered (CloudMap namespace)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 69
+          },
+          "name": "namespaceName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The security group of the ECS service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 64
+          },
+          "name": "securityGroup",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the ECS service being exported."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 59
+          },
+          "name": "serviceName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/ExportedService:ExportedServiceProps"
+    },
     "@btc-embedded/cdk-extensions.ExtraContainerExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -9533,7 +9935,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-        "line": 62
+        "line": 65
       },
       "methods": [
         {
@@ -9543,7 +9945,7 @@
           },
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 66
+            "line": 69
           },
           "name": "addTarget",
           "parameters": [
@@ -9566,7 +9968,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 64
+            "line": 67
           },
           "name": "domainName",
           "type": {
@@ -9581,7 +9983,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/ApplicationLoadBalancerV2.ts",
-            "line": 63
+            "line": 66
           },
           "name": "targetGroup",
           "type": {
@@ -9921,6 +10323,88 @@
       "name": "IEfsFileSystem",
       "symbolId": "src/platform/EfsFileSystem:IEfsFileSystem"
     },
+    "@btc-embedded/cdk-extensions.IExportedService": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Public interface for an ExportedService."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.IExportedService",
+      "interfaces": [
+        "aws-cdk-lib.aws_ec2.IConnectable"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/ExportedService.ts",
+        "line": 35
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Allow an ECS service to connect to this exported service."
+          },
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 49
+          },
+          "name": "allowFrom",
+          "parameters": [
+            {
+              "name": "service",
+              "type": {
+                "fqn": "@aws-cdk-containers/ecs-service-extensions.Service"
+              }
+            },
+            {
+              "name": "description",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ]
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Get the internal API URL of the service."
+          },
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 44
+          },
+          "name": "apiUrl",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "IExportedService",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The security group of the exported ECS service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/ExportedService.ts",
+            "line": 39
+          },
+          "name": "securityGroup",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/ExportedService:IExportedService"
+    },
     "@btc-embedded/cdk-extensions.IPrivateDnsNamespace": {
       "assembly": "@btc-embedded/cdk-extensions",
       "docs": {
@@ -12976,6 +13460,6 @@
       "symbolId": "src/platform/VpcV2:VpcV2Props"
     }
   },
-  "version": "0.20.1",
-  "fingerprint": "5SR/cRAtkktltShy4QYYtlp7h+qJJtuma53MOp6Viu4="
+  "version": "0.20.2",
+  "fingerprint": "uFvrwOGFoOtOSFC/aA0zlCVvW7LSSDqgbzX3YQMgAa0="
 }