Spec-Zone.ru › AWS CLI v2

[ aws . kafkaconnect ]

описание-коннектора

Описание

Возвращает сводную информацию о коннекторе.

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

Синтаксис

  describe-connector
--connector-arn <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]

Параметры

--connector-arn (строка)

Amazon Resource Name (ARN) коннектора, который вы хотите описать.

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

Вывод

емкость -> (структура)

Информация о емкости коннектора, является ли он масштабируемым автоматически или выделенным.

автомасштабирование -> (структура)

Описание емкости автомасштабирования коннектора.

максРаботников -> (целое число)

Максимальное количество работников, выделенных коннектору.

количествоMCU -> (целое число)

Количество микроконтроллеров (MCU) выделенных каждому работнику коннектора. Допустимые значения: 1, 2, 4, 8.

минРаботников -> (целое число)

Минимальное количество работников, выделенных коннектору.

политикаМасштабированияВниз -> (структура)

Политика масштабирования вниз для коннектора.

процентИспользованияЦП -> (целое число)

Указывает порог процента использования ЦП, при котором происходит автоматическое масштабирование коннектора вниз.

политикаМасштабированияВверх -> (структура)

Политика масштабирования вверх для коннектора.

процентИспользованияЦП -> (целое число)

Порог процента использования ЦП, при котором происходит автоматическое масштабирование коннектора вверх.

выделеннаяЕмкость -> (структура)

Описание выделенной емкости коннектора.

количествоMCU -> (целое число)

Количество микроконтроллеров (MCU) выделенных каждому работнику коннектора. Допустимые значения: 1, 2, 4, 8.

количествоРаботников -> (целое число)

Количество работников, выделенных коннектору.

connectorArn -> (строка)

Amazon Resource Name (ARN) коннектора.

connectorConfiguration -> (карта)

Карта ключей и значений, представляющих конфигурацию коннектора.

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

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

connectorDescription -> (строка)

Краткое описание коннектора.

connectorName -> (строка)

Название коннектора.

connectorState -> (строка)

Состояние коннектора.

creationTime -> (временная метка)

Время создания коннектора.

currentVersion -> (строка)

Текущая версия коннектора.

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

Apache Kafka кластер, к которому подключен коннектор.

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

Apache Kafka кластер, к которому подключен коннектор.

bootstrapServers -> (строка)

Bootstrap серверы кластера.

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

Детали Amazon VPC, имеющей сетевое соединение с Apache Kafka кластером.

securityGroups -> (список)

Группы безопасности коннектора.

(строка)

subnets -> (список)

Подсети коннектора.

(строка)

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

Тип проверки подлинности клиента, используемого для подключения к Apache Kafka кластеру. Значение NONE, когда проверка подлинности клиента не используется.

authenticationType -> (строка)

Тип проверки подлинности клиента, используемого для подключения к Apache Kafka кластеру. Значение NONE означает, что проверка подлинности клиента не используется.

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

Детали шифрования в пути к Apache Kafka кластеру.

encryptionType -> (строка)

Тип шифрования в пути к Apache Kafka кластеру.

kafkaConnectVersion -> (строка)

Версия Kafka Connect. Она должна быть совместима с версией Apache Kafka кластера и плагинами.

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

Подробности о передаче логов в Amazon CloudWatch Logs.

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

Рабочие процессы могут отправлять журналы рабочих процессов в различные типы пунктов назначения. Эта конфигурация определяет подробности этих пунктов назначения.

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

Подробности о передаче логов в Amazon CloudWatch Logs.

enabled -> (булево)

Включена ли передача логов в Amazon CloudWatch Logs.

logGroup -> (строка)

Имя группы логов CloudWatch, являющееся пунктом назначения для передачи логов.

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

Подробности о передаче логов в Amazon Kinesis Data Firehose.

deliveryStream -> (строка)

Название потока доставки Kinesis Data Firehose, являющегося пунктом назначения для передачи логов.

enabled -> (булево)

Определяет, отправляются ли журналы коннектора в Amazon Kinesis Data Firehose.

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

Подробности о передаче логов в Amazon S3.

bucket -> (строка)

Имя корзины S3, являющееся пунктом назначения для передачи логов.

enabled -> (булево)

Указывает, отправляются ли журналы коннектора в указанное место назначения Amazon S3.

prefix -> (строка)

Префикс S3, являющийся пунктом назначения для передачи логов.

plugins -> (список)

Указывает, какие плагины использовались для этого коннектора.

(структура)

Описание плагина.

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

Подробности о пользовательском плагине.

customPluginArn -> (строка)

Amazon Resource Name (ARN) пользовательского плагина.

revision -> (длинное целое число)

Ревизия пользовательского плагина.

serviceExecutionRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, используемой коннектором для доступа к ресурсам Amazon Web Services.

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

Указывает, какая конфигурация рабочего процесса использовалась для коннектора.

revision -> (длинное целое число)

Ревизия конфигурации рабочего процесса.

workerConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации рабочего процесса.

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

Подробности о состоянии коннектора.

code -> (строка)

Код, описывающий состояние ресурса.

message -> (строка)

Сообщение, описывающее состояние ресурса.

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

Spec-Zone.ru

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