Spec-Zone.ru › AWS CLI v2

[ aws . amplifybackend ]

update-backend-auth

Описание

Обновляет существующий ресурс аутентификации бэкенда.

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

Синтаксис

  update-backend-auth
--app-id <value>
--backend-environment-name <value>
--resource-config <value>
--resource-name <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]

Параметры

--app-id (строка)

Идентификатор приложения.

--backend-environment-name (строка)

Название среды бэкенда.

--resource-config (структура)

Конфигурация ресурса для этого объекта запроса.

AuthResources -> (строка)

Определяет имя службы, используемое при конфигурации ресурса аутентификации в вашем проекте Amplify.

IdentityPoolConfigs -> (структура)

Описывает конфигурацию авторизации для пула идентификаторов Amazon Cognito, предоставленного как часть вашего ресурса аутентификации в проекте Amplify.

UnauthenticatedLogin -> (булево)

Булево значение, которое можно установить для разрешения или запрещения авторизации на уровне гостя в ваше приложение Amplify.

Service -> (строка)

Определяет имя службы, используемое при конфигурации ресурса аутентификации в вашем проекте Amplify.

UserPoolConfigs -> (структура)

Описывает конфигурацию аутентификации для пула пользователей Amazon Cognito, предоставленного как часть вашего ресурса аутентификации в проекте Amplify.

ForgotPassword -> (структура)

(УСТЕРЕЛО) Описывает политику сброса пароля для вашего пула пользователей Amazon Cognito, настроенного в вашем проекте Amplify.

DeliveryMethod -> (строка)

(УСТЕРЕЛО) Описывает режим использования (SMS или электронная почта) для доставки сообщений пользователям приложения, которые хотят восстановить свой пароль.

EmailSettings -> (структура)

(УСТЕРЕЛО) Настройка электронного письма, отправляемого, когда пользователь приложения забывает свой пароль.

EmailMessage -> (строка)

Содержание сообщения электронного письма.

EmailSubject -> (строка)

Содержание строки темы сообщения электронного письма.

SmsSettings -> (структура)

(УСТЕРЕЛО) Настройка SMS-сообщения, отправляемого, когда пользователь приложения Amplify забывает свой пароль.

SmsMessage -> (строка)

Содержание SMS-сообщения.

Mfa -> (структура)

Описывает, применять ли политики многофакторной аутентификации для вашего пула пользователей Amazon Cognito, настроенного в вашем проекте Amplify.

MFAMode -> (строка)

Режим MFA для бэкенда вашего проекта Amplify.

Settings -> (структура)

Настройки конфигурации MFA для бэкенда вашего проекта Amplify.

MfaTypes -> (список)

Поддерживаемые типы MFA.

(строка)

SmsMessage -> (строка)

Тело SMS-сообщения.

OAuth -> (структура)

Описывает политику и правила OAuth для вашего пула пользователей Amazon Cognito, настроенного в вашем проекте Amplify.

DomainPrefix -> (строка)

Префикс домена Amazon Cognito, используемый для создания размещенного пользовательского интерфейса для аутентификации.

OAuthGrantType -> (строка)

Тип OAuth-разрешения, позволяющий пользователям приложения аутентифицироваться из вашего приложения Amplify.

OAuthScopes -> (список)

Список потоков, связанных с OAuth, которые могут позволить пользователям аутентифицироваться из вашего приложения Amplify.

(строка)

RedirectSignInURIs -> (список)

Перенаправляющие URL-адреса, которые OAuth использует, когда пользователь входит в систему в приложении Amplify.

(строка)

RedirectSignOutURIs -> (список)

Перенаправляющие URL-адреса, которые OAuth использует, когда пользователь выходит из системы в приложении Amplify.

(строка)

SocialProviderSettings -> (структура)

Описывает конфигурации сторонних социальных федераций для разрешения пользователям входа с помощью OAuth.

Facebook -> (структура)

Описывает конфигурации сторонних социальных федераций для разрешения пользователям приложения входа с использованием OAuth.

ClientId -> (строка)

Описывает client_id, который можно получить от поставщика сторонней социальной федерации.

ClientSecret -> (строка)

Описывает client_secret, который можно получить от поставщиков сторонних социальных федераций.

Google -> (структура)

Описывает конфигурации сторонних социальных федераций для разрешения пользователям приложения входа с использованием OAuth.

ClientId -> (строка)

Описывает client_id, который можно получить от поставщика сторонней социальной федерации.

ClientSecret -> (строка)

