custom-resources: Incorrect documentation/comment for deprecated ProviderProps.role property

[memorsolutions]

Describe the issue

#33600 separated the role property into two new properties, frameworkOnEventRole and frameworkCompleteAndTimeoutRole. However, the comment deprecating the old role property incorrectly states that there are 3 new properties, frameworkOnEventLambdaRole, frameworkIsCompleteLambdaRole, and frameworkOnTimeoutLambdaRole. Both the number of properties listed in the comment and the spelling of the names are incorrect.

This error makes it's way into the online documentation as shown in the links below.

Links

role

frameworkOnEventRole

frameworkCompleteAndTimeoutRole

[pahud]

Hi @memorsolutions,

Thank you for reporting this documentation issue! You're absolutely correct - the deprecation comment for the role property in ProviderProps contains incorrect information.

The current comment incorrectly states:

@deprecated - Use frameworkOnEventLambdaRole, frameworkIsCompleteLambdaRole, frameworkOnTimeoutLambdaRole

But it should be:

@deprecated - Use frameworkOnEventRole, frameworkCompleteAndTimeoutRole

The issues you identified are:

1. Wrong count: The comment mentions 3 properties, but there are only 2 replacement properties
2. Wrong names: The property names in the comment include "Lambda" which doesn't exist in the actual implementation

The correct replacement properties are:

• frameworkOnEventRole - for the onEvent Lambda function
• frameworkCompleteAndTimeoutRole - shared by both isComplete and onTimeout Lambda functions

This is a simple documentation fix that needs to be updated in the Provider class. The fix will automatically update the online API documentation.

Would you be interested in contributing a PR to fix this? It's a great first contribution opportunity - just a one-line change to correct the deprecation comment. Let me know if you'd like guidance on the contribution process!

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.