aws-events-targets: API Gateway target should accept IRestApi and not RestApi

[AWS-MattB]

The ApiGateway target in aws-events-targets requires a RestApi from aws-apigateway as part of the constructor. This is actually too restrictive and, as far as I can tell, the implementation does not require that particular subclass. The inheritance hierarchy in aws-apigateway is as follows. The current requirements preclude using a SpecRestApi as a target, without good reason.

export class SpecRestApi extends RestApiBase {}
export class RestApi extends RestApiBase {}
export abstract class RestApiBase extends Resource implements IRestApi {}

The implementation of ApiGateway makes use of this.restApi.arnForExecuteApi() and this.restApi.deploymentStage.stageName, both of which are defined in IRestApi.

Reproduction Steps

        const swaggerDefinition = getSwaggerDefinition(...);
        this.api = new SpecRestApi(this, "RestApi", {
            apiDefinition: ApiDefinition.fromInline(swaggerDefinition),
        })

        // @ts-ignore
        let uglyHack : RestApi = this.api;
        const event_bridge_rule = new Rule(this, "EventBridgeRule", {
            eventPattern: {source: ["aws.ecs"], detailType: ["ECS Task State Change"]},
            targets: [new ApiGateway(uglyHack, {....})]
        })

What did you expect to happen?

The ApiGateway target from aws-events-targets should accept an IRestApi so that a Rest API built from a swagger or OpenAPI definition can be used as a target for an Event Bridge Rule.

What actually happened?

Only RestApi are accepted, so I'm precluded from using a SpecRestApi, which is a sibling to RestApi.

Environment

• CDK CLI Version : 1.120.0
• Framework Version: 1.120.0
• Node.js Version: v12.22.6
• OS : all
• Language (Version): all

---

This is 🐛 Bug Report

[rix0rrr]

I agree. Feel free to submit a PR with the change.

[mcwebb]

I'm also facing this issue, I can see there was a PR that was closed but I can't see why it was closed, does this need a new PR opened?

[AshRhazaly]

Facing the issue as well, why was the PR closed?

[Sevi7]

Same here

[abhigyandwiji]

Looking forward to the change. Planning to use it

[sharmagg]

I'm facing the exact same issue

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