fix: link the API gateway resource parent to either rest api or another gateway resource

[moelasmar]

Which issue(s) does this change fix?

#5639

Why is this change necessary?

Customers are not able to run SAM CLI commands on Terraform projects that contains nested V1 APIs definition

How does it address the issue?

I updated the common linking logic to accept multiple destination resource types, so it will validate that some Terraform resource can be linked to any resource of the expected destination resources array. It will only raise the validation exception if the found destination does not match any of the expected resources.

I also updated the call back logic to expect resource type for the found reference resource, so it can differentiate between different destination resources, and can handle each one as expected.

I added a new exception (UnexpectedDestinationResource) to be used for the validation cases, so we can easily differentiate between the validation problems, and other linking issues.

I added a new linking method to link the gateway resource to the parent resources which can be either a rest API, or another gateway resource.

What side effects does this change have?

N/A

Mandatory Checklist

PRs will only be reviewed after checklist is complete

• Add input/output type hints to new functions/methods
• Write design document if needed (Do I need to write a design document?)
• Write/update unit tests
• Write/update integration tests
• Write/update functional tests if needed
• make pr passes
• make update-reproducible-reqs if dependencies were changed
• Write documentation

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

[mildaniel]

Thanks Mohamed. Great fix.

[mildaniel]

The onus is then on us to know in which cases there could be multiple destinations, correct? I'm assuming there's similar case with V2 APIs for nested resources that we missed?

[moelasmar]

yes, I am going to review all links we have to make sure we did not miss anything else

[mildaniel]

Curious what this configuration is for.

[moelasmar]

this part might be not needed, i was trying to fix some failures for terraform apply command, but in general the triggers is to let TF know when to update the stage resource even if the stage itself does not change, and lifecycle helped me to destroy the project when It was partially created.

[lucashuy]

Nice catch for making the resource names unique