@composurecdk/ec2 0.8.4 → 0.8.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +200 -0
  2. package/dist/commonjs/index.d.ts +4 -0
  3. package/dist/commonjs/index.d.ts.map +1 -1
  4. package/dist/commonjs/index.js +7 -1
  5. package/dist/commonjs/index.js.map +1 -1
  6. package/dist/commonjs/interface-endpoint-alarm-config.d.ts +34 -0
  7. package/dist/commonjs/interface-endpoint-alarm-config.d.ts.map +1 -0
  8. package/dist/commonjs/interface-endpoint-alarm-config.js +3 -0
  9. package/dist/commonjs/interface-endpoint-alarm-config.js.map +1 -0
  10. package/dist/commonjs/interface-endpoint-alarm-defaults.d.ts +13 -0
  11. package/dist/commonjs/interface-endpoint-alarm-defaults.d.ts.map +1 -0
  12. package/dist/commonjs/interface-endpoint-alarm-defaults.js +28 -0
  13. package/dist/commonjs/interface-endpoint-alarm-defaults.js.map +1 -0
  14. package/dist/commonjs/interface-endpoint-alarms.d.ts +13 -0
  15. package/dist/commonjs/interface-endpoint-alarms.d.ts.map +1 -0
  16. package/dist/commonjs/interface-endpoint-alarms.js +58 -0
  17. package/dist/commonjs/interface-endpoint-alarms.js.map +1 -0
  18. package/dist/commonjs/interface-endpoint-builder.d.ts +135 -0
  19. package/dist/commonjs/interface-endpoint-builder.d.ts.map +1 -0
  20. package/dist/commonjs/interface-endpoint-builder.js +126 -0
  21. package/dist/commonjs/interface-endpoint-builder.js.map +1 -0
  22. package/dist/commonjs/interface-endpoint-defaults.d.ts +14 -0
  23. package/dist/commonjs/interface-endpoint-defaults.d.ts.map +1 -0
  24. package/dist/commonjs/interface-endpoint-defaults.js +27 -0
  25. package/dist/commonjs/interface-endpoint-defaults.js.map +1 -0
  26. package/dist/esm/index.d.ts +4 -0
  27. package/dist/esm/index.d.ts.map +1 -1
  28. package/dist/esm/index.js +3 -0
  29. package/dist/esm/index.js.map +1 -1
  30. package/dist/esm/interface-endpoint-alarm-config.d.ts +34 -0
  31. package/dist/esm/interface-endpoint-alarm-config.d.ts.map +1 -0
  32. package/dist/esm/interface-endpoint-alarm-config.js +2 -0
  33. package/dist/esm/interface-endpoint-alarm-config.js.map +1 -0
  34. package/dist/esm/interface-endpoint-alarm-defaults.d.ts +13 -0
  35. package/dist/esm/interface-endpoint-alarm-defaults.d.ts.map +1 -0
  36. package/dist/esm/interface-endpoint-alarm-defaults.js +25 -0
  37. package/dist/esm/interface-endpoint-alarm-defaults.js.map +1 -0
  38. package/dist/esm/interface-endpoint-alarms.d.ts +13 -0
  39. package/dist/esm/interface-endpoint-alarms.d.ts.map +1 -0
  40. package/dist/esm/interface-endpoint-alarms.js +55 -0
  41. package/dist/esm/interface-endpoint-alarms.js.map +1 -0
  42. package/dist/esm/interface-endpoint-builder.d.ts +135 -0
  43. package/dist/esm/interface-endpoint-builder.d.ts.map +1 -0
  44. package/dist/esm/interface-endpoint-builder.js +123 -0
  45. package/dist/esm/interface-endpoint-builder.js.map +1 -0
  46. package/dist/esm/interface-endpoint-defaults.d.ts +14 -0
  47. package/dist/esm/interface-endpoint-defaults.d.ts.map +1 -0
  48. package/dist/esm/interface-endpoint-defaults.js +24 -0
  49. package/dist/esm/interface-endpoint-defaults.js.map +1 -0
  50. package/package.json +16 -5
