Page updated Nov 8, 2023

Use existing AWS resources

Amplify Android v1 is now in Maintenance Mode until May 31st, 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 v1.

Please use the latest version (v2) of Amplify Library for Android to get started.

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

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]", ... } } } } }
1{
2 "api": {
3 "plugins": {
4 "awsAPIPlugin": {
5 "[API NAME]": {
6 "endpointType": "REST",
7 "endpoint": "[API GATEWAY 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 API (e.g. https://aaaaaaaaaa.execute-api.us-east-1.amazonaws.com/api)
    • 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: NONE, AWS_IAM, AMAZON_COGNITO_USER_POOLS, or API_KEY. Each mode with the exception of NONE 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.