chore(custom-resources): correct JSDoc deprecated property names in ProviderProps

[pahud]

Fixes #35049

The deprecated 'role' property in ProviderProps interface had incorrect JSDoc @deprecated comment referencing non-existent property names:

• frameworkOnEventLambdaRole (incorrect)
• frameworkIsCompleteLambdaRole (incorrect)
• frameworkOnTimeoutLambdaRole (incorrect)

Updated to reference the correct property names:

• frameworkOnEventRole
• frameworkCompleteAndTimeoutRole

This improves developer experience by providing accurate migration guidance when using the deprecated role property.

Issue # (if applicable)

Closes #35049.

Reason for this change

The JSDoc @deprecated comment for the role property in the ProviderProps interface contained incorrect property names that don't exist in the interface. This misleads developers who are trying to migrate away from the deprecated property, causing confusion and potential implementation errors.

Description of changes

Files Modified:

• packages/aws-cdk-lib/custom-resources/lib/provider-framework/provider.ts (line 126)

Changes Made:
Updated the JSDoc @deprecated comment from:

@deprecated - Use frameworkOnEventLambdaRole, frameworkIsCompleteLambdaRole, frameworkOnTimeoutLambdaRole

To:

@deprecated - Use frameworkOnEventRole, frameworkCompleteAndTimeoutRole

Why these changes address the issue:

• The corrected property names (frameworkOnEventRole and frameworkCompleteAndTimeoutRole) actually exist in the ProviderProps interface
• These are the proper replacement properties that developers should use instead of the deprecated role property
• The fix aligns the documentation with the actual API, preventing developer confusion

Alternatives considered:

• No alternatives were considered as this is a straightforward documentation correction to match existing interface properties

Design decisions:

• This is purely a documentation fix with no functional changes
• The corrected property names were verified against the actual interface definition and existing test cases

Describe any new or updated permissions being added

No new or updated IAM permissions are needed. This is a documentation-only change that corrects JSDoc comments.

Description of how you validated changes

Build Validation:

• ✅ Module builds successfully (yarn build in custom-resources)
• ✅ JSII compilation passes without errors
• ✅ ESLint passes without warnings

Property Name Verification:

• ✅ Confirmed frameworkOnEventRole exists in the ProviderProps interface (lines 147-154)
• ✅ Confirmed frameworkCompleteAndTimeoutRole exists in the ProviderProps interface (lines 156-166)
• ✅ Verified these properties are used in existing unit tests (packages/aws-cdk-lib/custom-resources/test/provider-framework/provider.test.ts)

Documentation Impact:

• ✅ JSDoc comments now reference actual interface properties
• ✅ Generated language bindings will reflect corrected documentation
• ✅ IDE tooltips will show accurate migration guidance

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[mergify]

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

[mergify]

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

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: e09439f
• Result: SUCCEEDED
• Build Logs (available for 30 days)

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

[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.