@@ -0,0 +1,126 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createInterfaceEndpointBuilder = createInterfaceEndpointBuilder;
4
+ const aws_ec2_1 = require("aws-cdk-lib/aws-ec2");
5
+ const core_1 = require("@composurecdk/core");
6
+ const cloudformation_1 = require("@composurecdk/cloudformation");
7
+ const cloudwatch_1 = require("@composurecdk/cloudwatch");
8
+ const security_group_builder_js_1 = require("./security-group-builder.js");
9
+ const interface_endpoint_defaults_js_1 = require("./interface-endpoint-defaults.js");
10
+ const interface_endpoint_alarms_js_1 = require("./interface-endpoint-alarms.js");
11
+ class InterfaceEndpointBuilder {
12
+ props = {};
13
+ #access = [];
14
+ #customAlarms = [];
15
+ #vpc;
16
+ #securityGroups;
17
+ /**
18
+ * Sets the VPC the endpoint is created in. Accepts a concrete {@link IVpc}
19
+ * or a {@link Ref} to a sibling {@link IVpcBuilder}.
20
+ */
21
+ vpc(vpc) {
22
+ this.#vpc = vpc;
23
+ return this;
24
+ }
25
+ /**
26
+ * Bring-your-own security groups. Each entry is a {@link Resolvable}, so it
27
+ * can be a concrete {@link ISecurityGroup} or a {@link Ref} to a sibling
28
+ * `SecurityGroupBuilder` — giving you full ingress/egress/port control. When
29
+ * set, the builder creates no security group of its own and
30
+ * {@link InterfaceEndpointBuilderResult.securityGroup} is `undefined`.
31
+ *
32
+ * Mutually exclusive with {@link allowDefaultPortFrom}.
33
+ */
34
+ securityGroups(securityGroups) {
35
+ this.#securityGroups = securityGroups;
36
+ return this;
37
+ }
38
+ /**
39
+ * Managed-SG shortcut: wires `peer` to the auto-created security group via
40
+ * CDK's `endpoint.connections.allowDefaultPortFrom(peer)` — opening ingress
41
+ * on the managed SG from `peer`'s SG **and** egress from `peer`'s SG to the
42
+ * managed SG, on the service's default port (443 for AWS services).
43
+ *
44
+ * Because this delegates to CDK connections, `peer` must be an
45
+ * {@link IConnectable} (e.g. a `SecurityGroup` or `Instance`), not a raw
46
+ * `IPeer` (e.g. `Peer.ipv4(...)`). For CIDR-based rules use BYO mode with
47
+ * an explicit `addIngressRule` on your own {@link SecurityGroupBuilder}.
48
+ *
49
+ * Mutually exclusive with {@link securityGroups}.
50
+ */
51
+ allowDefaultPortFrom(peer, description) {
52
+ this.#access.push({ peer, description });
53
+ return this;
54
+ }
55
+ /**
56
+ * Adds a custom CloudWatch alarm alongside the recommended ones. The
57
+ * callback receives an {@link AlarmDefinitionBuilder} typed to the
58
+ * `InterfaceVpcEndpoint` construct, giving access to the endpoint at
59
+ * build time for metric dimension wiring.
60
+ */
61
+ addAlarm(key, configure) {
62
+ this.#customAlarms.push(configure(new cloudwatch_1.AlarmDefinitionBuilder(key)));
63
+ return this;
64
+ }
65
+ /** @internal — see ADR-0005. */
66
+ [core_1.COPY_STATE](target) {
67
+ target.#vpc = this.#vpc;
68
+ target.#securityGroups = this.#securityGroups ? [...this.#securityGroups] : undefined;
69
+ target.#access.push(...this.#access);
70
+ target.#customAlarms.push(...this.#customAlarms);
71
+ }
72
+ build(scope, id, context) {
73
+ const resolvedVpc = this.#vpc ? (0, core_1.resolve)(this.#vpc, context) : undefined;
74
+ if (!resolvedVpc) {
75
+ throw new Error(`InterfaceEndpointBuilder "${id}" requires a VPC. Call .vpc() with an IVpc or a Ref to one.`);
76
+ }
77
+ const { recommendedAlarms: alarmConfig, service, ...endpointProps } = this.props;
78
+ if (service === undefined) {
79
+ throw new Error(`InterfaceEndpointBuilder "${id}" requires a service. ` +
80
+ "Call .service() with an InterfaceVpcEndpointAwsService or a custom IInterfaceVpcEndpointService.");
81
+ }
82
+ const byo = this.#securityGroups;
83
+ if (byo !== undefined && this.#access.length > 0) {
84
+ throw new Error(`InterfaceEndpointBuilder "${id}": .allowDefaultPortFrom() applies only to the ` +
85
+ "auto-created security group and cannot be combined with .securityGroups() — " +
86
+ "add the ingress rule to your own SecurityGroupBuilder instead.");
87
+ }
88
+ let managedSecurityGroup;
89
+ let securityGroups;
90
+ if (byo !== undefined) {
91
+ securityGroups = byo.map((sg) => (0, core_1.resolve)(sg, context));
92
+ }
93
+ else {
94
+ managedSecurityGroup = (0, security_group_builder_js_1.createSecurityGroupBuilder)()
95
+ .vpc(resolvedVpc)
96
+ .description(`Interface endpoint ${id}`)
97
+ .build(scope, `${id}Sg`).securityGroup;
98
+ securityGroups = [managedSecurityGroup];
99
+ }
100
+ const endpoint = new aws_ec2_1.InterfaceVpcEndpoint(scope, id, {
101
+ ...interface_endpoint_defaults_js_1.INTERFACE_ENDPOINT_DEFAULTS,
102
+ ...endpointProps,
103
+ service,
104
+ vpc: resolvedVpc,
105
+ securityGroups,
106
+ // Always explicit: `open: true` would silently add a VPC-wide :443 rule.
107
+ open: false,
108
+ });
109
+ for (const rule of this.#access) {
110
+ endpoint.connections.allowDefaultPortFrom((0, core_1.resolve)(rule.peer, context), rule.description);
111
+ }
112
+ const alarms = (0, interface_endpoint_alarms_js_1.createInterfaceEndpointAlarms)(scope, id, endpoint, alarmConfig, this.#customAlarms);
113
+ return { endpoint, securityGroup: managedSecurityGroup, alarms };
114
+ }
115
+ }
116
+ /**
117
+ * Creates a new {@link IInterfaceEndpointBuilder} for a single VPC interface
118
+ * endpoint. The returned builder exposes every
119
+ * {@link InterfaceEndpointBuilderProps} property as a fluent setter/getter,
120
+ * plus `.vpc()`, `.securityGroups()` (BYO), and `.allowDefaultPortFrom()`
121
+ * (managed-SG shortcut).
122
+ */
123
+ function createInterfaceEndpointBuilder() {
124
+ return (0, cloudformation_1.taggedBuilder)(InterfaceEndpointBuilder);
125
+ }
126
+ //# sourceMappingURL=interface-endpoint-builder.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-builder.js","sourceRoot":"","sources":["../../src/interface-endpoint-builder.ts"],"names":[],"mappings":";;AA6PA,wEAIC;AAhQD,iDAO6B;AAE7B,6CAA0F;AAC1F,iEAAkF;AAClF,yDAAkE;AAClE,2EAAyE;AACzE,qFAA+E;AAE/E,iFAA+E;AA2F/E,MAAM,wBAAwB;IAC5B,KAAK,GAA2C,EAAE,CAAC;IAC1C,OAAO,GAAiB,EAAE,CAAC;IAC3B,aAAa,GAAmD,EAAE,CAAC;IAC5E,IAAI,CAAoB;IACxB,eAAe,CAAgC;IAE/C;;;OAGG;IACH,GAAG,CAAC,GAAqB;QACvB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAC,cAA4C;QACzD,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,IAA8B,EAAE,WAAoB;QACvE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CACN,GAAW,EACX,SAEiD;QAEjD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,mCAAsB,CAAuB,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,CAAC,iBAAU,CAAC,CAAC,MAAgC;QAC3C,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CACH,KAAiB,EACjB,EAAU,EACV,OAAgC;QAEhC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxE,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,6BAA6B,EAAE,6DAA6D,CAC7F,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,6BAA6B,EAAE,wBAAwB;gBACrD,kGAAkG,CACrG,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;QACjC,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,6BAA6B,EAAE,iDAAiD;gBAC9E,8EAA8E;gBAC9E,gEAAgE,CACnE,CAAC;QACJ,CAAC;QAED,IAAI,oBAA+C,CAAC;QACpD,IAAI,cAAgC,CAAC;QACrC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,cAAc,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,oBAAoB,GAAG,IAAA,sDAA0B,GAAE;iBAChD,GAAG,CAAC,WAAW,CAAC;iBAChB,WAAW,CAAC,sBAAsB,EAAE,EAAE,CAAC;iBACvC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,aAAa,CAAC;YACzC,cAAc,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,8BAAoB,CAAC,KAAK,EAAE,EAAE,EAAE;YACnD,GAAG,4DAA2B;YAC9B,GAAG,aAAa;YAChB,OAAO;YACP,GAAG,EAAE,WAAW;YAChB,cAAc;YACd,yEAAyE;YACzE,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;QAEH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,QAAQ,CAAC,WAAW,CAAC,oBAAoB,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,MAAM,GAAG,IAAA,4DAA6B,EAC1C,KAAK,EACL,EAAE,EACF,QAAQ,EACR,WAAW,EACX,IAAI,CAAC,aAAa,CACnB,CAAC;QAEF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;IACnE,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAgB,8BAA8B;IAC5C,OAAO,IAAA,8BAAa,EAClB,wBAAwB,CACzB,CAAC;AACJ,CAAC"}
@@ -0,0 +1,14 @@
1
+ import type { InterfaceVpcEndpointProps } from "aws-cdk-lib/aws-ec2";
2
+ /**
3
+ * Secure, AWS-recommended defaults applied to every interface endpoint built
4
+ * with {@link createInterfaceEndpointBuilder}. Each property can be
5
+ * individually overridden via the builder's fluent API.
6
+ *
7
+ * Note `open` is intentionally *not* here: the builder always sets it to
8
+ * `false` (see the builder's `build()`). Allowing it through would silently
9
+ * add a VPC-wide rule to the managed security group behind the caller's back;
10
+ * ingress is always explicit — via `.allowDefaultPortFrom()` (managed SG) or
11
+ * the BYO `SecurityGroupBuilder`.
12
+ */
13
+ export declare const INTERFACE_ENDPOINT_DEFAULTS: Partial<InterfaceVpcEndpointProps>;
14
+ //# sourceMappingURL=interface-endpoint-defaults.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-defaults.d.ts","sourceRoot":"","sources":["../../src/interface-endpoint-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAErE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2BAA2B,EAAE,OAAO,CAAC,yBAAyB,CAW1E,CAAC"}
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.INTERFACE_ENDPOINT_DEFAULTS = void 0;
4
+ /**
5
+ * Secure, AWS-recommended defaults applied to every interface endpoint built
6
+ * with {@link createInterfaceEndpointBuilder}. Each property can be
7
+ * individually overridden via the builder's fluent API.
8
+ *
9
+ * Note `open` is intentionally *not* here: the builder always sets it to
10
+ * `false` (see the builder's `build()`). Allowing it through would silently
11
+ * add a VPC-wide rule to the managed security group behind the caller's back;
12
+ * ingress is always explicit — via `.allowDefaultPortFrom()` (managed SG) or
13
+ * the BYO `SecurityGroupBuilder`.
14
+ */
15
+ exports.INTERFACE_ENDPOINT_DEFAULTS = {
16
+ /**
17
+ * Private DNS enables `<service>.<region>.amazonaws.com` to resolve to the
18
+ * endpoint ENIs instead of the public service IP addresses, keeping traffic
19
+ * on the AWS network without requiring application-level changes. Disabled
20
+ * by default in raw CDK; always on here because every AWS-service use case
21
+ * requires it for transparent private access.
22
+ *
23
+ * @see https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/sec_network_protection_private_connectivity.html
24
+ */
25
+ privateDnsEnabled: true,
26
+ };
27
+ //# sourceMappingURL=interface-endpoint-defaults.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-defaults.js","sourceRoot":"","sources":["../../src/interface-endpoint-defaults.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACU,QAAA,2BAA2B,GAAuC;IAC7E;;;;;;;;OAQG;IACH,iBAAiB,EAAE,IAAI;CACxB,CAAC"}
@@ -14,6 +14,10 @@ export { createVpcBuilder, type FlowLogsConfig, type IVpcBuilder, type VpcBuilde
14
14
  export { VPC_DEFAULTS } from "./vpc-defaults.js";
15
15
  export { createSecurityGroupBuilder, type ISecurityGroupBuilder, type SecurityGroupBuilderProps, type SecurityGroupBuilderResult, } from "./security-group-builder.js";
16
16
  export { SECURITY_GROUP_DEFAULTS } from "./security-group-defaults.js";
17
+ export { createInterfaceEndpointBuilder, type IInterfaceEndpointBuilder, type InterfaceEndpointBuilderProps, type InterfaceEndpointBuilderResult, } from "./interface-endpoint-builder.js";
18
+ export { INTERFACE_ENDPOINT_DEFAULTS } from "./interface-endpoint-defaults.js";
19
+ export { type InterfaceEndpointAlarmConfig } from "./interface-endpoint-alarm-config.js";
20
+ export { INTERFACE_ENDPOINT_ALARM_DEFAULTS } from "./interface-endpoint-alarm-defaults.js";
17
21
  /**
18
22
  * This package's AWS-property constraints, grouped by application strategy.
19
23
  * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gCAAgC,EAChC,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,qBAAqB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AAC1F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EACL,mBAAmB,EACnB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACL,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EACL,0BAA0B,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,GAChC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;;;CAMO,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gCAAgC,EAChC,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,qBAAqB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,GAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AAC1F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EACL,mBAAmB,EACnB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACL,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EACL,0BAA0B,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,GAChC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EACL,8BAA8B,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,8BAA8B,GACpC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,KAAK,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;;;CAMO,CAAC"}
package/dist/esm/index.js CHANGED
@@ -10,6 +10,9 @@ export { createVpcBuilder, } from "./vpc-builder.js";
10
10
  export { VPC_DEFAULTS } from "./vpc-defaults.js";
11
11
  export { createSecurityGroupBuilder, } from "./security-group-builder.js";
12
12
  export { SECURITY_GROUP_DEFAULTS } from "./security-group-defaults.js";
13
+ export { createInterfaceEndpointBuilder, } from "./interface-endpoint-builder.js";
14
+ export { INTERFACE_ENDPOINT_DEFAULTS } from "./interface-endpoint-defaults.js";
15
+ export { INTERFACE_ENDPOINT_ALARM_DEFAULTS } from "./interface-endpoint-alarm-defaults.js";
13
16
  /**
14
17
  * This package's AWS-property constraints, grouped by application strategy.
15
18
  * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gCAAgC,EAChC,yBAAyB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,qBAAqB,GAItB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EACL,mBAAmB,GAIpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACL,gBAAgB,GAKjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EACL,0BAA0B,GAI3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE;QACR,wBAAwB,EAAE,gCAAgC;QAC1D,iBAAiB,EAAE,yBAAyB;KAC7C;IACD,QAAQ,EAAE,EAAE;CACiB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gCAAgC,EAChC,yBAAyB,GAC1B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,qBAAqB,GAItB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EACL,mBAAmB,GAIpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EACL,gBAAgB,GAKjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EACL,0BAA0B,GAI3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EACL,8BAA8B,GAI/B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAE/E,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE;QACR,wBAAwB,EAAE,gCAAgC;QAC1D,iBAAiB,EAAE,yBAAyB;KAC7C;IACD,QAAQ,EAAE,EAAE;CACiB,CAAC"}
@@ -0,0 +1,34 @@
1
+ import type { AlarmConfig } from "@composurecdk/cloudwatch";
2
+ /**
3
+ * Controls which recommended alarms are created for a VPC interface endpoint.
4
+ * All alarms are enabled by default with AWS-recommended thresholds.
5
+ * Set individual alarms to `false` to disable them, or provide an
6
+ * {@link AlarmConfig} to tune thresholds.
7
+ *
8
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
9
+ */
10
+ export interface InterfaceEndpointAlarmConfig {
11
+ /**
12
+ * Master switch: set to `false` to disable all recommended alarms.
13
+ * Individual alarms can also be disabled via their own entry.
14
+ * @default true
15
+ */
16
+ enabled?: boolean;
17
+ /**
18
+ * Alarm when the endpoint drops packets, indicating the endpoint or
19
+ * endpoint service is unhealthy, a security group is blocking traffic,
20
+ * or packets are hitting the 8,500-byte PrivateLink MTU limit.
21
+ *
22
+ * Metric: `AWS/PrivateLinkEndpoints PacketsDropped`, statistic Sum,
23
+ * period 1 minute. Default threshold: > 0 over 5 consecutive 1-minute
24
+ * windows.
25
+ *
26
+ * If your workload intentionally sends packets larger than 8,500 bytes
27
+ * you may want to raise the threshold to reduce noise from expected MTU
28
+ * drops.
29
+ *
30
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
31
+ */
32
+ packetsDropped?: AlarmConfig | false;
33
+ }
34
+ //# sourceMappingURL=interface-endpoint-alarm-config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarm-config.d.ts","sourceRoot":"","sources":["../../src/interface-endpoint-alarm-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE5D;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,KAAK,CAAC;CACtC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=interface-endpoint-alarm-config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarm-config.js","sourceRoot":"","sources":["../../src/interface-endpoint-alarm-config.ts"],"names":[],"mappings":""}
@@ -0,0 +1,13 @@
1
+ import type { AlarmConfigDefaults } from "@composurecdk/cloudwatch";
2
+ interface InterfaceEndpointAlarmDefaults {
3
+ enabled: true;
4
+ packetsDropped: AlarmConfigDefaults;
5
+ }
6
+ /**
7
+ * AWS-recommended default alarm configuration for VPC interface endpoints.
8
+ *
9
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
10
+ */
11
+ export declare const INTERFACE_ENDPOINT_ALARM_DEFAULTS: InterfaceEndpointAlarmDefaults;
12
+ export {};
13
+ //# sourceMappingURL=interface-endpoint-alarm-defaults.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarm-defaults.d.ts","sourceRoot":"","sources":["../../src/interface-endpoint-alarm-defaults.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,UAAU,8BAA8B;IACtC,OAAO,EAAE,IAAI,CAAC;IACd,cAAc,EAAE,mBAAmB,CAAC;CACrC;AAED;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,EAAE,8BAkB/C,CAAC"}
@@ -0,0 +1,25 @@
1
+ import { TreatMissingData } from "aws-cdk-lib/aws-cloudwatch";
2
+ /**
3
+ * AWS-recommended default alarm configuration for VPC interface endpoints.
4
+ *
5
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
6
+ */
7
+ export const INTERFACE_ENDPOINT_ALARM_DEFAULTS = {
8
+ enabled: true,
9
+ /**
10
+ * Any sustained packet drop at the endpoint signals a connectivity or
11
+ * configuration problem — an unhealthy endpoint service, a security group
12
+ * blocking traffic, or jumbo frames exceeding the 8,500-byte PrivateLink
13
+ * MTU. Five consecutive 1-minute periods avoids false alarms from isolated
14
+ * oversized packets while still catching persistent issues quickly.
15
+ *
16
+ * @see https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-troubleshoot.html
17
+ */
18
+ packetsDropped: {
19
+ threshold: 0,
20
+ evaluationPeriods: 5,
21
+ datapointsToAlarm: 5,
22
+ treatMissingData: TreatMissingData.NOT_BREACHING,
23
+ },
24
+ };
25
+ //# sourceMappingURL=interface-endpoint-alarm-defaults.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarm-defaults.js","sourceRoot":"","sources":["../../src/interface-endpoint-alarm-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAQ9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAmC;IAC/E,OAAO,EAAE,IAAI;IAEb;;;;;;;;OAQG;IACH,cAAc,EAAE;QACd,SAAS,EAAE,CAAC;QACZ,iBAAiB,EAAE,CAAC;QACpB,iBAAiB,EAAE,CAAC;QACpB,gBAAgB,EAAE,gBAAgB,CAAC,aAAa;KACjD;CACF,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { type Alarm } from "aws-cdk-lib/aws-cloudwatch";
2
+ import { type InterfaceVpcEndpoint } from "aws-cdk-lib/aws-ec2";
3
+ import type { IConstruct } from "constructs";
4
+ import { AlarmDefinitionBuilder } from "@composurecdk/cloudwatch";
5
+ import type { InterfaceEndpointAlarmConfig } from "./interface-endpoint-alarm-config.js";
6
+ /**
7
+ * Creates AWS-recommended CloudWatch alarms for a VPC interface endpoint,
8
+ * merging recommended definitions with any custom alarm builders.
9
+ *
10
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
11
+ */
12
+ export declare function createInterfaceEndpointAlarms(scope: IConstruct, id: string, endpoint: InterfaceVpcEndpoint, config: InterfaceEndpointAlarmConfig | false | undefined, customAlarms?: AlarmDefinitionBuilder<InterfaceVpcEndpoint>[]): Record<string, Alarm>;
13
+ //# sourceMappingURL=interface-endpoint-alarms.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarms.d.ts","sourceRoot":"","sources":["../../src/interface-endpoint-alarms.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,KAAK,EAAqC,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,sBAAsB,EAAoC,MAAM,0BAA0B,CAAC;AACpG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAsDzF;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,oBAAoB,EAC9B,MAAM,EAAE,4BAA4B,GAAG,KAAK,GAAG,SAAS,EACxD,YAAY,GAAE,sBAAsB,CAAC,oBAAoB,CAAC,EAAO,GAChE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAUvB"}
@@ -0,0 +1,55 @@
1
+ import { Duration } from "aws-cdk-lib";
2
+ import { ComparisonOperator, Metric, Stats } from "aws-cdk-lib/aws-cloudwatch";
3
+ import { createAlarms, resolveAlarmConfig } from "@composurecdk/cloudwatch";
4
+ import { INTERFACE_ENDPOINT_ALARM_DEFAULTS } from "./interface-endpoint-alarm-defaults.js";
5
+ const PACKETS_DROPPED_PERIOD = Duration.minutes(1);
6
+ const PACKETS_DROPPED_PERIOD_LABEL = `${String(PACKETS_DROPPED_PERIOD.toMinutes())} minute`;
7
+ function endpointMetric(endpoint, metricName, statistic, period) {
8
+ return new Metric({
9
+ namespace: "AWS/PrivateLinkEndpoints",
10
+ metricName,
11
+ dimensionsMap: { "VPC Endpoint Id": endpoint.vpcEndpointId },
12
+ statistic,
13
+ period,
14
+ });
15
+ }
16
+ function resolveEndpointAlarmDefinitions(endpoint, config) {
17
+ if (config?.enabled === false)
18
+ return [];
19
+ const definitions = [];
20
+ if (config?.packetsDropped !== false) {
21
+ const cfg = resolveAlarmConfig(config?.packetsDropped, INTERFACE_ENDPOINT_ALARM_DEFAULTS.packetsDropped);
22
+ definitions.push({
23
+ key: "packetsDropped",
24
+ alarmName: cfg.alarmName,
25
+ metric: endpointMetric(endpoint, "PacketsDropped", Stats.SUM, PACKETS_DROPPED_PERIOD),
26
+ threshold: cfg.threshold,
27
+ comparisonOperator: ComparisonOperator.GREATER_THAN_THRESHOLD,
28
+ evaluationPeriods: cfg.evaluationPeriods,
29
+ datapointsToAlarm: cfg.datapointsToAlarm,
30
+ treatMissingData: cfg.treatMissingData,
31
+ description: `VPC interface endpoint is dropping packets — possible endpoint service unhealthy, ` +
32
+ `security group blocking traffic, or packets exceeding the 8,500-byte PrivateLink MTU. ` +
33
+ `Threshold: > ${String(cfg.threshold)} (sum) over ` +
34
+ `${String(cfg.evaluationPeriods)} x ${PACKETS_DROPPED_PERIOD_LABEL}.`,
35
+ });
36
+ }
37
+ return definitions;
38
+ }
39
+ /**
40
+ * Creates AWS-recommended CloudWatch alarms for a VPC interface endpoint,
41
+ * merging recommended definitions with any custom alarm builders.
42
+ *
43
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
44
+ */
45
+ export function createInterfaceEndpointAlarms(scope, id, endpoint, config, customAlarms = []) {
46
+ if (config === false)
47
+ return {};
48
+ const enabled = config?.enabled ?? INTERFACE_ENDPOINT_ALARM_DEFAULTS.enabled;
49
+ if (!enabled)
50
+ return {};
51
+ const recommended = resolveEndpointAlarmDefinitions(endpoint, config);
52
+ const custom = customAlarms.map((b) => b.resolve(endpoint));
53
+ return createAlarms(scope, id, [...recommended, ...custom]);
54
+ }
55
+ //# sourceMappingURL=interface-endpoint-alarms.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-alarms.js","sourceRoot":"","sources":["../../src/interface-endpoint-alarms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAc,kBAAkB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAI3F,OAAO,EAA0B,YAAY,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEpG,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F,MAAM,sBAAsB,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACnD,MAAM,4BAA4B,GAAG,GAAG,MAAM,CAAC,sBAAsB,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC;AAE5F,SAAS,cAAc,CACrB,QAA8B,EAC9B,UAAkB,EAClB,SAAiB,EACjB,MAAgB;IAEhB,OAAO,IAAI,MAAM,CAAC;QAChB,SAAS,EAAE,0BAA0B;QACrC,UAAU;QACV,aAAa,EAAE,EAAE,iBAAiB,EAAE,QAAQ,CAAC,aAAa,EAAE;QAC5D,SAAS;QACT,MAAM;KACP,CAAC,CAAC;AACL,CAAC;AAED,SAAS,+BAA+B,CACtC,QAA8B,EAC9B,MAAgD;IAEhD,IAAI,MAAM,EAAE,OAAO,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAEzC,MAAM,WAAW,GAAsB,EAAE,CAAC;IAE1C,IAAI,MAAM,EAAE,cAAc,KAAK,KAAK,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,kBAAkB,CAC5B,MAAM,EAAE,cAAc,EACtB,iCAAiC,CAAC,cAAc,CACjD,CAAC;QACF,WAAW,CAAC,IAAI,CAAC;YACf,GAAG,EAAE,gBAAgB;YACrB,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,MAAM,EAAE,cAAc,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,CAAC,GAAG,EAAE,sBAAsB,CAAC;YACrF,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,kBAAkB,EAAE,kBAAkB,CAAC,sBAAsB;YAC7D,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;YACtC,WAAW,EACT,oFAAoF;gBACpF,wFAAwF;gBACxF,gBAAgB,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,cAAc;gBACnD,GAAG,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,MAAM,4BAA4B,GAAG;SACxE,CAAC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAC3C,KAAiB,EACjB,EAAU,EACV,QAA8B,EAC9B,MAAwD,EACxD,eAA+D,EAAE;IAEjE,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAEhC,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,iCAAiC,CAAC,OAAO,CAAC;IAC7E,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAExB,MAAM,WAAW,GAAG,+BAA+B,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE5D,OAAO,YAAY,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;AAC9D,CAAC"}
@@ -0,0 +1,135 @@
1
+ import { type Alarm } from "aws-cdk-lib/aws-cloudwatch";
2
+ import { InterfaceVpcEndpoint, type IConnectable, type InterfaceVpcEndpointProps, type ISecurityGroup, type IVpc, type SecurityGroup } from "aws-cdk-lib/aws-ec2";
3
+ import { type IConstruct } from "constructs";
4
+ import { COPY_STATE, type Lifecycle, type Resolvable } from "@composurecdk/core";
5
+ import { type ITaggedBuilder } from "@composurecdk/cloudformation";
6
+ import { AlarmDefinitionBuilder } from "@composurecdk/cloudwatch";
7
+ import type { InterfaceEndpointAlarmConfig } from "./interface-endpoint-alarm-config.js";
8
+ /**
9
+ * Configuration properties for the interface-endpoint builder.
10
+ *
11
+ * Lifts three CDK props off the props object:
12
+ * - `vpc` — supplied via {@link IInterfaceEndpointBuilder.vpc | .vpc()} so it
13
+ * can accept a {@link Resolvable} for cross-component wiring.
14
+ * - `securityGroups` — supplied via
15
+ * {@link IInterfaceEndpointBuilder.securityGroups | .securityGroups()} so
16
+ * each can be a {@link Resolvable} (typically a sibling
17
+ * `SecurityGroupBuilder`).
18
+ * - `open` — always `false`; ingress is explicit (see the builder docs).
19
+ */
20
+ export interface InterfaceEndpointBuilderProps extends Omit<InterfaceVpcEndpointProps, "vpc" | "securityGroups" | "open"> {
21
+ /**
22
+ * Configuration for AWS-recommended CloudWatch alarms.
23
+ *
24
+ * By default, the builder creates recommended alarms with sensible
25
+ * thresholds. Individual alarms can be customized or disabled. Set to
26
+ * `false` to disable all alarms.
27
+ *
28
+ * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints
29
+ */
30
+ recommendedAlarms?: InterfaceEndpointAlarmConfig | false;
31
+ }
32
+ /**
33
+ * The build output of an {@link IInterfaceEndpointBuilder}.
34
+ *
35
+ * `securityGroup` is present only in **managed mode** — i.e. when the caller
36
+ * did *not* supply `.securityGroups(...)`, so the builder auto-created one. It
37
+ * is exposed for cases where sibling builders need to reference the
38
+ * auto-created SG directly. In **BYO mode** it is `undefined`: the caller
39
+ * already holds refs to the security groups they passed in.
40
+ */
41
+ export interface InterfaceEndpointBuilderResult {
42
+ endpoint: InterfaceVpcEndpoint;
43
+ securityGroup?: SecurityGroup;
44
+ alarms: Record<string, Alarm>;
45
+ }
46
+ /**
47
+ * A fluent builder for a single VPC interface endpoint (AWS PrivateLink).
48
+ *
49
+ * Unlike raw CDK — where interface endpoints exist only as a post-build
50
+ * `vpc.addInterfaceEndpoint(...)` call whose security group is never exposed —
51
+ * this builder is a first-class {@link compose} component. It maps 1:1 to a
52
+ * CDK `InterfaceVpcEndpoint` (one `service` per endpoint); group several into
53
+ * one access policy by pointing them at the same security group.
54
+ *
55
+ * **Security group, two modes:**
56
+ * - *BYO* — call {@link IInterfaceEndpointBuilder.securityGroups | .securityGroups([...])}
57
+ * with security groups you fully manage (typically sibling
58
+ * `SecurityGroupBuilder`s). Full ingress/egress/port control; the builder
59
+ * creates no SG and `securityGroup` is absent from the result.
60
+ * - *Managed shortcut* — omit `.securityGroups()` and the builder auto-creates
61
+ * a closed SG, exposes it on the result, and for each peer you pass to
62
+ * {@link IInterfaceEndpointBuilder.allowDefaultPortFrom} it opens ingress on
63
+ * the managed SG **and** egress on the peer's SG — matching exactly what CDK's
64
+ * `connections.allowDefaultPortFrom(...)` does bidirectionally.
65
+ *
66
+ * The two are mutually exclusive — combining BYO `.securityGroups()` with
67
+ * `.allowDefaultPortFrom()` throws, since the rule would have nowhere it
68
+ * could be applied that the caller isn't already managing.
69
+ *
70
+ * @see https://docs.aws.amazon.com/vpc/latest/privatelink/
71
+ *
72
+ * @example Managed shortcut (the SSM-from-bastion common case)
73
+ * ```ts
74
+ * createInterfaceEndpointBuilder()
75
+ * .vpc(ref<VpcBuilderResult>("network").get("vpc"))
76
+ * .service(InterfaceVpcEndpointAwsService.SSM)
77
+ * .subnets({ subnetType: SubnetType.PRIVATE_ISOLATED })
78
+ * .allowDefaultPortFrom(ref<SecurityGroupBuilderResult>("bastionSg").get("securityGroup"));
79
+ * // result = { endpoint, securityGroup }
80
+ * ```
81
+ */
82
+ export type IInterfaceEndpointBuilder = ITaggedBuilder<InterfaceEndpointBuilderProps, InterfaceEndpointBuilder>;
83
+ declare class InterfaceEndpointBuilder implements Lifecycle<InterfaceEndpointBuilderResult> {
84
+ #private;
85
+ props: Partial<InterfaceEndpointBuilderProps>;
86
+ /**
87
+ * Sets the VPC the endpoint is created in. Accepts a concrete {@link IVpc}
88
+ * or a {@link Ref} to a sibling {@link IVpcBuilder}.
89
+ */
90
+ vpc(vpc: Resolvable<IVpc>): this;
91
+ /**
92
+ * Bring-your-own security groups. Each entry is a {@link Resolvable}, so it
93
+ * can be a concrete {@link ISecurityGroup} or a {@link Ref} to a sibling
94
+ * `SecurityGroupBuilder` — giving you full ingress/egress/port control. When
95
+ * set, the builder creates no security group of its own and
96
+ * {@link InterfaceEndpointBuilderResult.securityGroup} is `undefined`.
97
+ *
98
+ * Mutually exclusive with {@link allowDefaultPortFrom}.
99
+ */
100
+ securityGroups(securityGroups: Resolvable<ISecurityGroup>[]): this;
101
+ /**
102
+ * Managed-SG shortcut: wires `peer` to the auto-created security group via
103
+ * CDK's `endpoint.connections.allowDefaultPortFrom(peer)` — opening ingress
104
+ * on the managed SG from `peer`'s SG **and** egress from `peer`'s SG to the
105
+ * managed SG, on the service's default port (443 for AWS services).
106
+ *
107
+ * Because this delegates to CDK connections, `peer` must be an
108
+ * {@link IConnectable} (e.g. a `SecurityGroup` or `Instance`), not a raw
109
+ * `IPeer` (e.g. `Peer.ipv4(...)`). For CIDR-based rules use BYO mode with
110
+ * an explicit `addIngressRule` on your own {@link SecurityGroupBuilder}.
111
+ *
112
+ * Mutually exclusive with {@link securityGroups}.
113
+ */
114
+ allowDefaultPortFrom(peer: Resolvable<IConnectable>, description?: string): this;
115
+ /**
116
+ * Adds a custom CloudWatch alarm alongside the recommended ones. The
117
+ * callback receives an {@link AlarmDefinitionBuilder} typed to the
118
+ * `InterfaceVpcEndpoint` construct, giving access to the endpoint at
119
+ * build time for metric dimension wiring.
120
+ */
121
+ addAlarm(key: string, configure: (alarm: AlarmDefinitionBuilder<InterfaceVpcEndpoint>) => AlarmDefinitionBuilder<InterfaceVpcEndpoint>): this;
122
+ /** @internal — see ADR-0005. */
123
+ [COPY_STATE](target: InterfaceEndpointBuilder): void;
124
+ build(scope: IConstruct, id: string, context?: Record<string, object>): InterfaceEndpointBuilderResult;
125
+ }
126
+ /**
127
+ * Creates a new {@link IInterfaceEndpointBuilder} for a single VPC interface
128
+ * endpoint. The returned builder exposes every
129
+ * {@link InterfaceEndpointBuilderProps} property as a fluent setter/getter,
130
+ * plus `.vpc()`, `.securityGroups()` (BYO), and `.allowDefaultPortFrom()`
131
+ * (managed-SG shortcut).
132
+ */
133
+ export declare function createInterfaceEndpointBuilder(): IInterfaceEndpointBuilder;
134
+ export {};
135
+ //# sourceMappingURL=interface-endpoint-builder.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"interface-endpoint-builder.d.ts","sourceRoot":"","sources":["../../src/interface-endpoint-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EACL,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,cAAc,EACnB,KAAK,IAAI,EACT,KAAK,aAAa,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,KAAK,SAAS,EAAW,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAGzF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,6BAA8B,SAAQ,IAAI,CACzD,yBAAyB,EACzB,KAAK,GAAG,gBAAgB,GAAG,MAAM,CAClC;IACC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,4BAA4B,GAAG,KAAK,CAAC;CAC1D;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAC/B;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,CACpD,6BAA6B,EAC7B,wBAAwB,CACzB,CAAC;AAEF,cAAM,wBAAyB,YAAW,SAAS,CAAC,8BAA8B,CAAC;;IACjF,KAAK,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAM;IAMnD;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI;IAKhC;;;;;;;;OAQG;IACH,cAAc,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC,EAAE,GAAG,IAAI;IAKlE;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAKhF;;;;;OAKG;IACH,QAAQ,CACN,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,CACT,KAAK,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,KAChD,sBAAsB,CAAC,oBAAoB,CAAC,GAChD,IAAI;IAKP,gCAAgC;IAChC,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI;IAOpD,KAAK,CACH,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,8BAA8B;CA6DlC;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,IAAI,yBAAyB,CAI1E"}