Class UsagePlanResolver

Resolves a stable apiStage name → live AWS API Gateway usage-plan id, so a plan id is never persisted. Plans change rarely, so the full list is memoized in-process for a short TTL; call bust to force a refresh.

Consumed by the customer dashboard (key creation) and the Phase 2b sync service.

Index

Constructors

constructor

Methods

bust listUsagePlans usagePlanIdForStage

Constructors

constructor

new UsagePlanResolver(
    __namedParameters: {
        apiGatewayClient: APIGatewayClient;
        cacheTtlMs?: number;
    },
): UsagePlanResolver
Parameters
- __namedParameters: { apiGatewayClient: APIGatewayClient; cacheTtlMs?: number }
Returns UsagePlanResolver
- Defined in packages/customer-services/src/UsagePlanResolver.ts:52

Methods

bust

bust(): void
Drops the memoized plan list so the next read re-fetches from AWS.

Returns void
- Defined in packages/customer-services/src/UsagePlanResolver.ts:108

listUsagePlans

listUsagePlans(): Promise<ResolvedUsagePlan[]>
Lists every usage plan, paginating on position until exhausted. Result is memoized in-memory for cacheTtlMs.

Returns Promise<ResolvedUsagePlan[]>
- Defined in packages/customer-services/src/UsagePlanResolver.ts:67

usagePlanIdForStage

usagePlanIdForStage(apiStage: string): Promise<string | null>
Resolves a stable apiStage → usage-plan id by matching the plan whose name is ${apiStage} or ${apiStage}-${stack} (the per-API Pulumi naming). Returns null when no plan matches.
Parameters
- apiStage: string
Returns Promise<string | null>
- Defined in packages/customer-services/src/UsagePlanResolver.ts:101

Class UsagePlanResolver

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UsagePlanResolver

Methods

bust

Returns void

listUsagePlans

Returns Promise<ResolvedUsagePlan[]>

usagePlanIdForStage

Parameters

Returns Promise<string | null>

Settings

On This Page