Use existing AWS resources

Amplify iOS v1 is deprecated as of June 1st, 2024. No new features or bug fixes will be added. Dependencies may become outdated and potentially introduce compatibility issues.

Please use the latest version (v2) of Amplify Library for Swift to get started. Refer to the upgrade guide for instructions on upgrading your application to the latest version.

Amplify libraries should be used for all new cloud connected applications. If you are currently using the AWS Mobile SDK for iOS, you can access the documentation here.

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]",

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.