UsagePlanProps Struct
Properties for defining an API Gateway Usage Plan for WebSocket APIs.
Example
ts
const api = new apigwv2.WebSocketApi(this, 'my-api');
const stage = new apigwv2.WebSocketStage(this, 'my-stage', {
webSocketApi: api,
stageName: 'dev',
});
const usagePlan = new apigwv2.UsagePlan(this, 'my-usage-plan', {
usagePlanName: 'Basic',
});
usagePlan.addApiStage({
api: api,
stage: stage,
});
Properties
apiStagesoptionalUsagePlanPerApiStage[]api_stagesoptionaltyping.List[UsagePlanPerApiStage]apiStagesoptionalList<UsagePlanPerApiStage>ApiStagesoptionalUsagePlanPerApiStage[]ApiStagesoptional*[]UsagePlanPerApiStage= none#API Stages to be associated with the usage plan.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#Represents usage plan purpose.
quotaoptionalQuotaSettingsquotaoptionalQuotaSettingsquotaoptionalQuotaSettingsQuotaoptionalQuotaSettingsQuotaoptionalQuotaSettings= none#Number of requests clients can make in a given time period.
throttleoptionalThrottleSettingsthrottleoptionalThrottleSettingsthrottleoptionalThrottleSettingsThrottleoptionalThrottleSettingsThrottleoptionalThrottleSettings= none#Overall throttle settings for the API.
usagePlanNameoptionalstringusage_plan_nameoptionalstrusagePlanNameoptionalStringUsagePlanNameoptionalstringUsagePlanNameoptional*string= none#Name for this usage plan.