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.

Sign up for GitHub

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

Jump to bottom

Custom names for API keys in API Gateway #7767

Closed
vertti opened this issue May 4, 2020 · 0 comments · Fixed by #7714
Closed

Custom names for API keys in API Gateway #7767

vertti opened this issue May 4, 2020 · 0 comments · Fixed by #7714
Assignees
@nija-at
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md

Comments

@vertti
Copy link

vertti commented May 4, 2020 •
edited
Loading

Currently you can only create API keys with api_key = api.add_api_key("foobar") but the name/ID given in that call is not used. This is really inconvenient if you for example want to create multiple API keys for different users. You should be able to name them apikey-customer1 etc, instead they are now all called my-stack-2934209384.

Use Case

I have multiple systems calling my API and I want to have separate usage plans and API keys for them with sensible names. Sensible names help in managing the keys.

Proposed Solution

Most constructs take an optional name parameter which then overrides the CFN auto-generated name-hash. Same should be possible for API keys.

This is a 🚀 Feature Request
@vertti vertti added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels May 4, 2020
@SomayaB SomayaB added the @aws-cdk/aws-apigateway Related to Amazon API Gateway label May 5, 2020
@nija-at nija-at mentioned this issue May 12, 2020
Merged
@nija-at nija-at added effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md and removed needs-triage This issue or PR still needs to be triaged. labels May 12, 2020
@mergify mergify bot closed this as completed in #7714 May 13, 2020
mergify bot pushed a commit that referenced this issue May 13, 2020
@njlynch
feat(apigateway): specify API key name and value in addApiKey() (#7714
e93da2c 
)

fixes #3233
fixes #7767
karupanerura pushed a commit to karupanerura/aws-cdk that referenced this issue May 22, 2020
@njlynch @karupanerura
feat(apigateway): specify API key name and value in addApiKey() (aw…
06e3f01 
…s#7714)

fixes aws#3233
fixes aws#7767
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nija-at nija-at

Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(apigateway): support for API Key values and names
3 participants
@vertti @nija-at @SomayaB