add reason to CfnNotStabilizedException #364
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aygold92
suggested changes
Apr 15, 2021
Comment on lines
31
to
35
| * @param reason Reason why the resource did not stabilize. This should include the current and | ||
| * desired state. | ||
| * | ||
| * Example: "Exceeded retry limit for DescribeResourceStatus. | ||
| * Current Value: IN_PROGRESS. Desired Value: COMPLETE." |
There was a problem hiding this comment.
nice, I like the docs and providing an example. Couple comments:
- I don't think desired state is necessary
- For AWS resources, it should include the current state, Api name in iam format (like ec2:DescribeInstances) and the RequestId for that API (for non AWS resources it would be whatever the equivalent debugging info)
The example here is also a little bit confusing. Is this one example or two examples? Here's one
* Instance Status: pending (Api: ec2:DescribeInstances, RequestId: abcd-efgh-ijkl)
* Current Status: modifying (Api: rds:DescribeDBClusters, RequestId: abcd-efgh-ijkl)
Another option here would be to take the apiName and requestid as parameters
aygold92
approved these changes
Apr 28, 2021
| @@ -25,14 +25,64 @@ public CfnNotStabilizedException(final Throwable cause) { | |||
| super(cause, ERROR_CODE); | |||
| } | |||
|
|
|||
| /** | |||
| * @param resourceTypeName | |||
There was a problem hiding this comment.
nit: can remove this duplicate doc entry
sungkkim
approved these changes
May 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current stabilization error message "Resource of type '%s' with identifier '%s' did not stabilize." lacks a reason so users may not be able to determine the cause of the stabilization error.
Changes
Testing
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.