создание-домена-пользовательского-пула

Описание

Домен пользовательского пула предоставляет управляемый вход, сервер авторизации и веб-сервер для аутентификации в вашем приложении. Эта операция создаёт новый домен-префикс пользовательского пула или настраиваемый домен и устанавливает версию брендинга управляемого входа. Установите версию брендинга в 1 для размещённого пользовательского интерфейса (классический) или 2 для управляемого входа. При выборе настраиваемого домена вы должны предоставить сертификат SSL в регионе Amazon Web Services США Восточный (Северная Вирджиния) в вашем запросе.

Для вашего домена-префикса может потребоваться до одной минуты для вступления в силу. Ваш настраиваемый домен доступен в течение пяти минут, но распространение сертификата SSL может занять до одного часа.

Дополнительную информацию о добавлении настраиваемого домена в ваш пользовательский пул можно найти в разделе Настройка домена пользовательского пула .

См. также: Документация AWS API

Синтаксис

  create-user-pool-domain
--domain <value>
--user-pool-id <value>
[--managed-login-version <value>]
[--custom-domain-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--domain (строка)

--user-pool-id (строка)

--managed-login-version (целое число)

--custom-domain-config (структура)

Сокращённый синтаксис:

CertificateArn=string

Синтаксис JSON:

{
  "CertificateArn": "string"
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выводится пример входного YAML, который может быть использован с --cli-input-yaml. Если предоставлено значение output, валидируются входные данные команды и возвращается пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

• json
• текст
• таблица
• yaml
• потоковый yaml

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить вывод цвета.

• включено
• выключено
• автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр предоставлен.

--ca-bundle (строка)

Пакет сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное значение и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить тумблер кли-пайпера для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Пример 1: Создание домена пользовательского пула

Следующий create-user-pool-domain пример создаёт новый настраиваемый домен.

aws cognito-idp create-user-pool-domain \
    --user-pool-id us-west-2_EXAMPLE \
    --domain auth.example.com \
    --custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222

Вывод:

{
    "CloudFrontDomain": "example1domain.cloudfront.net"
}

Дополнительную информацию см. в разделе Настройка домена пользовательского пула в руководстве разработчика Amazon Cognito.

Пример 2: Создание домена пользовательского пула

Следующий create-user-pool-domain пример создаёт новый домен с собственным префиксом службы.

aws cognito-idp create-user-pool-domain \
    --user-pool-id us-west-2_EXAMPLE2 \
    --domain mydomainprefix

Дополнительную информацию см. в разделе Настройка домена пользовательского пула в руководстве разработчика Amazon Cognito.

Вывод

ManagedLoginVersion -> (целое число)

CloudFrontDomain -> (строка)