Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

UsagePlan

import type { UsagePlan } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

See also: Create and Use Usage Plans

interface UsagePlan {

apiStages?: ApiStage[] | null;

description?: string | null;

id?: string | null;

name?: string | null;

productCode?: string | null;

quota?: QuotaSettings | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

throttle?: ThrottleSettings | null;

}

§Properties

apiStages?: ApiStage[] | null

The associated API stages of a usage plan.

description?: string | null

The description of a usage plan.

id?: string | null

The identifier of a "UsagePlan" resource.

name?: string | null

The name of a usage plan.

productCode?: string | null

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

quota?: QuotaSettings | null

The target maximum number of permitted requests per a given unit time interval.

tags?: {

[key: string]: string | null | undefined;

} | null

The collection of tags. Each tag element is associated with a given resource.

throttle?: ThrottleSettings | null

Map containing method level throttling information for API stage in a usage plan.