Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

describe-replicator

Описание

Описывает репликатор.

См. также: AWS API Documentation

Синтаксис

  describe-replicator
--replicator-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]

Параметры

--replicator-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. Если предоставлено значение null или строка 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

CreationTime -> (отметка времени)

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

CurrentVersion -> (строка)

Текущий номер версии репликатора.

IsReplicatorReference -> (булево)

Является ли этот ресурс ссылкой на репликатор.

KafkaClusters -> (список)

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

(структура)

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

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

Детали Amazon MSK-кластера.

MskClusterArn -> (строка)

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

KafkaClusterAlias -> (строка)

Псевдоним Kafka-кластера. Используется для добавления префикса к именам реплицированных тем.

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

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

SecurityGroupIds -> (список)

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

(строка)

SubnetIds -> (список)

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

(строка)

ReplicationInfoList -> (список)

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

(структура)

Указывает конфигурацию для репликации между исходным и целевым кластером Kafka (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

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

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

ConsumerGroupsToExclude -> (список)

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

(строка)

ConsumerGroupsToReplicate -> (список)

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

(строка)

DetectAndCopyNewConsumerGroups -> (булево)

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

SynchroniseConsumerGroupOffsets -> (булево)

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

SourceKafkaClusterAlias -> (строка)

Псевдоним исходного Kafka-кластера.

TargetCompressionType -> (строка)

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

TargetKafkaClusterAlias -> (строка)

Псевдоним целевого Kafka-кластера.

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

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

CopyAccessControlListsForTopics -> (булево)

Выполнять ли периодически настройку ACL удаленных тем для соответствия соответствующим темам upstream.

CopyTopicConfigurations -> (булево)

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

DetectAndCopyNewTopics -> (булево)

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

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

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

Type -> (строка)

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

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

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

Type -> (строка)

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

TopicsToExclude -> (список)

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

(строка)

TopicsToReplicate -> (список)

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

(строка)

ReplicatorArn -> (строка)

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

ReplicatorDescription -> (строка)

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

ReplicatorName -> (строка)

Имя репликатора.

ReplicatorResourceArn -> (строка)

Amazon Resource Name (ARN) ресурса репликатора в регионе, где был создан репликатор.

ReplicatorState -> (строка)

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

ServiceExecutionRoleArn -> (строка)

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

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

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

Code -> (строка)

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

Message -> (строка)

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

Tags -> (массив)

Список тегов, прикрепленных к репликатору.

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

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

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

Spec-Zone.ru

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