-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
chore(custom-resource): update code comments to reflect actual behavior #30214
chore(custom-resource): update code comments to reflect actual behavior #30214
Conversation
Updated the default value of memorySize to 512MB to reflect that it applies when installAwsSdk is true Corrected the version of the installed AWS SDK from v2 to v3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
@@ -370,7 +370,7 @@ export interface AwsCustomResourceProps { | |||
readonly logGroup?: logs.ILogGroup; | |||
|
|||
/** | |||
* Whether to install the latest AWS SDK v2. | |||
* Whether to install the latest AWS SDK. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In reality, v3 was installed.
While it would be acceptable to specify "v3", I decided not to make any specific reference to the major version, as this would require updating the code each time the major version changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update this comment to match that it is handler-dependent; see https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler/aws-sdk-v3-handler.ts#L40 and https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler/aws-sdk-v2-handler.ts#L64.
@@ -344,7 +344,7 @@ export interface AwsCustomResourceProps { | |||
/** | |||
* The memory size for the singleton Lambda function implementing this custom resource. | |||
* | |||
* @default 512 mega in case if installLatestAwsSdk is false. | |||
* @default 512 mega in case if installLatestAwsSdk is true. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at this implementation, the comments and the actual behavior seem to be reversed.
aws-cdk/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
Line 486 in 4b6dc8c
if (props.installLatestAwsSdk) { |
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). |
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
@@ -370,7 +370,7 @@ export interface AwsCustomResourceProps { | |||
readonly logGroup?: logs.ILogGroup; | |||
|
|||
/** | |||
* Whether to install the latest AWS SDK v2. | |||
* Whether to install the latest AWS SDK. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update this comment to match that it is handler-dependent; see https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler/aws-sdk-v3-handler.ts#L40 and https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler/aws-sdk-v2-handler.ts#L64.
This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
Issue # (if applicable)
Closes #.
Reason for this change
I corrected the code comments to match the actual behavior.
Description of changes
Description of how you validated changes
Since this change only involves comments, no functional testing was performed.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license