describe-cluster-v2
Описание
Возвращает описание кластера MSK, ARN которого указан в запросе.
См. также: Документацию API AWS
Синтаксис
describe-cluster-v2
--cluster-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]
Параметры
--cluster-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
- text
- таблица
- 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.
Вывод
ClusterInfo -> (структура)
Информация о кластере.
ActiveOperationArn -> (строка)
ClusterType -> (строка)
ClusterArn -> (строка)
ClusterName -> (строка)
CreationTime -> (метка времени)
CurrentVersion -> (строка)
State -> (строка)
StateInfo -> (структура)
Информация о состоянии кластера Amazon MSK.
Code -> (строка)
Message -> (строка)
Tags -> (карта)
Теги, присоединённые к кластеру.
key -> (строка)
value -> (строка)
Provisioned -> (структура)
Информация о выделенном кластере.
BrokerNodeGroupInfo -> (структура)
Информация о брокерах.
BrokerAZDistribution -> (строка)
Распределение узлов брокера по зонам доступности. Этот параметр является необязательным. Если вы его не укажете, Amazon MSK присвоит ему значение DEFAULT. Вы также можете явно установить этот параметр в значение DEFAULT. Другие значения в настоящее время недопустимы.
Amazon MSK равномерно распределяет узлы брокера по зонам доступности, соответствующим подсетям, которые вы предоставляете при создании кластера.
ClientSubnets -> (список)
Список подсетей для подключения в виртуальной частной сети (VPC) клиента. AWS создаёт интерфейсы эластичных сетей внутри этих подсетей. Приложения клиентов используют интерфейсы эластичных сетей для создания и потребления данных. Подсети клиентов не могут находиться в зоне доступности с ID use1-az3.
(строка)
InstanceType -> (строка)
SecurityGroups -> (список)
AWS группы безопасности для ассоциации с интерфейсами эластичных сетей, чтобы указать, кто может подключаться и взаимодействовать с кластером Amazon MSK. Если вы не укажете группу безопасности, Amazon MSK использует группу безопасности по умолчанию, связанную с VPC.
(строка)
StorageInfo -> (структура)
Содержит информацию о томах хранения, подключённых к узлам брокера MSK.
EbsStorageInfo -> (структура)
Информация о томах EBS.
ProvisionedThroughput -> (структура)
Информация о пропускной способности выделенного тома EBS.
Enabled -> (булево)
VolumeThroughput -> (целое число)
VolumeSize -> (целое число)
ConnectivityInfo -> (структура)
Информация о конфигурации доступа к брокерам.
PublicAccess -> (структура)
Контроль доступа к общедоступным брокерам.
Type -> (строка)
VpcConnectivity -> (структура)
Контроль доступа к VPC-соединению для брокеров.
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов для VPC-соединения.
Sasl -> (структура)
Подробная информация о типе аутентификации SASL для VPC-соединения.
Scram -> (структура)
Подробности для аутентификации клиента SASL/SCRAM для VPC-соединения.
Enabled -> (булево)
Iam -> (структура)
Подробности для аутентификации клиента SASL/IAM для VPC-соединения.
Enabled -> (булево)
Tls -> (структура)
Подробная информация о типе аутентификации TLS для VPC-соединения.
Enabled -> (булево)
ZoneIds -> (список)
Список zoneIds для кластера в виртуальной частной сети (VPC).
(строка)
CurrentBrokerSoftwareInfo -> (структура)
Информация о версии Apache Kafka, развернутой на брокерах.
ConfigurationArn -> (строка)
ConfigurationRevision -> (целое число с длинной плавающей запятой)
KafkaVersion -> (строка)
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов.
Sasl -> (структура)
Подробная информация об аутентификации клиента SASL.
Scram -> (структура)
Подробная информация об аутентификации клиента SASL/SCRAM.
Enabled -> (булево)
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (булево)
Tls -> (структура)
Подробности для ClientAuthentication с использованием TLS.
CertificateAuthorityArnList -> (список)
Список идентификаторов ACM Certificate Authority ARN.
(строка)
Enabled -> (булево)
Unauthenticated -> (структура)
Содержит информацию о неаутентифицированном трафике в кластер.
Enabled -> (булево)
EncryptionInfo -> (структура)
Включает всю информацию, связанную с шифрованием.
EncryptionAtRest -> (структура)
Подробности шифрования данных в хранилище.
DataVolumeKMSKeyId -> (строка)
EncryptionInTransit -> (структура)
Подробности для шифрования в процессе передачи.
ClientBroker -> (строка)
Указывает настройку шифрования для передачи данных между клиентами и брокерами. Возможные значения:
TLS означает, что общение клиент-брокер включено только с TLS.
TLS_PLAINTEXT означает, что общение клиент-брокер включено для зашифрованных данными TLS и данных в открытом виде.
PLAINTEXT означает, что общение клиент-брокер включено только в открытом виде.
Значение по умолчанию — TLS_PLAINTEXT.
InCluster -> (булево)
При установке в значение true, это указывает, что общение между узлами брокера кластера зашифровано. При установке в значение false, общение происходит в открытом виде.
Значение по умолчанию — true.
EnhancedMonitoring -> (строка)
OpenMonitoring -> (структура)
Настройки для открытого мониторинга.
Prometheus -> (структура)
Настройки Prometheus.
JmxExporter -> (структура)
Указывает, хотите ли вы включить или отключить JMX Exporter.
EnabledInBroker -> (булево)
NodeExporter -> (структура)
Указывает, хотите ли вы включить или отключить Node Exporter.
EnabledInBroker -> (булево)
LoggingInfo -> (структура)
Информация о доставке логов для кластера.
BrokerLogs -> (структура)
CloudWatchLogs -> (структура)
Enabled -> (булево)
LogGroup -> (строка)
Firehose -> (структура)
DeliveryStream -> (строка)
Enabled -> (булево)
S3 -> (структура)
Bucket -> (строка)
Enabled -> (булево)
Prefix -> (строка)
NumberOfBrokerNodes -> (целое число)
ZookeeperConnectString -> (строка)
ZookeeperConnectStringTls -> (строка)
StorageMode -> (строка)
CustomerActionStatus -> (строка)
Serverless -> (структура)
Информация о серверлес кластере.
VpcConfigs -> (список)
Конфигурация Amazon VPC для кластера.
(структура)
Конфигурация Amazon VPC для кластера.
SubnetIds -> (список)
Идентификаторы подсетей, связанных с кластером.
(строка)
SecurityGroupIds -> (список)
Идентификаторы групп безопасности, связанных с кластером.
(строка)
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов.
Sasl -> (структура)
Подробная информация об аутентификации клиента SASL.
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (булево)
© Copyright 2025, Amazon Web Services. Created using Sphinx.