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
github-actions
bot
added
beginning-contributor
engineer-taro
changed the title
There was a problem hiding this comment.
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.
engineer-taro
changed the title
engineer-taro
changed the title
aws-cdk-automation
dismissed
their stale review
✅ 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.
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.
| @@ -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.
Looking at this implementation, the comments and the actual behavior seem to be reversed.
aws-cdk-automation
added
the
pr/needs-community-review
|
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
removed
the
pr/needs-community-review
|
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 |
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