Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sam.CfnApi usagePlan support #8616

Closed
1 of 2 tasks
senioroman4uk opened this issue Jun 18, 2020 · 3 comments
Closed
1 of 2 tasks

sam.CfnApi usagePlan support #8616

senioroman4uk opened this issue Jun 18, 2020 · 3 comments
Assignees
Labels
@aws-cdk/aws-sam Related to AWS Serverless Application Model feature-request A feature should be added or improved.

Comments

@senioroman4uk
Copy link

Extend CfnApi to enable usage of ApiGateway usage plans that is already available in cloudFormation according to https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-apiauth.html

But is not available in CDK construct according to https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sam.CfnApi.AuthProperty.html

Use Case

We are using cfn.Api to define api gateway and now have to implement usage plan for throttling

Proposed Solution

I would extend CfnApi.AuthProperty with missing properties from the spec https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-apiauth.html

Other

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

@senioroman4uk senioroman4uk added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jun 18, 2020
@github-actions github-actions bot added the @aws-cdk/aws-sam Related to AWS Serverless Application Model label Jun 18, 2020
@nija-at
Copy link
Contributor

nija-at commented Jun 18, 2020

@senioroman4uk -

Thanks for your interest in contributing to the CDK. However, we don't manually implement anything in the SAM package. It's all autogenerated based on a SAM spec.

This feature is unavailable because the SAM spec we currently is out of date, and unfortunately there is no authoritative and up to date spec for SAM.

This is a duplicate of #7493.

Let me know if there's anything more you would like, or if I've missed anything.

@nija-at nija-at added closing-soon This issue will automatically close in 4 days unless further comments are made. and removed needs-triage This issue or PR still needs to be triaged. labels Jun 18, 2020
@senioroman4uk
Copy link
Author

senioroman4uk commented Jun 18, 2020

@nija-at do you have any plans on implementing #7493? Or you need help with it?

@github-actions github-actions bot removed the closing-soon This issue will automatically close in 4 days unless further comments are made. label Jun 19, 2020
@nija-at
Copy link
Contributor

nija-at commented Jun 22, 2020

Unfortunately, I don't have a solution for how to fix #7493 yet. There is no machine readable spec that SAM publishes - aws/serverless-application-model#1133.

Do you have ideas on how we can do this? If you do, I'd love to hear them. Post them on the other issue.

Closing this issue for now. Let's move this discussion there.

@nija-at nija-at closed this as completed Jun 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-sam Related to AWS Serverless Application Model feature-request A feature should be added or improved.
Projects
None yet
Development

No branches or pull requests

2 participants