chore: correct installLatestAwsSdkDefault flag docs

[joshlartz]

Correcting docs about this flag as the implementation still defaults to true.

https://github.com/aws/aws-cdk/blob/v2.123.0/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts#L471-L473

---

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

[aws-cdk-automation]

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.

[kylelaker]

That markdown file will get overwritten the next time the package is built. If this documentation change is correct, I believe this needs to be changed by specifying defaults: { v2: true } in features.ts. I am not sure if that will have any other downstream effects.

The change would be somewhere around here:

aws-cdk/packages/aws-cdk-lib/cx-api/lib/features.ts

Lines 647 to 649 in 6a7a24a

	compatibilityWithOldBehaviorMd: 'Set installLatestAwsSdk: true on all resources that need it.',
	introducedIn: { v2: '2.60.0' },
	recommendedValue: false,

This is the code that performs the generation of that markdown file:

aws-cdk/packages/aws-cdk-lib/cx-api/build-tools/flag-report.ts

Lines 95 to 99 in 6a7a24a

	flag.introducedIn.v2
	? [flag.introducedIn.v2, renderValue(flag.defaults?.v2 ?? false), renderValue(flag.recommendedValue)]
	: flag.defaults?.v2 !== undefined
	? ['(default in v2)', renderValue(flag.defaults?.v2), '']
	: ['(not in v2)', '', ''],

[joshlartz]

Thanks @kylelaker !

[kylelaker]

Thanks! I think there should be some other files that are modified as a consequence of this if you were to build the aws-cdk-lib package. CONTRIBUTING.md has details on how to do that, but you probably would want to do the following:

1. In the base of the repo run yarn install to install all the CDK dependencies
2. Move into the aws-cdk-lib directory with cd packages/aws-cdk-lib
3. Build that package and its dependencies with ../../scripts/buildup

From there, you can run tests locally with yarn test. The CodeBuild check on the PR will also run the full test suite after you push.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 0b03393
• Result: FAILED
• Build Logs (available for 30 days)

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

[joshlartz]

@kylelaker You were right that there were unintended changes from this. It looks like there was an assumption built in that flags would always end up being true in v2. It is causing the "Flags with a different default in v2" section to be updated incorrectly.

Example:

Flag	Summary	Type	Since	v1 default	v2 default
@aws-cdk/customresources:installLatestAwsSdkDefault	Whether to install the latest SDK by default in AwsCustomResource	(default)		false	true

Here is an example of a cdk.json file that restores v1 behavior for these flags:

{
  "context": {
    "@aws-cdk/core:newStyleStackSynthesis": false,
    "@aws-cdk/core:stackRelativeExports": false,
    "@aws-cdk/aws-rds:lowercaseDbIdentifier": false,
    "@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId": false,
    "@aws-cdk/aws-lambda:recognizeVersionProps": false,
    "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": false,
    "@aws-cdk/customresources:installLatestAwsSdkDefault": false
  }
}

[aws-cdk-automation]

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.

[aws-cdk-automation]

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.

[joshlartz]

Not stale, just waiting on an answer still :(
@kylelaker