Skip to content
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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

chore(custom-resource): update code comments to reflect actual behavior #30214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90014ec
fix: corrected code comments
engineer-taro May 15, 2024
363fbac
Merge branch 'main' into chore/fix-custom-resource-code-comment
engineer-taro Jun 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

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) {

*/
readonly memorySize?: number;

Expand All @@ -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.
Copy link
Contributor Author

@engineer-taro engineer-taro May 15, 2024 •
edited
Loading

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.

Copy link
Contributor

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.

*
* If not specified, this uses whatever JavaScript SDK version is the default in
* AWS Lambda at the time of execution.
Expand Down