Page updated Jan 16, 2024

Use existing AWS resources

Amplify Flutter v0 is now in Maintenance Mode until July 19th, 2024. This means that we will continue to include updates to ensure compatibility with backend services and security. No new features will be introduced in v0.

Please use the latest version (v1) of Amplify Flutter to get started.

If you are currently using v0, follow these instructions to upgrade to v1.

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.

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.