Cloudfront Origin does not support SpecRestApi

[brianantonelli]

Describe the bug

The RestApiOrigin constructor only supports RestApi and not RestApiBase. This means a API created via SpecRestApi cannot be used to create a Cloudfront origin.

Expected Behavior

Passing an instance of SpecRestApi to RestApiOrigin should be accepted and create the origin.

Current Behavior

When passing SpecRestApi to RestApiOrigin an error is generated

TypeError: type of argument rest_api must be aws_cdk.aws_apigateway.RestApi; got aws_cdk.aws_apigateway.SpecRestApi instead

Reproduction Steps

1. Create a RestAPI from a OpenAPI spec file
2. Create a Cloudfront distribution that contains an API origin and use the RestAPI generated in step 1

Possible Solution

Update RestApiOrigin constructor to accept RestApiBase for restApi

Additional Information/Context

No response

CDK CLI Version

2.96.0 (build e6322aa)

Framework Version

No response

Node.js Version

v18.17.1

OS

MacOS

Language

Python

Language Version

3.11.4

Other information

No response

[indrora]

Thank you. Can you manually construct this using only Cfn resources?

[peterwoodworth]

@indrora I don't see what Cfn resources have to do with this. This is related to our higher level constructs.

@brianantonelli all the RestApiOrigin construct requires is the url property. SpecRestApi doesn't have this property, but it does have urlForPath() which is exactly what the url property is a getter for on RestApi. So, if we add the url property to SpecRestApi, or move it from RestApi to RestApiBase, I don't see why RestApiOrigin couldn't take in a SpecRestApi.

aws-cdk/packages/aws-cdk-lib/aws-cloudfront-origins/lib/rest-api-origin.ts

Lines 42 to 43 in b2a895e

	super(cdk.Fn.select(2, cdk.Fn.split('/', restApi.url)), {
	originPath: props.originPath ?? `/${cdk.Fn.select(3, cdk.Fn.split('/', restApi.url))}`,

aws-cdk/packages/aws-cdk-lib/aws-apigateway/lib/restapi.ts

Lines 843 to 845 in b2a895e

	public get url() {
	return this.urlForPath();
	}

[hariprakash-j]

@peterwoodworth @brianantonelli I was able to fix the bug and created a PR #27742 , this should be fixed when after they review it and merge it.

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