API (REST)

Use existing AWS resources

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

{ "api": { "plugins": { "awsAPIPlugin": { "[API NAME]": { "endpointType": "REST", "endpoint": "[API GATEWAY ENDPOINT]", "region": "[REGION]", "authorizationType": "[AUTHORIZATION TYPE]", ... } } } } }

{ "api": { "plugins": { "awsAPIPlugin": { "[API NAME]": { "endpointType": "REST", "endpoint": "[API GATEWAY ENDPOINT]", "region": "[REGION]", "authorizationType": "[AUTHORIZATION TYPE]", ... } } } } }
  • API NAME: Friendly name for the API (e.g., api)

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.

Previous Page
previous

Define authorization rules

Discord Logo
Amplify open source, documentation and community are supported by Amazon Web Services © 2020, Amazon Web Services, Inc. and its affiliates. All rights reserved. View the site terms and privacy policy.
    Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.