L2 Construct

UsagePlan

Import

import { UsagePlan } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.UsagePlan

Configuration passed to the constructor as UsagePlanProps.

apiStagesOptional

UsagePlanPerApiStage[]

API Stages to be associated with the usage plan.

Default: none

descriptionOptional

string

Represents usage plan purpose.

Default: none

nameOptional

string

Name for this usage plan.

Default: none

quotaOptional

QuotaSettings

Number of requests clients can make in a given time period.

Default: none

throttleOptional

ThrottleSettings

Overall throttle settings for the API.

Default: none

Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-apigateway

Properties5