AWS Mobile Hub → Amplify CLI Migrator
A plugin to migrate existing AWS Mobile Hub projects to be used with the Amplify CLI. With this plugin, you will be able to:
- Re-use resources created by Mobile Hub in the Amplify CLI (compatible with Amplify CLI
version >= 1.1.7
) - Leverage Amplify CLI functionality such as GraphQL APIs (provisioned by AWS AppSync), GraphQL transform, and the Codegen functionality.
You will not be able to:
- Use the CLI's multi-environment feature with migrated Mobile Hub projects.
- Import Mobile Hub projects into existing Amplify projects that are already using the multi-env feature.
Installation Guide
To get started, make sure you've installed the Amplify CLI. Please refer to the getting started guide on GitHub.
npm install -g @aws-amplify/cli
After installing the official CLI you now have to install this plugin on your local machine.
npm i -g amplify-mobilehub-migrator
Usage
- Create a new directory or use existing project directory.
mkdir amplify-project && cd amplify-project
- Walk through initializing the amplify project
amplify init
- Import your mobile hub resources
amplify mobilehub import <projectId>
The mobile hub project Id can be retrieved from the url when you navigate to a project in the aws mobile hub console.
eg. https://console.aws.amazon.com/mobilehub/home?#/af12bd20-3fbb-1234-bcc3-86fd1a57cb93/build
project Id : af12bd20-3fbb-1234-bcc3-86fd1a57cb93
Notes
- In order to preseve production data in existing mobile hub resources, the migrator plugin cannot be used with the multiple environments feature in Amplify.
- Please report any issues in the 'Issues' tab of this repository.
License
This library is licensed under the Apache 2.0 License.