Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

create-replicator

Описание

Создаёт репликатор.

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

Синтаксис

  create-replicator
[--description <value>]
--kafka-clusters <value>
--replication-info-list <value>
--replicator-name <value>
--service-execution-role-arn <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]

Параметры

--description (строка)

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

--kafka-clusters (список)

Кластеры Kafka, используемые для настройки источников/целей репликации.

(структура)

Информация о кластере Kafka, используемом в качестве источника/цели репликации.

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

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

MskClusterArn -> (строка)

Amazon Resource Name (ARN) кластера Amazon MSK.

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

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

SecurityGroupIds -> (список)

Список групп безопасности, которые необходимо прикрепить к сетевым интерфейсам (ENI) узлов брокера.

(строка)

SubnetIds -> (список)

Список подсетей в клиентском VPC для подключения.

(строка)

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

AmazonMskCluster={MskClusterArn=string},VpcConfig={SecurityGroupIds=[string,string],SubnetIds=[string,string]} ...

Синтаксис JSON:

[
  {
    "AmazonMskCluster": {
      "MskClusterArn": "string"
    },
    "VpcConfig": {
      "SecurityGroupIds": ["string", ...],
      "SubnetIds": ["string", ...]
    }
  }
  ...
]

--replication-info-list (список)

Список конфигураций репликации, где каждая конфигурация нацелена на репликацию потока данных между заданным исходным кластером и целевым кластером.

(структура)

Указывает конфигурацию репликации между исходным и целевым кластерами Kafka.

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

Конфигурация, относящаяся к репликации групп потребителей.

ConsumerGroupsToExclude -> (список)

Список регулярных выражений, указывающих группы потребителей, которые не должны быть реплицированы.

(строка)

ConsumerGroupsToReplicate -> (список)

Список регулярных выражений, указывающих группы потребителей, которые должны быть скопированы.

(строка)

DetectAndCopyNewConsumerGroups -> (логическое значение)

Включает синхронизацию групп потребителей с целевым кластером.

SynchroniseConsumerGroupOffsets -> (логическое значение)

Включает синхронизацию смещений групп потребителей с целевым кластером. Реплицированные смещения записываются в тему __consumer_offsets.

SourceKafkaClusterArn -> (строка)

ARN исходного кластера Kafka.

TargetCompressionType -> (строка)

Тип сжатия, используемый при создании записей в целевом кластере.

TargetKafkaClusterArn -> (строка)

ARN целевого кластера Kafka.

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

Конфигурация, относящаяся к репликации тем.

CopyAccessControlListsForTopics -> (логическое значение)

Следует ли периодически настраивать разрешения доступа к удалённым темам для соответствия соответствующим темам в upstream.

CopyTopicConfigurations -> (логическое значение)

Следует ли периодически настраивать удалённые темы для соответствия соответствующим темам в upstream.

DetectAndCopyNewTopics -> (логическое значение)

Следует ли периодически проверять наличие новых тем и партиций.

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

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

Type -> (строка)

Тип начальной позиции репликации.

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

Конфигурация для указания того, должны ли имена реплицированных тем совпадать с соответствующими темами upstream или иметь префикс с алиасом исходного кластера.

Type -> (строка)

Тип имени реплицированной темы.

TopicsToExclude -> (список)

Список регулярных выражений, указывающих темы, которые не должны быть реплицированы.

(строка)

TopicsToReplicate -> (список)

Список регулярных выражений, указывающих темы, которые должны быть скопированы.

(строка)

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

ConsumerGroupReplication={ConsumerGroupsToExclude=[string,string],ConsumerGroupsToReplicate=[string,string],DetectAndCopyNewConsumerGroups=boolean,SynchroniseConsumerGroupOffsets=boolean},SourceKafkaClusterArn=string,TargetCompressionType=string,TargetKafkaClusterArn=string,TopicReplication={CopyAccessControlListsForTopics=boolean,CopyTopicConfigurations=boolean,DetectAndCopyNewTopics=boolean,StartingPosition={Type=string},TopicNameConfiguration={Type=string},TopicsToExclude=[string,string],TopicsToReplicate=[string,string]} ...

Синтаксис JSON:

[
  {
    "ConsumerGroupReplication": {
      "ConsumerGroupsToExclude": ["string", ...],
      "ConsumerGroupsToReplicate": ["string", ...],
      "DetectAndCopyNewConsumerGroups": true|false,
      "SynchroniseConsumerGroupOffsets": true|false
    },
    "SourceKafkaClusterArn": "string",
    "TargetCompressionType": "NONE"|"GZIP"|"SNAPPY"|"LZ4"|"ZSTD",
    "TargetKafkaClusterArn": "string",
    "TopicReplication": {
      "CopyAccessControlListsForTopics": true|false,
      "CopyTopicConfigurations": true|false,
      "DetectAndCopyNewTopics": true|false,
      "StartingPosition": {
        "Type": "LATEST"|"EARLIEST"
      },
      "TopicNameConfiguration": {
        "Type": "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS"|"IDENTICAL"
      },
      "TopicsToExclude": ["string", ...],
      "TopicsToReplicate": ["string", ...]
    }
  }
  ...
]

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

Имя репликатора. Допускаются буквенно-цифровые символы с ‘-’.

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

ARN роли IAM, используемой репликатором для доступа к ресурсам в аккаунте клиента (например, исходные и целевые кластеры).

--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 (логическое значение)

Включить отладку логирования.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

ReplicatorArn -> (строка)

Amazon Resource Name (ARN) репликатора.

ReplicatorName -> (строка)

Имя репликатора, предоставленное клиентом.

ReplicatorState -> (строка)

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

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

Spec-Zone.ru

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