Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.48 KB

install_n_config.md

File metadata and controls

88 lines (58 loc) · 3.48 KB
Raw

Installation and Configuration

Installation

For Web development, regardless of framework, aws-amplify provides core APIs

npm install aws-amplify

On React app, there are helper components in aws-amplify-react

npm install aws-amplify-react

In React Native development, core APIs and components are packaged into aws-amplify-react-native

npm install aws-amplify-react-native

You will need to link libraries in your project for the Auth module on React Native. Follow the instructions here.

Configuration

You are required to pass in an Amazon Cognito Identity Pool ID, allowing the library to retrieve base credentials for a user even in an UnAuthenticated state. You can configure it by yourself or let AWS Mobile Hub do it for you.

Note: If using Mobile Hub, ensure that user sign-in is set to optional in your app. To do so, go your project on AWS Mobile Hub console and click on your project, and then click on the User Sign-in tile. Verify that Optional button is selected in the options for Sign-In required.

Manual Setup

At the top of your application entry point, add in the following code to configure the library:

import Amplify from 'aws-amplify';

Amplify.configure({
    Auth: {
        identityPoolId: 'XX-XXXX-X:XXXXXXXX-XXXX-1234-abcd-1234567890ab', //REQUIRED - Amazon Cognito Identity Pool ID
        region: 'XX-XXXX-X', // REQUIRED - Amazon Cognito Region
        userPoolId: 'XX-XXXX-X_abcd1234', //OPTIONAL - Amazon Cognito User Pool ID
        userPoolWebClientId: 'XX-XXXX-X_abcd1234', //OPTIONAL - Amazon Cognito Web Client ID
    }
});

The above configuration requires an Amazon Cognito Identity Pool ID so that the library can retrieve base credentials for a user even in an UnAuthenticated state. You will also need to include Amazon Cognito User Pool ID and Web Client ID.

Amazon Cognito Identity

Amazon Cognito User Pools

Automated Setup

AWS Mobile Hub streamlines the steps above for you. Simply click this button:

This creates a project is fully functioning with the Auth category. After the project is created in the Mobile Hub console download the aws-exports.js configuration file by clicking the Hosting and Streaming tile then Download aws-exports.js.

Mobile Hub

Download aws-exports.js into your project source directory.

Download

Now import the file and pass it as configuration to the Amplify library:

import Amplify from 'aws-amplify';
import aws_exports from './YOUR_PATH_TO_EXPORTS/aws-exports'

Amplify.configure(aws_exports);