@composurecdk/bedrock 0.10.1

package/dist/esm/model-alarms.js

@@ -0,0 +1,111 @@
+import { Duration } from "aws-cdk-lib";
+import { ComparisonOperator, Metric } from "aws-cdk-lib/aws-cloudwatch";
+import { resolveAlarmConfig, resolveAlarmThresholdBasis } from "@composurecdk/cloudwatch";
+import { isInferenceProfile } from "./inference-target.js";
+import { MODEL_ALARM_DEFAULTS } from "./model-alarm-defaults.js";
+const PERIOD = Duration.minutes(1);
+/** Returns the `AWS/Bedrock` metrics for `target`. */
+export function modelMetrics(target) {
+    const modelId = isInferenceProfile(target) ? target.profileId : target.modelId;
+    return {
+        modelId,
+        metric: (metricName, options) => new Metric({
+            namespace: "AWS/Bedrock",
+            metricName,
+            dimensionsMap: { ModelId: modelId },
+            period: PERIOD,
+            ...options,
+        }),
+    };
+}
+const THRESHOLD_ALARMS = {
+    invocationThrottles: {
+        metricName: "InvocationThrottles",
+        statistic: "Sum",
+        defaults: MODEL_ALARM_DEFAULTS.invocationThrottles,
+        describe: (id, t) => `Bedrock is throttling requests to ${id}; the account's quota for the model is exhausted. ` +
+            `Threshold: > ${String(t)} per minute.`,
+    },
+    invocationServerErrors: {
+        metricName: "InvocationServerErrors",
+        statistic: "Sum",
+        defaults: MODEL_ALARM_DEFAULTS.invocationServerErrors,
+        describe: (id, t) => `Bedrock is returning server errors for ${id}. Threshold: > ${String(t)} per minute.`,
+    },
+    invocationClientErrors: {
+        metricName: "InvocationClientErrors",
+        statistic: "Sum",
+        defaults: MODEL_ALARM_DEFAULTS.invocationClientErrors,
+        describe: (id, t) => `Requests to ${id} are failing with client errors, such as AccessDenied or validation ` +
+            `errors. Threshold: > ${String(t)} per minute.`,
+    },
+    invocationLatency: {
+        metricName: "InvocationLatency",
+        statistic: "p90",
+        describe: (id, t) => `p90 invocation latency for ${id} exceeds ${String(t)} ms.`,
+    },
+    timeToFirstToken: {
+        metricName: "TimeToFirstToken",
+        statistic: "p90",
+        describe: (id, t) => `p90 time to first token for ${id} exceeds ${String(t)} ms.`,
+    },
+};
+function toDefinition(key, metric, cfg, description) {
+    return {
+        key,
+        alarmName: cfg.alarmName,
+        metric,
+        threshold: cfg.threshold,
+        comparisonOperator: ComparisonOperator.GREATER_THAN_THRESHOLD,
+        evaluationPeriods: cfg.evaluationPeriods,
+        datapointsToAlarm: cfg.datapointsToAlarm,
+        treatMissingData: cfg.treatMissingData,
+        description,
+    };
+}
+function quotaAlarm(scope, metrics, config) {
+    if (!config)
+        return [];
+    const quota = resolveAlarmThresholdBasis({
+        scope,
+        value: config.quota,
+        resolve: (q) => q,
+        warningId: "@composurecdk/bedrock:token-tpm-quota-alarm",
+        alarmLabel: "Bedrock estimated TPM quota usage",
+        suppressHint: "recommendedAlarms({ estimatedTpmQuotaUsage: false })",
+    });
+    if (quota === undefined)
+        return [];
+    const percent = config.thresholdPercent ?? MODEL_ALARM_DEFAULTS.estimatedTpmQuotaUsage.thresholdPercent;
+    if (!(quota > 0)) {
+        throw new Error(`estimatedTpmQuotaUsage: quota must be a positive number, got ${String(quota)}.`);
+    }
+    if (!(percent > 0 && percent <= 1)) {
+        throw new Error(`estimatedTpmQuotaUsage: thresholdPercent must be in (0, 1], got ${String(percent)}.`);
+    }
+    const cfg = resolveAlarmConfig({ ...config, threshold: Math.floor(quota * percent) }, { ...MODEL_ALARM_DEFAULTS.optIn, threshold: 0 });
+    return [
+        toDefinition("estimatedTpmQuotaUsage", metrics.metric("EstimatedTPMQuotaUsage", { statistic: "Maximum" }), cfg, `Estimated token usage for ${metrics.modelId} exceeds ${String(percent * 100)}% of the ` +
+            `${String(quota)} tokens-per-minute quota.`),
+    ];
+}
+/** Resolves the recommended alarm configuration for a model's metrics. */
+export function resolveModelAlarmDefinitions(scope, metrics, config) {
+    if (config?.enabled === false)
+        return [];
+    const definitions = Object.entries(THRESHOLD_ALARMS).flatMap(([key, spec]) => {
+        const userConfig = config?.[key];
+        if (userConfig === false || (userConfig === undefined && !spec.defaults))
+            return [];
+        if (!spec.defaults && userConfig?.threshold === undefined) {
+            throw new Error(`The "${key}" alarm has no default threshold. Supply one, e.g. ` +
+                `recommendedAlarms({ ${key}: { threshold: … } }).`);
+        }
+        const cfg = resolveAlarmConfig(userConfig, spec.defaults ?? { ...MODEL_ALARM_DEFAULTS.optIn, threshold: 0 });
+        return [
+            toDefinition(key, metrics.metric(spec.metricName, { statistic: spec.statistic }), cfg, spec.describe(metrics.modelId, cfg.threshold)),
+        ];
+    });
+    return [...definitions, ...quotaAlarm(scope, metrics, config?.estimatedTpmQuotaUsage)];
+}
+//# sourceMappingURL=model-alarms.js.map

