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

fix(apigateway): cannot remove first api key from usage plan #12505

Merged
merged 3 commits into from
Jan 21, 2021

Conversation

nija-at
Copy link
Contributor

@nija-at nija-at commented Jan 14, 2021

This is caused by a commit introduced back in Nov 2019.
The original change tried to be overly ambitious in not triggering a
resource replacement on customers who already had a single key usage
plan configured.

This results in stack update failures for a usage plan with multiple
keys, when the first key is removed. Removal of the first key
re-adjusts the logical ids of all the keys in a way that makes the
update look like the first key is changing and a subsequent key is being
removed.

The fix is to simply not special case the first key.

Resource replacement of Usage Plan Key resource should not create any
impact on running applications.

fixes #11876


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

This is caused by a [commit introduced] back in Nov 2019.
The original change tried to be overly ambitious in not triggering a
resource replacement on customers who already had a single key usage
plan configured.

This results in stack update failures for a usage plan with multiple
keys, when the **first** key is removed. Removal of the first key
re-adjusts the logical ids of all the keys in a way that makes the
update look like the first key is changing and a subsequent key is being
removed.

The fix is to simply not special case the first key.

Resource replacement of Usage Plan Key resource should not create any
impact on running applications.

fixes #11876

[commit introduced]: 142bd0e
@nija-at nija-at requested a review from a team January 14, 2021 12:18
@nija-at nija-at self-assigned this Jan 14, 2021
@gitpod-io
Copy link

gitpod-io bot commented Jan 14, 2021

@github-actions github-actions bot added the @aws-cdk/aws-apigateway Related to Amazon API Gateway label Jan 14, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 14, 2021
@NetaNir
Copy link
Contributor

NetaNir commented Jan 20, 2021

So basically if you remove the first key then second key gets renamed? ouch

@mergify
Copy link
Contributor

mergify bot commented Jan 20, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 83300c2
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Jan 21, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 96cbe32 into master Jan 21, 2021
@mergify mergify bot deleted the nija-at/apigw-usageplan branch January 21, 2021 00:04
mohanrajendran pushed a commit to mohanrajendran/aws-cdk that referenced this pull request Jan 24, 2021
This is caused by a [commit introduced] back in Nov 2019.
The original change tried to be overly ambitious in not triggering a
resource replacement on customers who already had a single key usage
plan configured.

This results in stack update failures for a usage plan with multiple
keys, when the **first** key is removed. Removal of the first key
re-adjusts the logical ids of all the keys in a way that makes the
update look like the first key is changing and a subsequent key is being
removed.

The fix is to simply not special case the first key.

Resource replacement of Usage Plan Key resource should not create any
impact on running applications.

fixes aws#11876

[commit introduced]: aws@142bd0e

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(@aws-cdk/aws-apigateway): Wrong Logical ID for UsagePlanKeyResource
3 participants