(aws-apigatewayv2-alpha): Set route throttling with HttpStage

What is the problem?

Unlike the module aws_apigateway where I would just do

const api = new apigateway.RestApi(this, 'hello-api');
const plan = api.addUsagePlan('UsagePlan', {
  name: 'Easy',
  throttle: {
    rateLimit: 10,
    burstLimit: 2
  }
});

there doesnt seem to be an equivalent way of doing this in aws-apigatewayv2-alpha.

Reproduction Steps

I created an HTTP Api

export class APIConstruct extends Construct {
  public api: HttpApi;
  constructor(scope: Construct, id: idType, authorizer: HttpUserPoolAuthorizer) {
    super(scope, id);
    const throtting = new UsagePlan(this, "Throttling", {
      throttle: { burstLimit: 999, rateLimit: 99 },
    });
    this.api = new HttpApi(this, id, {
      apiName: id,
      defaultAuthorizer: authorizer,
    });
  }
}

and tried to just add throttling in the same scope, hoping that it would automatically apply to the only api gateway specified

const throtting = new UsagePlan(this, "TypiRateLimiting", { throttle: { burstLimit: 999, rateLimit: 99 } });

What did you expect to happen?

Have a method .addUsagePlan on the Http Api class or having a field in props that allows me to link the UsagePlan to the Api.

What actually happened?

Throttling was not configured for Api

CDK CLI Version

2.17.0

Framework Version

No response

Node.js Version

16.12

OS

Windows

Language

Typescript

Language Version

No response

Other information

No response

[TkinterinShanghai]

This seems to be a bug elsewhere but creating a stage doesnt work because “Stage already exists”, even when setting createDefaultStage to false in the HttpApi class. But this bug affects this fix, because the fix relies on the Stage working. So I think additionally having a method such as createDefaultThrottling on the HttpApi or a setThrottling method on the HttpStage would work even with the current bug.

[peterwoodworth]

I hear you @TkinterinShanghai, I’ve created a PR for this feature 🙂