L2 Construct

UsagePlan

A UsagePlan.

Import

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

Or use the module namespace:

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.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

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

usagePlanNameOptional

string

Name for this usage plan.

Default: none

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

LevelL2 (Higher-level)

Moduleaws-apigatewayv2

Properties5