package/dist/esm/model-alarms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-alarms.js","sourceRoot":"","sources":["../../src/model-alarms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAsB,MAAM,4BAA4B,CAAC;AAO5F,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAE1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAajE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEnC,sDAAsD;AACtD,MAAM,UAAU,YAAY,CAAC,MAAwB;IACnD,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IAC/E,OAAO;QACL,OAAO;QACP,MAAM,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAC9B,IAAI,MAAM,CAAC;YACT,SAAS,EAAE,aAAa;YACxB,UAAU;YACV,aAAa,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;YACnC,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC;KACL,CAAC;AACJ,CAAC;AAYD,MAAM,gBAAgB,GAAyC;IAC7D,mBAAmB,EAAE;QACnB,UAAU,EAAE,qBAAqB;QACjC,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,oBAAoB,CAAC,mBAAmB;QAClD,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAClB,qCAAqC,EAAE,oDAAoD;YAC3F,gBAAgB,MAAM,CAAC,CAAC,CAAC,cAAc;KAC1C;IACD,sBAAsB,EAAE;QACtB,UAAU,EAAE,wBAAwB;QACpC,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,oBAAoB,CAAC,sBAAsB;QACrD,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAClB,0CAA0C,EAAE,kBAAkB,MAAM,CAAC,CAAC,CAAC,cAAc;KACxF;IACD,sBAAsB,EAAE;QACtB,UAAU,EAAE,wBAAwB;QACpC,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,oBAAoB,CAAC,sBAAsB;QACrD,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAClB,eAAe,EAAE,sEAAsE;YACvF,wBAAwB,MAAM,CAAC,CAAC,CAAC,cAAc;KAClD;IACD,iBAAiB,EAAE;QACjB,UAAU,EAAE,mBAAmB;QAC/B,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,8BAA8B,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,MAAM;KACjF;IACD,gBAAgB,EAAE;QAChB,UAAU,EAAE,kBAAkB;QAC9B,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,+BAA+B,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,MAAM;KAClF;CACF,CAAC;AAEF,SAAS,YAAY,CACnB,GAAW,EACX,MAAc,EACd,GAAwB,EACxB,WAAmB;IAEnB,OAAO;QACL,GAAG;QACH,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,MAAM;QACN,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,kBAAkB,EAAE,kBAAkB,CAAC,sBAAsB;QAC7D,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;QACxC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;QACxC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;QACtC,WAAW;KACZ,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CACjB,KAAiB,EACjB,OAAqB,EACrB,MAAkD;IAElD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,0BAA0B,CAAC;QACvC,KAAK;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjB,SAAS,EAAE,6CAA6C;QACxD,UAAU,EAAE,mCAAmC;QAC/C,YAAY,EAAE,sDAAsD;KACrE,CAAC,CAAC;IACH,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,OAAO,GACX,MAAM,CAAC,gBAAgB,IAAI,oBAAoB,CAAC,sBAAsB,CAAC,gBAAgB,CAAC;IAC1F,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACb,gEAAgE,MAAM,CAAC,KAAK,CAAC,GAAG,CACjF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,mEAAmE,MAAM,CAAC,OAAO,CAAC,GAAG,CACtF,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,kBAAkB,CAC5B,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,EAAE,EACrD,EAAE,GAAG,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,CAChD,CAAC;IACF,OAAO;QACL,YAAY,CACV,wBAAwB,EACxB,OAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAClE,GAAG,EACH,6BAA6B,OAAO,CAAC,OAAO,YAAY,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,WAAW;YACtF,GAAG,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAC9C;KACF,CAAC;AACJ,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,4BAA4B,CAC1C,KAAiB,EACjB,OAAqB,EACrB,MAAoC;IAEpC,IAAI,MAAM,EAAE,OAAO,KAAK,KAAK;QAAE,OAAO,EAAE,CAAC;IAEzC,MAAM,WAAW,GACf,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAChC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;QACxB,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,UAAU,KAAK,KAAK,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QACpF,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,UAAU,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CACb,QAAQ,GAAG,qDAAqD;gBAC9D,uBAAuB,GAAG,wBAAwB,CACrD,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,GAAG,kBAAkB,CAC5B,UAAU,EACV,IAAI,CAAC,QAAQ,IAAI,EAAE,GAAG,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,CACjE,CAAC;QACF,OAAO;YACL,YAAY,CACV,GAAG,EACH,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,EAC9D,GAAG,EACH,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,CAC9C;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC;AACzF,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@composurecdk/bedrock",
+  "version": "0.10.1",
+  "description": "Composable Amazon Bedrock model access: cross-Region inference profiles, invocation grants and alarms",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/laazyj/composureCDK.git",
+    "directory": "packages/bedrock"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "clean": "rm -rf dist .tshy .tshy-build",
+    "build": "tshy",
+    "typecheck": "tsc --noEmit",
+    "check:exports": "attw --pack . --profile node16 && publint",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "aws",
+    "cdk",
+    "aws-cdk",
+    "infrastructure-as-code",
+    "iac",
+    "composurecdk",
+    "bedrock",
+    "generative-ai",
+    "inference-profile",
+    "llm"
+  ],
+  "author": "Jason Duffett (https://github.com/laazyj)",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "tshy": {
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "peerDependencies": {
+    "@composurecdk/cloudformation": "^0.10.0",
+    "@composurecdk/cloudwatch": "^0.10.0",
+    "@composurecdk/core": "^0.10.0",
+    "aws-cdk-lib": "^2.138.0",
+    "constructs": "^10.0.0"
+  },
+  "devDependencies": {
+    "@composurecdk/cdk-testing": "*",
+    "@types/node": "^26.6.1",
+    "aws-cdk-lib": "^2.269.0",
+    "constructs": "^10.8.1",
+    "typescript": "^6.0.3",
+    "vitest": "^5.0.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    }
+  },
+  "main": "./dist/commonjs/index.js",
+  "types": "./dist/commonjs/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "nx": {
+    "tags": [
+      "scope:lib"
+    ]
+  }
+}