Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

установить-роли-пула-идентификаторов

Описание

Устанавливает роли для пула идентификаторов. Эти роли используются при выполнении вызовов действия GetCredentialsForIdentity.

Для вызова этой операции необходимо использовать учетные данные разработчика Amazon Web Services.

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

Синтаксис

  set-identity-pool-roles
--identity-pool-id <value>
--roles <value>
[--role-mappings <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]

Параметры

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

Идентификатор пула идентификаторов в формате REGION:GUID.

--roles (словарь)

Словарь ролей, связанных с этим пулом. Для каждой роли ключ будет либо «authenticated», либо «unauthenticated», а значением будет ARN роли.

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--role-mappings (словарь)

Способ сопоставления пользователей определённого поставщика идентификации с ролями. Это словарь из строки (идентификатор поставщика идентификации, например, graph.facebook.com или cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id ) и объекта RoleMapping.

Можно указать до 25 правил на поставщик идентификации.

ключ -> (строка)

значение -> (структура)

Сопоставление ролей.

Тип -> (строка)

Тип сопоставления ролей. Token будет использовать утверждения cognito:roles и cognito:preferred_role из токена поставщика Cognito для сопоставления групп с ролями. Правила будут пытаться сопоставить утверждения из токена с ролью.

Разрешение_неоднозначных_ролей -> (строка)

Если вы указали Token или Правила как тип сопоставления ролей, необходимо указать AmbiguousRoleResolution.

Указывает действие, которое должно быть выполнено, если ни одно правило не соответствует значению утверждения для типа Rules, или нет утверждения cognito:preferred_role, и есть несколько совпадений cognito:roles для типа Token.

Настройка_правил -> (структура)

Правила для сопоставления пользователей с ролями.

Если вы указали Правила как тип сопоставления ролей, необходимо указать RulesConfiguration.

Правила -> (список)

Массив правил. Можно указать до 25 правил на поставщик идентификации.

Правила оцениваются в порядке следования. Первое совпавшее правило определяет роль.

(структура)

Правило, сопоставляющее имя утверждения, значение утверждения и тип сопоставления с ARN роли.

Утверждение -> (строка)

Имя утверждения, которое должно присутствовать в токе, например, «isAdmin» или «paid».

Тип_сопоставления -> (строка)

Условие сопоставления, которое определяет, насколько точно значение утверждения в токе IdP должно соответствовать Value.

Значение -> (строка)

Короткий строковый идентификатор, которому должно соответствовать утверждение, например, «paid» или «yes».

RoleARN -> (строка)

ARN роли.

Синтаксис JSON:

{"string": {
      "Type": "Token"|"Rules",
      "AmbiguousRoleResolution": "AuthenticatedRole"|"Deny",
      "RulesConfiguration": {
        "Rules": [
          {
            "Claim": "string",
            "MatchType": "Equals"|"Contains"|"StartsWith"|"NotEqual",
            "Value": "string",
            "RoleARN": "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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Установить роли пула идентификаторов

Следующий set-identity-pool-roles пример устанавливает роль пула идентификаторов.

aws cognito-identity set-identity-pool-roles \
    --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \
    --roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role"

Вывод

Нет

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

Spec-Zone.ru

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