aws/aws-cdk

(AppSync): Add `GraphqlApi.fromApiName()` method to lookup existing APIs from other CDK projects

Open

#13,440 opened on Mar 6, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/aws-appsynceffort/smallfeature-requestfeature/enhancementgood first issuep2

Description

Adding the static method fromApiName() to the GraphqlApi object will allow the configuration of APIs in separate projects.

Currently alternative is to use fromGraphqlApiAttributes which required knowledge of the exact ID or ARN used in the current environment, which is a configuration overhead for all projects to maintain and update the values across environments.

Use Case

We are setting up a number of graphQL end points that we would like to be reachable through a single CloudFront controlled URL.

The target end URL is services.domain.com with the following endPoints:

  • /endPoint1
  • /endPoint2
  • /endPoint3

etc

Each endPoint is serviced with different lamba functions that we would like to configure in separate projects, rather than build a single project with the lambdas for all end points. This will allow us to more easily manage the roll-out of different functions.

At the moment to do this we need to collect the IDs for each GraphqlApi once they are generated in the main project and then configure them per environment in each lambda project.

This API would simplify things.

Proposed Solution

GraphqlApi.fromApiName(scope: Construct, id: string, apiName: string): IGraphqlApi

Similar to the way a Bucket can be looked up:

Bucket.fromBucketName(scope: Construct, id: string, bucketName: string): IBucket

Other

  • :wave: I may be able to implement this feature request
  • :warning: This feature might incur a breaking change

This is a :rocket: Feature Request

Contributor guide

Tech stack
typescriptgraphql
Domain
apicloudinfrastructure
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWS CDK basicsTypeScriptAppSync knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing implementation of fromGraphqlApiAttributes in the AWS CDK AppSync library. Examine how similar lookup methods (e.g., fromBucketName) are implemented. The new method should call the AppSync API to retrieve the ARN given the API name. Consider the required IAM permissions and error handling. The implementation should be added to the GraphqlApi class in the @aws cdk/aws appsync package.