Define UsagePlan and Api Keys

[removed-account]

Hi,
Is it possible to define Usage Plan and Api Keys that attached to the newly created Api Gateway resource in this plugin?
I've tried it but it seems it doesn't work.

if it doesn't, any guide to implement it and make PR?

thanks

[horike37]

Right now, that functionality still be supported.

any guide to implement it and make PR?

Of course! Would be great if you work on the PR 👍 We can help something you work on.

[removed-account]

So :D

The first question is where to add this functionality in serverless.yaml in apiGatewayServiceProxies attribute?

[horike37]

You can define UsagePlan and Api Keys within provider section of serverless.yml. so I think it should be same. What do you think?
https://serverless.com/framework/docs/providers/aws/guide/serverless.yml/

[removed-account]

Agree 👍 .

I think it works if we have the default APIGW deployment that's created by Serverless framekwork for Lambda function, but it won't work if our APIGW deployment is created by this lovely plugin (i.e. serverless.yaml has only one APIGW deployment and it's created by this plugin), so we need to compile UsagePlan and ApiKey and attach them to the newly created APIGW deployment.
I will check how this will be done.

[horike37]

Serverless Step Functions plugin has same implementation. This may help you.
https://github.com/horike37/serverless-step-functions/blob/2d51bc0704fb89835adb6bee3cbd9cade894d1e9/lib/deploy/events/apiGateway/apiKeys.js
https://github.com/horike37/serverless-step-functions/blob/2d51bc0704fb89835adb6bee3cbd9cade894d1e9/lib/deploy/events/apiGateway/usagePlan.js

[joshband]

Loving this plugin. I am running up against the need for an API key as well (using an SNS proxy). Any direction or example yml showing how I would go about defining and attaching a UsagePlan and ApiKey to the APIGW deployment within the serverless.yml would be very much appreciated. (I'm assuming via the resources section?) I can try and suss out the answer via the above step function code and translate that to resources but am hoping somebody a bit more skilled in CF can point me in the right direction. Thanks!

[ndreno]

Hi, any update on that one?

Spent so many hours on this bug before realising that's because I've added the plugin in my serverless :'(

[VED-StefanHorne]

Hi, any update on that one?

Spent so many hours on this bug before realising that's because I've added the plugin in my serverless :'(

Seconded!

[VED-StefanHorne]

@horike37 See #109