chore(cdk): use RegionInfo instead of aws-sdk v2 for region domain suffix

[b177y]

Issue #29838

Progresses (not closes) issue #29838

Reason for this change

CDK uses the function getEndpointSuffix in the AWS JavaScript V2 SDK which is not a private function but is not a publicly documented and supported function of the SDK. The SDK maintainers have pointed out that this should not be used. The V2 SDK is entering maintenance mode on 2024-09-08, with end of support on 2025-09-08.

CDK maintains the region-info package which can provide the domainSuffix property of a region: https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_region-info.RegionInfo.html

Description of changes

This change replaces the call to the unsupported aws-sdk/lib/region_config.getEndpointSuffix with @aws-cdk/region-info.RegionInfo.get(region).domainSuffix.

Description of how you validated changes

No new unit or integration tests have been added as this does not add or change any functionality. A random integration test has been run to verify this works. When the integration test is run, CDK uses the updated function to work out the S3 URL for the CloudFormation template file. This deploys successfully.

yarn integ --parallel-regions eu-west-2 --force --profiles dev --directory /Users/USERNAME/code/custom-aws-cdk/packages/@aws-cdk-testing/framework-integ/test aws-iam/test/integ.role.js
yarn run v1.22.21
$ integ-runner --language javascript --parallel-regions eu-west-2 --force --profiles dev --directory /Users/USERNAME/code/custom-aws-cdk/packages/@aws-cdk-testing/framework-integ/test aws-iam/test/integ.role.js

Verifying integration test snapshots...

  UNCHANGED  aws-iam/test/integ.role 0.424s

Snapshot Results:

Tests:    1 passed, 1 total

Running integration tests for failed tests...

Running in parallel across profiles dev and regions: eu-west-2
Running test /Users/USERNAME/code/custom-aws-cdk/packages/@aws-cdk-testing/framework-integ/test/aws-iam/test/integ.role.js in dev/eu-west-2
  SUCCESS    aws-iam/test/integ.role-integ-iam-role/DefaultTest 83.549s
       NO ASSERTIONS

Test Results:

Tests:    1 passed, 1 total
✨  Done in 84.95s.

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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.

[kuhe]

This PR lgtm from the perspective of the AWS SDK JS team.

[aws-cdk-automation]

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

[b177y]

CodeQL Analyser is failing with:

Severe disk cache trouble (corruption or out of space) at /home/runner/work/_temp/codeql_databases/javascript/db-javascript/default/cache/pages/1b/9c.pack: Failed to write item to disk

Which is the same issue as in PR #30991 - I am assuming this error is related to the configuration of the test runner rather than anything to do with the code changes in these PRs.

[comcalvi]

Our unit tests mock this function so it can be tested. Please remove those mocks and ensure the tests still pass.

[b177y]

Originally I removed this but it caused test/api/logs/logs-monitor.test.ts to fail.

I have it passing by changing the expected num of stderr errors to 2, and pointing the check of the error content to the second index. Let me know if there's a different approach you would rather I take with this.

[comcalvi]

So you removed the mock and that caused that test to fail? What did it fail with?

[b177y]

When removing the line require('aws-sdk/lib/maintenance_mode_message').suppress = true;, the test suite fails with a message that it was expecting one stderr message. I have left the test in that was failing, and have got it to pass by setting it to expect 2 stderr messages

This commit passes the tests without any tests / mocks being removed:
07d4e30

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 6a8d658
• Result: SUCCEEDED
• Build Logs (available for 30 days)

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

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/31008/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

[b177y]

Closing PR as this is being implemented as part of a larger change to CDK.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.