(aws_appsync): Unable to reference external SourceApis in Defintions.fromSourceApis()

[richardsonmarkj]

Describe the bug

I believe this is simply a typo in the creation of the reference type SourceApi. The issue is that SourceApi.sourceApi is of a GraphqlApi type. This requires that the source API be created in the stack. This should instead be a IGraphqlApi type so that the results of a lookup using GraphqlApi.fromGraphqlApiAttributes

Expected Behavior

The following Typescript code compiles:

import * as cdk from "aws-cdk-lib"
import {Definition, GraphqlApi, MergeType} from "aws-cdk-lib/aws-appsync"
import {Construct} from "constructs"

export class BadStack extends cdk.Stack {
	constructor(scope:Construct, id:string, props?: cdk.StackProps) {
		super(scope, id, props)
		
		const apiId = "API_ID"
		const apiArn = "API_ARN"
		const api = new GraphqlApi(this, 'merged-api', {
			name: 'MergedAPI',
			definition: Definition.fromSourceApis({
				sourceApis: [
					{
						sourceApi: GraphqlApi.fromGraphqlApiAttributes(this, 'source-api', {
							graphqlApiId: apiId,
							graphqlApiArn: apiArn,
						}),
						mergeType: MergeType.AUTO_MERGE,
					}
				]
			})
		})
	}
}

Current Behavior

The code fails to compile reporting the following error

TS2740: Type 'IGraphqlApi' is missing the following properties from type 'GraphqlApi': graphqlUrl, name, schema, modes, and 24 more.  
graphqlapi.d.ts(304, 14): The expected type comes from property 'sourceApi' which is declared here on type 'SourceApi'

Reproduction Steps

import * as cdk from "aws-cdk-lib"
import {Definition, GraphqlApi, MergeType} from "aws-cdk-lib/aws-appsync"
import {Construct} from "constructs"

export class BadStack extends cdk.Stack {
	constructor(scope:Construct, id:string, props?: cdk.StackProps) {
		super(scope, id, props)
		
		const apiId = "API_ID"
		const apiArn = "API_ARN"
		const api = new GraphqlApi(this, 'merged-api', {
			name: 'MergedAPI',
			definition: Definition.fromSourceApis({
				sourceApis: [
					{
						sourceApi: GraphqlApi.fromGraphqlApiAttributes(this, 'source-api', {
							graphqlApiId: apiId,
							graphqlApiArn: apiArn,
						}),
						mergeType: MergeType.AUTO_MERGE,
					}
				]
			})
		})
	}
}

After cdk init app --language typescript replace the contents of ./lib/<name>-stack.ts with the above code. The compiler should report the error

TS2740: Type 'IGraphqlApi' is missing the following properties from type 'GraphqlApi': graphqlUrl, name, schema, modes, and 24 more.  
graphqlapi.d.ts(304, 14): The expected type comes from property 'sourceApi' which is declared here on type 'SourceApi'

Possible Solution

Change the type of SourceApi.sourceApi to IGraphqlApi

Additional Information/Context

No response

CDK CLI Version

2.94.0 (build 987c329)

Framework Version

2.95.1

Node.js Version

v18.7.0

OS

MacOs

Language

Typescript

Language Version

3.9.7

Other information

No response

[peterwoodworth]

Yes, as far as I can tell this should be able to seamlessly accept an IGraphqlApi - as the only values that are read that I can find are accessible on IGraphqlApi. Thanks for the issue

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts

Lines 704 to 730 in ae455d8

	private setupSourceApiAssociations() {
	this.definition.sourceApiOptions?.sourceApis.forEach(sourceApiOption => {
	new CfnSourceApiAssociation(this, `${sourceApiOption.sourceApi.node.id}Association`, {
	sourceApiIdentifier: sourceApiOption.sourceApi.apiId,
	mergedApiIdentifier: this.api.attrApiId,
	sourceApiAssociationConfig: {
	mergeType: sourceApiOption.mergeType ?? MergeType.AUTO_MERGE,
	},
	});
	});
	}
	private setupMergedApiExecutionRole(sourceApiOptions: SourceApiOptions) {
	if (sourceApiOptions.mergedApiExecutionRole) {
	this.mergedApiExecutionRole = sourceApiOptions.mergedApiExecutionRole;
	} else {
	const sourceApiArns = sourceApiOptions.sourceApis?.map(sourceApiOption => {
	return sourceApiOption.sourceApi.arn;
	});
	this.mergedApiExecutionRole = new Role(this, 'MergedApiExecutionRole', {
	assumedBy: new ServicePrincipal('appsync.amazonaws.com'),
	});
	this.mergedApiExecutionRole.addToPolicy(new PolicyStatement({
	resources: sourceApiArns,
	actions: ['appsync:SourceGraphQL'],
	}));

[ndejaco2]

The PR #27121 I have in progress should partly address this as it would allow you to create the SourceApiAssociation as a standalone construct for the cases when the source api or merged api is not in the same stack as long as you have the identifier (api id for same account / ARN for cross account use case )

[scanlonp]

This was fixed by #27121. If this does not address your issue, ping me on this thread.

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