[apigateway] Allow import of API Gateway Resource

[dehli]

It would be great if we could add a Resource.fromResourceId for API Gateway resources. I could imagine it looking something like this:

Resource.fromResourceId(scope, "Id", {
  restApi,
  resourceId: "abcdef"
});

Use Case

We have existing CloudFormation infrastructure that we're integrating with CDK and it would be great to utilize Resource without having to always use CfnResource.

Proposed Solution

I'd imagine it would behave similarly to Role.fromRoleArn() or RestApi.fromRestApiId(). Will try to get a PR created but wanted to open this issue in case there was a reason it doesn't exist yet.

My initial solution creates a class like below:

const fromResourceId = (scope: Construct, id: string, props: {
  path?: string;
  resourceId: string;
  restApi: IRestApi;
}): ResourceBase => {
  class Import extends ResourceBase {
    public readonly defaultIntegration: Integration;
    public readonly defaultMethodOptions: MethodOptions;
    public readonly parentResource: IResource;
    public readonly path: string = props.path || '/';
    public readonly restApi = props.restApi as RestApi;
    public readonly resourceId: string = props.resourceId;
  }
  return new Import(scope, id);
}

Currently I have restApi as an IRestApi instead of a regular RestApi because that's the return value of RestApi.fromRestApiId(). I'll need to do some work to figure out the proper typing.

Edit: Looks like calling addMethod when using IRestApi doesn't work because there's no stage associated with the API.

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[NGL321]

Hey @dehli,

This seems like a reasonable feature request! It would be wonderful if you wanted to put in a PR for it, and I will make sure it is reviewed.

That aside, someone should update this issue when there is progress.

😸

[Marty-Me]

Hi CDK team and @dehli,

Has there been any progress on this issue, as we are currently facing the same problems.
I've tried looking at the problem myself, but the issue didn't seem to easy to solve.

[rix0rrr]

See also #1477 which has more discussion and workaround code.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.