Page updated Nov 8, 2023

Use existing AWS resources

Existing AWS AppSync resources can be used with the Amplify Libraries by referencing your AWS AppSync endpoint and configuring authorization in your amplifyconfiguration.json file.

{ "api": { "plugins": { "awsAPIPlugin": { "[API NAME]": { "endpointType": "GraphQL", "endpoint": "[APPSYNC ENDPOINT]", "region": "[REGION]", "authorizationType": "[AUTHORIZATION TYPE]", ... } } } } }
1{
2 "api": {
3 "plugins": {
4 "awsAPIPlugin": {
5 "[API NAME]": {
6 "endpointType": "GraphQL",
7 "endpoint": "[APPSYNC ENDPOINT]",
8 "region": "[REGION]",
9 "authorizationType": "[AUTHORIZATION TYPE]",
10 ...
11 }
12 }
13 }
14 }
15}
  • API NAME: Friendly name for the API (e.g., api)
    • endpoint: The HTTPS endpoint of the AWS AppSync API (e.g. https://aaaaaaaaaaaaaaaaaaaaaaaaaa.appsync-api.us-east-1.amazonaws.com/graphql). Custom domain names can also be supplied here (e.g. https://api.yourdomain.com/graphql). Custom domain names can have any format, but must end with /graphql (see https://graphql.org/learn/serving-over-http/#uris-routes).
    • region: AWS Region where the resources are provisioned (e.g. us-east-1)
    • authorizationType: Authorization mode for accessing the API. This can be one of: AMAZON_COGNITO_USER_POOLS, AWS_IAM, OPENID_CONNECT, or API_KEY. Each mode requires additional configuration parameters. See Configure authorization modes for details.

Note that before you can add an AWS resource to your application, the application must have the Amplify libraries installed. If you need to perform this step, see Install Amplify Libraries.