Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

create-user-pool-domain

Description

Creates a new domain for a user pool.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-user-pool-domain
--domain <value>
--user-pool-id <value>
[--custom-domain-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain (string)

The domain string.

--user-pool-id (string)

The user pool ID.

--custom-domain-config (structure)

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use own custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain .

Shorthand Syntax:

CertificateArn=string

JSON Syntax:

{
  "CertificateArn": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

CloudFrontDomain -> (string)

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.