Type Alias ApiGatewayPort

Small, testable port for the API Gateway operations used by this repo.

Implementations may paginate internally and return full arrays.

type ApiGatewayPort = {
    flushStageCache(
        opts: { restApiId: string; stageName: string },
    ): Promise<void>;
    listApiKeys(
        opts: { includeValues: boolean; limit?: number; nameQuery: string },
    ): Promise<ApiKeySummary[]>;
    listRestApis(opts?: { limit?: number }): Promise<RestApiSummary[]>;
}

Implemented by

AwsApiGatewayTools

Index

Methods

flushStageCache listApiKeys listRestApis

Methods

flushStageCache

flushStageCache(opts: { restApiId: string; stageName: string }): Promise<void>
Flush the cache for a specific REST API stage.
Parameters
- opts: { restApiId: string; stageName: string }
Returns Promise<void>
- Defined in src/apiGateway/ports/apiGatewayPort.ts:42

listApiKeys

listApiKeys(
opts: { includeValues: boolean; limit?: number; nameQuery: string },
): Promise<ApiKeySummary[]>
List API keys matching a name query, including values. Implementations should return all items (paginate internally).
Parameters
- opts: { includeValues: boolean; limit?: number; nameQuery: string }
Returns Promise<ApiKeySummary[]>
- Defined in src/apiGateway/ports/apiGatewayPort.ts:50

listRestApis

listRestApis(opts?: { limit?: number }): Promise<RestApiSummary[]>
List REST APIs. Implementations should return all items (paginate internally).
Parameters
- Optionalopts: { limit?: number }
Returns Promise<RestApiSummary[]>
- Defined in src/apiGateway/ports/apiGatewayPort.ts:38

Type Alias ApiGatewayPort

Implemented by

Index

Methods

Methods

flushStageCache

Parameters

Returns Promise<void>

listApiKeys

Parameters

Returns Promise<ApiKeySummary[]>

listRestApis

Parameters

Returns Promise<RestApiSummary[]>

Settings

On This Page