aws-cdk icon indicating copy to clipboard operation
aws-cdk copied to clipboard

chore: correct installLatestAwsSdkDefault flag docs

Open joshlartz opened this issue 1 year ago • 4 comments

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

joshlartz avatar Jan 26 '24 19:01 joshlartz

Thanks @kylelaker !

joshlartz avatar Jan 29 '24 15:01 joshlartz

AWS CodeBuild CI Report

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

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

aws-cdk-automation avatar Jan 30 '24 16:01 aws-cdk-automation

@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
  }
}

joshlartz avatar Jan 30 '24 16:01 joshlartz

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 avatar Feb 21 '24 00:02 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.

aws-cdk-automation avatar Feb 28 '24 18:02 aws-cdk-automation

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

joshlartz avatar Feb 29 '24 00:02 joshlartz