CreateUsagePlanRequest

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

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

interface CreateUsagePlanRequest {

apiStages?: ApiStage[] | null;

description?: string | null;

name: string;

quota?: QuotaSettings | null;

tags?: {

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

} | null;

throttle?: ThrottleSettings | null;

}

§Properties

apiStages?: ApiStage[] | null

[src]

The associated API stages of the usage plan.

description?: string | null

[src]

The description of the usage plan.

name: string

[src]

[Required] The name of the usage plan.

quota?: QuotaSettings | null

[src]

The quota of the usage plan.

tags?: {

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

} | null

[src]

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

throttle?: ThrottleSettings | null

[src]

The throttling limits of the usage plan.