Skip to content
v2.275.0

UsagePlanPerApiStage Struct ​

Represents the API stages that a usage plan applies to.

Example ​

ts
declare const plan: apigateway.UsagePlan;
declare const api: apigateway.RestApi;
declare const echoMethod: apigateway.Method;

plan.addApiStage({
  stage: api.deploymentStage,
  throttle: [
    {
      method: echoMethod,
      throttle: {
        rateLimit: 10,
        burstLimit: 2
      }
    }
  ]
});

Properties ​

apioptionalIRestApiapioptionalIRestApiapioptionalIRestApiApioptionalIRestApiApioptionalIRestApi= none#
stageoptionalStagestageoptionalStagestageoptionalStageStageoptionalStageStageoptionalStage= none#
[disable-awslint:ref-via-interface].
throttleoptionalThrottlingPerMethod[]throttleoptionaltyping.List[ThrottlingPerMethod]throttleoptionalList<ThrottlingPerMethod>ThrottleoptionalThrottlingPerMethod[]Throttleoptional*[]ThrottlingPerMethod= none#