Описывает client_secret, который можно получить от поставщиков сторонних социальных федераций.

LoginWithAmazon -> (структура)

Описывает конфигурации сторонних социальных федераций для разрешения пользователям приложения входа с использованием OAuth.

ClientId -> (строка)

Описывает client_id, который можно получить от поставщика сторонней социальной федерации.

ClientSecret -> (строка)

Описывает client_secret, который можно получить от поставщиков сторонних социальных федераций.

SignInWithApple -> (структура)

Описывает конфигурации Apple социальной федерации для разрешения пользователям приложения входа с использованием OAuth.

ClientId -> (строка)

Описывает client_id (также называемый идентификатором службы), который поступает от Apple.

KeyId -> (строка)

Описывает key_id, который поступает от Apple.

PrivateKey -> (строка)

Описывает private_key, который поступает от Apple.

TeamId -> (строка)

Описывает team_id, который поступает от Apple.

PasswordPolicy -> (структура)

Описывает политику паролей для вашего пула пользователей Amazon Cognito, настроенного в вашем проекте Amplify.

AdditionalConstraints -> (список)

Описывает дополнительные ограничения требований к паролям для входа в ресурс аутентификации, настроенный в вашем проекте Amplify.

(строка)

MinimumLength -> (двойное)

Описывает минимальную длину пароля, необходимую для входа в ресурс аутентификации, настроенный в вашем проекте Amplify.

VerificationMessage -> (структура)

Описывает сообщение электронной почты или SMS для проверки для вашего пула пользователей Amazon Cognito, настроенного в вашем проекте Amplify.

DeliveryMethod -> (строка)

Тип сообщения проверки, которое нужно отправить.

EmailSettings -> (структура)

Настройки сообщения электронной почты.

EmailMessage -> (строка)

Содержание сообщения электронной почты.

EmailSubject -> (строка)

Содержание строки темы сообщения электронной почты.

SmsSettings -> (структура)

Настройки SMS-сообщения.

SmsMessage -> (строка)

Содержание SMS-сообщения.

Синтаксис JSON:

{
  "AuthResources": "USER_POOL_ONLY"|"IDENTITY_POOL_AND_USER_POOL",
  "IdentityPoolConfigs": {
    "UnauthenticatedLogin": true|false
  },
  "Service": "COGNITO",
  "UserPoolConfigs": {
    "ForgotPassword": {
      "DeliveryMethod": "EMAIL"|"SMS",
      "EmailSettings": {
        "EmailMessage": "string",
        "EmailSubject": "string"
      },
      "SmsSettings": {
        "SmsMessage": "string"
      }
    },
    "Mfa": {
      "MFAMode": "ON"|"OFF"|"OPTIONAL",
      "Settings": {
        "MfaTypes": ["SMS"|"TOTP", ...],
        "SmsMessage": "string"
      }
    },
    "OAuth": {
      "DomainPrefix": "string",
      "OAuthGrantType": "CODE"|"IMPLICIT",
      "OAuthScopes": ["PHONE"|"EMAIL"|"OPENID"|"PROFILE"|"AWS_COGNITO_SIGNIN_USER_ADMIN", ...],
      "RedirectSignInURIs": ["string", ...],
      "RedirectSignOutURIs": ["string", ...],
      "SocialProviderSettings": {
        "Facebook": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "Google": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "LoginWithAmazon": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "SignInWithApple": {
          "ClientId": "string",
          "KeyId": "string",
          "PrivateKey": "string",
          "TeamId": "string"
        }
      }
    },
    "PasswordPolicy": {
      "AdditionalConstraints": ["REQUIRE_DIGIT"|"REQUIRE_LOWERCASE"|"REQUIRE_SYMBOL"|"REQUIRE_UPPERCASE", ...],
      "MinimumLength": double
    },
    "VerificationMessage": {
      "DeliveryMethod": "EMAIL"|"SMS",
      "EmailSettings": {
        "EmailMessage": "string",
        "EmailSubject": "string"
      },
      "SmsSettings": {
        "SmsMessage": "string"
      }
    }
  }
}

--resource-name (строка)

Название этого ресурса.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

AppId -> (строка)

Идентификатор приложения.

BackendEnvironmentName -> (строка)

Название среды выполнения бэкэнда.

Ошибка -> (строка)

Если запрос не удается, возвращается эта ошибка.

JobId -> (строка)

Идентификатор задачи.

Операция -> (строка)

Название операции.

Статус -> (строка)

Текущий статус запроса.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API