Spec-Zone.ru › AWS CLI v2

[ aws . eks ]

describe-identity-provider-config

Описание

Описывает конфигурацию поставщика идентификации.

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

Синтаксис

  describe-identity-provider-config
--cluster-name <value>
--identity-provider-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]

Параметры

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

Имя вашего кластера.

--identity-provider-config (структура)

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

type -> (строка)

Тип конфигурации поставщика идентификации. Доступен только тип oidc .

name -> (строка)

Имя конфигурации поставщика идентификации.

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

type=string,name=string

Синтаксис JSON:

{
  "type": "string",
  "name": "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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Описание конфигурации поставщика идентификации, связанной с вашим кластером Amazon EKS

Следующий describe-identity-provider-config пример описывает конфигурацию поставщика идентификации, связанную с вашим кластером Amazon EKS.

aws eks describe-identity-provider-config \
    --cluster-name my-eks-cluster \
    --identity-provider-config type=oidc,name=my-identity-provider

Вывод:

{
    "identityProviderConfig": {
        "oidc": {
            "identityProviderConfigName": "my-identity-provider",
            "identityProviderConfigArn": "arn:aws:eks:us-east-2:111122223333:identityproviderconfig/my-eks-cluster/oidc/my-identity-provider/8ac76722-78e4-cec1-ed76-d49eea058622",
            "clusterName": "my-eks-cluster",
            "issuerUrl": "https://oidc.eks.us-east-2.amazonaws.com/id/38D6A4619A0A69E342B113ED7F1A7652",
            "clientId": "kubernetes",
            "usernameClaim": "email",
            "usernamePrefix": "my-username-prefix",
            "groupsClaim": "my-claim",
            "groupsPrefix": "my-groups-prefix",
            "requiredClaims": {
                "Claim1": "value1",
                "Claim2": "value2"
            },
            "tags": {
                "env": "dev"
            },
            "status": "ACTIVE"
        }
    }
}

Для получения дополнительной информации см. раздел «Авторизация пользователей для вашего кластера из поставщика идентификации OpenID Connect» в руководстве пользователя Amazon EKS.

Вывод

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

Объект, представляющий конфигурацию поставщика OpenID Connect (OIDC) идентификации.

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

Объект, представляющий конфигурацию поставщика OpenID Connect (OIDC) идентификации.

identityProviderConfigName -> (строка)

Имя конфигурации.

identityProviderConfigArn -> (строка)

ARN конфигурации.

clusterName -> (строка)

Имя вашего кластера.

issuerUrl -> (строка)

URL поставщика идентификации OIDC, который позволяет API-серверу обнаруживать открытые ключи подписи для проверки токенов.

clientId -> (строка)

Это также известно как адресат. Идентификатор клиентского приложения, которое выполняет запросы аутентификации к поставщику идентификации OIDC.

usernameClaim -> (строка)

Требование JSON Web Token (JWT), используемое в качестве имени пользователя.

usernamePrefix -> (строка)

Префикс, добавляемый к требованиям имени пользователя для предотвращения конфликтов с существующими именами. Префикс не может содержать system:

groupsClaim -> (строка)

Требование JSON web token (JWT), которое используется поставщиком для возврата ваших групп.

groupsPrefix -> (строка)

Префикс, добавляемый к требованиям группы для предотвращения конфликтов с существующими именами (такими как system: группы). Например, значение``oidc:`` создает имена групп, такие как oidc:engineering и oidc:infra . Префикс не может содержать system:

requiredClaims -> (карта)

Пары «ключ-значение», описывающие обязательные требования в токене идентификации. Если установлено, каждое требование проверяется на наличие в токене с соответствующим значением.

key -> (строка)

value -> (строка)

tags -> (карта)

Метаданные, помогающие в классификации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете оба. Теги не распространяются на другие кластеры или ресурсы Amazon Web Services.

key -> (строка)

Одна часть пары «ключ-значение», составляющей тег. Ключ - это общая метка, которая действует как категория для более конкретных значений тега.

value -> (строка)

Необязательная часть пары «ключ-значение», составляющей тег. Значение выступает в качестве описателя в категории тегов (ключ).

status -> (строка)

Статус поставщика OIDC идентификации.

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

Spec-Zone.ru

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