Spec-Zone.ru › AWS CLI v2

[ aws . kafkaconnect ]

create-connector

Описание

Создает коннектор с указанными свойствами.

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

Синтаксис

  create-connector
--capacity <value>
--connector-configuration <value>
[--connector-description <value>]
--connector-name <value>
--kafka-cluster <value>
--kafka-cluster-client-authentication <value>
--kafka-cluster-encryption-in-transit <value>
--kafka-connect-version <value>
[--log-delivery <value>]
--plugins <value>
--service-execution-role-arn <value>
[--worker-configuration <value>]
[--tags <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]

Параметры

--capacity (структура)

Информация о выделенной емкости коннектора. Должна быть указана ровно одна из двух свойств.

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

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

maxWorkerCount -> (целое число)

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

mcuCount -> (целое число)

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

minWorkerCount -> (целое число)

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

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

Политика уменьшения масштаба коннектора.

cpuUtilizationPercentage -> (целое число)

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

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

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

cpuUtilizationPercentage -> (целое число)

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

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

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

mcuCount -> (целое число)

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

workerCount -> (целое число)

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

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

autoScaling={maxWorkerCount=integer,mcuCount=integer,minWorkerCount=integer,scaleInPolicy={cpuUtilizationPercentage=integer},scaleOutPolicy={cpuUtilizationPercentage=integer}},provisionedCapacity={mcuCount=integer,workerCount=integer}

Синтаксис JSON:

{
  "autoScaling": {
    "maxWorkerCount": integer,
    "mcuCount": integer,
    "minWorkerCount": integer,
    "scaleInPolicy": {
      "cpuUtilizationPercentage": integer
    },
    "scaleOutPolicy": {
      "cpuUtilizationPercentage": integer
    }
  },
  "provisionedCapacity": {
    "mcuCount": integer,
    "workerCount": integer
  }
}

--connector-configuration (массив)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

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

Имя коннектора.

--kafka-cluster (структура)

Указывает, к какому кластеру Apache Kafka подключиться.

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

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

bootstrapServers -> (строка)

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

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

Подробная информация о виртуальной частной сети Amazon VPC, которая обеспечивает сетевую связь с кластером Apache Kafka.

securityGroups -> (список)

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

(строка)

subnets -> (список)

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

(строка)

Синтаксис JSON:

{
  "apacheKafkaCluster": {
    "bootstrapServers": "string",
    "vpc": {
      "securityGroups": ["string", ...],
      "subnets": ["string", ...]
    }
  }
}

--kafka-cluster-client-authentication (структура)

Подробная информация об аутентификации клиента, используемой кластером Apache Kafka.

authenticationType -> (строка)

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

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

authenticationType=string

Синтаксис JSON:

{
  "authenticationType": "NONE"|"IAM"
}

--kafka-cluster-encryption-in-transit (структура)

Подробная информация об шифровании в процессе передачи данных в кластер Apache Kafka.

encryptionType -> (строка)

Тип шифрования в процессе передачи данных в кластер Apache Kafka.

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

encryptionType=string

Синтаксис JSON:

{
  "encryptionType": "PLAINTEXT"|"TLS"
}

--kafka-connect-version (строка)

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

--log-delivery (структура)

Подробная информация о доставке логов.

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

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

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

Подробная информация о доставке логов в Amazon CloudWatch Logs.

enabled -> (булево)

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

logGroup -> (строка)

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

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

Подробная информация о доставке логов в Amazon Kinesis Data Firehose.

deliveryStream -> (строка)

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

enabled -> (булево)

Включено ли отправление логов коннектора в Amazon Kinesis Data Firehose.

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

Подробная информация о доставке логов в Amazon S3.

bucket -> (строка)

Имя ведра S3, являющегося целевой системой для доставки логов.

enabled -> (булево)

Включено ли отправление логов коннектора в указанную целевую систему Amazon S3.

prefix -> (строка)

Префикс S3, являющийся целевой системой для доставки логов.

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

workerLogDelivery={cloudWatchLogs={enabled=boolean,logGroup=string},firehose={deliveryStream=string,enabled=boolean},s3={bucket=string,enabled=boolean,prefix=string}}

Синтаксис JSON:

{
  "workerLogDelivery": {
    "cloudWatchLogs": {
      "enabled": true|false,
      "logGroup": "string"
    },
    "firehose": {
      "deliveryStream": "string",
      "enabled": true|false
    },
    "s3": {
      "bucket": "string",
      "enabled": true|false,
      "prefix": "string"
    }
  }
}

--plugins (список)

Предупреждение

Amazon MSK Connect в настоящее время не поддерживает указание нескольких плагинов в виде списка. Для использования нескольких плагинов для своего коннектора можно создать один пользовательский плагин с помощью файла ZIP, объединяющего несколько плагинов вместе.

Указывает плагин, который необходимо использовать для коннектора. Необходимо указать список с одним элементом, содержащим один customPlugin объект.

(структура)

Плагин — это ресурс Amazon Web Services, содержащий код, определяющий логику вашего коннектора.

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

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

customPluginArn -> (строка)

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

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

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

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

customPlugin={customPluginArn=string,revision=long} ...

Синтаксис JSON:

[
  {
    "customPlugin": {
      "customPluginArn": "string",
      "revision": long
    }
  }
  ...
]

--service-execution-role-arn (строка)

Amazon Resource Name (ARN) роли IAM, используемой коннектором для доступа к необходимым ресурсам Amazon Web Services. Тип ресурсов зависит от логики коннектора. Например, коннектор, использующий Amazon S3 в качестве целевой системы, должен иметь разрешения, позволяющие ему записывать в ведро S3.

--worker-configuration (структура)

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

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

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

workerConfigurationArn -> (строка)

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

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

revision=long,workerConfigurationArn=string

Синтаксис JSON:

{
  "revision": long,
  "workerConfigurationArn": "string"
}

--tags (массив)

Теги, которые необходимо добавить к коннектору.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

connectorArn -> (строка)

Amazon Resource Name (ARN), назначенный Amazon соединителю.

connectorName -> (строка)

Название соединителя.

connectorState -> (строка)

Состояние соединителя.

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

Spec-Zone.ru

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