set-security-token-service-preferences

Описание

Устанавливает указанную версию глобального токена конечной точки в качестве версии токена, используемой для учетной записи Amazon Web Services.

По умолчанию служба Security Token Service (STS) доступна как глобальная служба, и все запросы STS отправляются на один конечный пункт в https://sts.amazonaws.com . Amazon Web Services рекомендует использовать региональные конечные точки STS для снижения задержки, построения избыточности и повышения доступности токенов сессий. Дополнительную информацию о региональных конечных точках для STS см. в разделе «Конечные точки и квоты службы Security Token Service» в справочном руководстве Amazon Web Services General Reference.

Если вы отправляете вызов STS на глобальную конечную точку, полученные токены сессий могут быть действительны в некоторых регионах, но не в других. Это зависит от версии, которая установлена в этой операции. Токены версии 1 действительны только в регионах Amazon Web Services, которые доступны по умолчанию. Эти токены не работают в вручную включенных регионах, таких как Asia Pacific (Hong Kong). Токены версии 2 действительны во всех регионах. Однако токены версии 2 длиннее и могут повлиять на системы, где вы временно храните токены. Дополнительную информацию см. в разделе «Активация и деактивация STS в регионе Amazon Web Services» в руководстве пользователя IAM.

Чтобы просмотреть текущую версию токена сессии, см. запись GlobalEndpointTokenVersion в ответе операции GetAccountSummary.

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

Синтаксис

  set-security-token-service-preferences
--global-endpoint-token-version <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]

Параметры

--global-endpoint-token-version (строка)

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

Примеры

Для установки версии глобального токена конечной точки

Следующий set-security-token-service-preferences пример настраивает Amazon STS для использования токенов версии 2 при аутентификации на глобальной конечной точке.

aws iam set-security-token-service-preferences \
    --global-endpoint-token-version v2Token

Эта команда не выводит ничего.

Дополнительную информацию см. в разделе «Управление AWS STS в регионе AWS» в руководстве пользователя AWS IAM.

Вывод

Нет