Skip to main content Skip to complementary content

Deploying your portal with AWS Amplify

Deploy your portal by connecting your repository to AWS Amplify Console. For more information, see the Amplify documentation.

Before you begin

  • You have the relevant rights on AWS.
  • You have generated your API Portal repository.

Procedure

  1. Log in to AWS and open the Amplify service.
  2. Create a new app:
    • If this is the first web app on your account, click Get started under Host your web app at the bottom of the AWS Amplify homepage.
    • If there are already other web apps, click New app > Host web app.
  3. Select your Git provider as the source, and click Continue to connect your repository.
    For example, select GitHub in the Host your web app page.
  4. Click Authorize aws-amplify-console.
  5. Select your repository and your branch, then click Next.
    In this example, the repository is jsmith/api-portal and the branch is main.
    The name of your repository is set as your app name and your build settings are automatically detected.
  6. Enter a new name for your app if needed, then click Next.
  7. Make sure that your configuration is correct and click Save and deploy.
    Review the repository details and the app settings in the Review page.

Results

Your portal is built and deployed. You can click the link provided to see it.
The URL appears in the api-portal app page.
If needed, you can restrict access to your portal by adding a username and password in App settings > Access control.
Access control page.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here