Menu
Amazon Cognito
Developer Guide

Using the Hosted User Pool Domain

After setting up an app client, you can configure the address of your sign-up and sign-in webpages. You can use the hosted Amazon Cognito domain with your own domain prefix.

To add an app client and an Amazon Cognito hosted domain with the AWS Management Console, see Adding an App to Enable the Hosted Web UI.

Prerequisites

Before you begin, you need:

Step 1: Configure a Hosted User Pool Domain

To configure a hosted user pool domain (AWS Management Console)

You can use the AWS Management Console to configure a user pool domain.

To configure a Amazon Cognito hosted domain

  1. Sign in to the Amazon Cognito console.

  2. In the navigation pane, choose Manage your User Pools, and choose the user pool you want to edit.

  3. Choose the Domain name tab.

  4. Type the domain prefix you want to use in the Prefix domain name box.

  5. Choose Check availability to confirm the domain prefix is available.

  6. Choose Save changes.

To configure a hosted user pool domain (AWS CLI and AWS API)

Use the following commands to create a domain prefix and assign it to your user pool.

To configure a user pool domain

  • AWS CLI: aws cognito-idp create-user-pool-domain

    Example: aws cognito-idp create-user-pool-domain --user-pool-id <user_pool_id> --domain <domain_name>

  • AWS API: CreateUserPoolDomain

To get information about a domain

  • AWS CLI: aws cognito-idp describe-user-pool-domain

    Example: aws cognito-idp describe-user-pool-domain --domain <domain_name>

  • AWS API: DescribeUserPoolDomain

To delete a domain

  • AWS CLI: aws cognito-idp delete-user-pool-domain

    Example: aws cognito-idp delete-user-pool-domain --domain <domain_name>

  • AWS API: DeleteUserPoolDomain

Step 2: Verify Your Sign-in Page

  • Verify that the sign-in page is available from your Amazon Cognito hosted domain.

    https://your_domain/login?response_type=code&client_id=your_app_client_id&redirect_uri=your_callback_url

Your domain is shown on the Domain name page of the Amazon Cognito console. Your app client ID and callback URL are shown on the App client settings page.