обновить-домен-пула-пользователей

Описание

Домен пула пользователей предоставляет управляемый вход, сервер авторизации и веб-сервер для аутентификации в вашем приложении. Данная операция обновляет версию брендирования для доменов пула пользователей между 1 для размещенного пользовательского интерфейса (классический) и 2 для управляемого входа. Она также обновляет сертификат SSL для пользовательских доменов пула пользователей.

Изменения в версии брендирования домена вступают в силу в течение примерно одной минуты для домена с префиксом и в течение до пяти минут для пользовательского домена.

Данная операция не изменяет имя вашего домена пула пользователей. Чтобы изменить домен, удалите его с помощью DeleteUserPoolDomain и создайте новый домен с помощью CreateUserPoolDomain .

Вы можете передать ARN нового сертификата Certificate Manager в этом запросе. Обычно сертификаты ACM автоматически возобновляются, и ваш пул пользователей может продолжить использовать тот же ARN. Но если вы генерируете новый сертификат для своего пользовательского доменного имени, замените исходную конфигурацию новым ARN в этом запросе.

Сертификаты ACM для пользовательских доменов должны находиться в регионе Amazon Web Services США-Восточный (Вирджиния-Северная). После отправки запроса Amazon Cognito требуется до 1 часа для распространения нового сертификата на ваш пользовательский домен.

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

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

Синтаксис

  update-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
• text
• таблица
• 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.

• base64
• raw-in-base64-out

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

Отключить пейджер CLI для вывода.

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

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

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

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

Примеры

Для обновления пользовательского домена

Следующий update-user-pool-domain пример настраивает версию брендирования и сертификат для пользовательского домена запрошенного пула пользователей.

aws cognito-idp update-user-pool-domain \
    --user-pool-id ca-central-1_EXAMPLE \
    --domain auth.example.com \
    --managed-login-version 2 \
    --custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "CloudFrontDomain": "example.cloudfront.net",
    "ManagedLoginVersion": 2
}

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

Вывод

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

CloudFrontDomain -> (строка)