fix: move reference interfaces to their own submodules

[rix0rrr]

The introduction of reference interfaces (IBucketRef, IRoleRef, etc) led to an increased potential for cyclic references between service modules. Cyclic references are a problem in both Python and Go, and prevents us from taking this idea as far as we want to go.

In this PR, we introduce a new submodule aws-cdk-lib.interfaces where all reference interfaces will live. Because some services have resources with the same name, there are submodules inside the interfaces submodule, so actual interface references will look like aws-cdk-lib.interfaces.aws_s3.IBucketRef.

Because moving the canonical location for these interfaces will be breaking, we leave behind aliases for them in the old location, so TypeScript code can still do import { IBucketRef } from 'aws-cdk-lib/aws-s3';. Unfortunately we cannot do the same for other languages because (a) jsii doesn't understand type aliases yet and (b) even if it did, type aliases can not be rendered appropriately in either Java or C#. This means that this change might be backwards breaking for some consumers that implement L2 interfaces in jsii client languages, but we are assuming that most people doing this would be using TypeScript which will remain unaffected. It is unfortunate that we have to do this, but we have painted ourselves into a corner that we otherwise cannot get out of.

Implementation notes

This PR contains heavy refactoring in spec2cdk around determining file paths and import paths. We used to have to pass import paths into every service module that we code generated; but if we determine the file names ahead of time, we can also just use path.posix.relative() to determine the right import location, which is much easier to use.

---

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

[aws-cdk-automation]

(This review is outdated)

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[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.

[mergify]

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

[mergify]

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks:

You may have to fix your CI before adding the pull request to the queue again.
If you update this pull request, to fix the CI, it will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue instead, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

[mrgrain]

@Mergifyio queue

[mergify]

queue

🛑 There are no queue conditions matching

There are queue conditions defined in the configuration, but none matches. The pull request has not been embarked.

Details:

• Queue default-merge:

• -closed
• -merged
• label~=no-squash
• #approved-reviews-by>=1
• #changes-requested-reviews-by=0
• -approved-reviews-by~=author
• -label~=(blocked|do-not-merge)
• -title~=(WIP|wip)
• check-success=build
• check-success=validate-pr
• any of:
  • -label~=pr/needs-integration-tests-deployment
  • check-success=Deploy integration test snapshots (requires pr/needs-integration-tests-deployment label)

• Queue priority-squash:

• -closed
• -merged
• label~=priority-pr
• #approved-reviews-by>=1
• #changes-requested-reviews-by=0
• -approved-reviews-by~=author
• -label~=(blocked|do-not-merge|no-squash)
• -title~=(WIP|wip)
• base!=release
• check-success=build
• check-success=validate-pr
• any of:
  • -label~=pr/needs-integration-tests-deployment
  • check-success=Deploy integration test snapshots (requires pr/needs-integration-tests-deployment label)

• Queue default-squash:

• -closed
• -merged
• #approved-reviews-by>=1
• #changes-requested-reviews-by=0
• -approved-reviews-by~=author
• -label~=(blocked|do-not-merge|no-squash|priority-pr)
• -title~=(WIP|wip)
• base!=release
• check-success=build
• check-success=validate-pr
• any of:
  • -label~=pr/needs-integration-tests-deployment
  • check-success=Deploy integration test snapshots (requires pr/needs-integration-tests-deployment label)

[mrgrain]

@Mergifyio refresh

[mergify]

refresh

✅ Pull request refreshed

[mergify]

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

[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.