Spec-Zone.ru › AWS CLI v2

[ aws . mq ]

describe-broker

Описание

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

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

Синтаксис

  describe-broker
--broker-id <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]

Параметры

--broker-id (строка)

Уникальный идентификатор, сгенерированный Amazon MQ для брокера.

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

Вывод

ActionsRequired -> (список)

Необходимые действия для брокера.

(структура)

Необходимое действие для брокера.

ActionRequiredCode -> (строка)

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

ActionRequiredInfo -> (строка)

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

AuthenticationStrategy -> (строка)

Используемая стратегия аутентификации для защиты брокера. По умолчанию — SIMPLE.

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

Включает автоматическое обновление до новых версий патчей для брокеров по мере выпуска новых версий и поддержки Amazon MQ. Автоматическое обновление происходит во время запланированного окна обслуживания или после перезапуска брокера вручную.

BrokerArn -> (строка)

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

BrokerId -> (строка)

Уникальный идентификатор, сгенерированный Amazon MQ для брокера.

BrokerInstances -> (список)

Список информации об выделенных брокерах.

(структура)

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

ConsoleURL -> (строка)

URL веб-консоли брокера.

Endpoints -> (список)

Точки подключения протокола брокера на уровне сети.

(строка)

IpAddress -> (строка)

IP-адрес Elastic Network Interface (ENI), подключенной к брокеру. Не применимо к брокерам RabbitMQ.

BrokerName -> (строка)

Имя брокера. Это значение должно быть уникальным в вашей учетной записи Amazon Web Services, иметь длину от 1 до 50 символов, содержать только буквы, цифры, дефисы и символы подчеркивания, не содержать пробелов, скобок, символов подстановки или специальных символов.

BrokerState -> (строка)

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

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

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

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

Текущая конфигурация брокера.

Id -> (строка)

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

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

Номер ревизии конфигурации.

History -> (список)

История конфигураций, примененных к брокеру.

(структура)

Список информации о конфигурации.

Id -> (строка)

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

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

Номер ревизии конфигурации.

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

Конфигурация брокера, ожидающая обработки.

Id -> (строка)

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

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

Номер ревизии конфигурации.

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

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

DeploymentMode -> (строка)

Режим развертывания брокера.

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

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

KmsKeyId -> (строка)

Идентификатор ключа шифрования клиента (CMK) для использования в A KMS (KMS). Этот ключ используется для шифрования данных в состоянии покоя. Если не указан, Amazon MQ будет использовать по умолчанию CMK для шифрования данных.

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

Включает использование управляемого Amazon Web Services ключа CMK с помощью KMS (KMS). По умолчанию установлено значение true, если не указано иное, например, для брокеров RabbitMQ.

EngineType -> (строка)

Тип движка брокера. В настоящее время Amazon MQ поддерживает ACTIVEMQ и RABBITMQ.

EngineVersion -> (строка)

Версия движка брокера. Дополнительную информацию можно найти в разделах управления версиями ActiveMQ и RabbitMQ в руководстве разработчика Amazon MQ.

HostInstanceType -> (строка)

Тип экземпляра брокера.

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

Метаданные LDAP-сервера, используемого для аутентификации и авторизации подключений к брокеру.

Hosts -> (список)

Указывает расположение LDAP-сервера, например, Directory Service для Microsoft Active Directory. Дополнительный сервер резервного копирования.

(строка)

RoleBase -> (строка)

Выделенный идентификатор узла в дереве информации каталога (DIT) для поиска ролей или групп. Например, ou=group, ou=corp, dc=corp, dc=example, dc=com.

RoleName -> (строка)

Указывает атрибут LDAP, идентифицирующий атрибут имени группы в объекте, возвращаемом запросом к группе членства.

RoleSearchMatching -> (строка)

Фильтр поиска LDAP, используемый для поиска ролей в roleBase. Выделенный идентификатор пользователя, соответствующий userSearchMatching, подставляется в заполнитель {0} в фильтре поиска. Имя пользователя клиента подставляется в заполнитель {1}. Например, если вы установите это значение в (member=uid={1}) для пользователя janedoe, фильтр поиска станет (member=uid=janedoe) после подстановки строк. Он соответствует всем записям ролей, у которых атрибут member равен uid=janedoe в поддереве, выбранном roleBase.

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

Область поиска каталога для роли. Если установлено значение true, область поиска охватывает все поддерево.

ServiceAccountUsername -> (строка)

Имя пользователя сервисного аккаунта. Сервисный аккаунт — это учетная запись на вашем LDAP-сервере, которая имеет доступ к инициации подключения. Например, cn=admin,dc=corp, dc=example, dc=com.

UserBase -> (строка)

Выберите определенное поддерево дерева информации каталога (DIT) для поиска записей пользователей. Поддерево определяется DN, который определяет базовый узел поддерева. Например, установив это значение в ou=Users,ou=corp, dc=corp, dc=example, dc=com, поиск записей пользователей ограничивается поддеревом под ou=Users, ou=corp, dc=corp, dc=example, dc=com.

UserRoleName -> (строка)

Указывает имя атрибута LDAP для членства в группе пользователей.

UserSearchMatching -> (строка)

Фильтр поиска LDAP, используемый для поиска пользователей в userBase. Имя пользователя клиента подставляется в заполнитель {0} в фильтре поиска. Например, если это значение установлено в (uid={0}), а полученное имя пользователя — janedoe, фильтр поиска становится (uid=janedoe) после подстановки строк. В результате будет сопоставлена запись типа uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

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

Область поиска каталога для пользователя. Если установлено значение true, область поиска охватывает все поддерево.

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

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

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

Включает журналирование аудита. Каждое действие по управлению пользователями, выполненное с помощью JMX или веб-консоли ActiveMQ, записывается в журнал.

AuditLogGroup -> (строка)

Расположение группы журналов CloudWatch Logs, в которую отправляются журналы аудита.

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

Включает общие журналы.

GeneralLogGroup -> (строка)

Расположение группы журналов CloudWatch Logs, в которую отправляются общие журналы.

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

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

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

Включает журналирование аудита. Каждое действие по управлению пользователями, выполненное с помощью JMX или веб-консоли ActiveMQ, записывается в журнал.

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

Включает общие журналы.

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

Параметры, определяющие WeeklyStartTime.

DayOfWeek -> (строка)

Обязательный. День недели.

TimeOfDay -> (строка)

Обязательный. Время в 24-часовом формате.

TimeZone -> (строка)

Временная зона, по умолчанию UTC, в формате Страна/Город или формате смещения от UTC.

PendingAuthenticationStrategy -> (строка)

Стратегия аутентификации, которая будет применена при перезапуске брокера. По умолчанию — SIMPLE.

PendingEngineVersion -> (строка)

Версия движка брокера, на которую необходимо обновить. Дополнительную информацию можно найти в разделах управления версиями ActiveMQ и RabbitMQ в руководстве разработчика Amazon MQ.

PendingHostInstanceType -> (строка)

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

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

Метаданные LDAP-сервера, которые будут использоваться для аутентификации и авторизации подключений к брокеру после перезапуска.

Hosts -> (список)

Указывает расположение LDAP-сервера, например, Directory Service для Microsoft Active Directory. Дополнительный сервер резервного копирования.

(строка)

RoleBase -> (строка)

Выделенный идентификатор узла в дереве информации каталога (DIT) для поиска ролей или групп. Например, ou=group, ou=corp, dc=corp, dc=example, dc=com.

RoleName -> (строка)

Указывает атрибут LDAP, идентифицирующий атрибут имени группы в объекте, возвращаемом запросом к группе членства.

RoleSearchMatching -> (строка)

Фильтр поиска LDAP, используемый для поиска ролей в roleBase. Выделенный идентификатор пользователя, соответствующий userSearchMatching, подставляется в заполнитель {0} в фильтре поиска. Имя пользователя клиента подставляется в заполнитель {1}. Например, если вы установите это значение в (member=uid={1}) для пользователя janedoe, фильтр поиска станет (member=uid=janedoe) после подстановки строк. Он соответствует всем записям ролей, у которых атрибут member равен uid=janedoe в поддереве, выбранном roleBase.

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

Область поиска каталога для роли. Если установлено значение true, область поиска охватывает все поддерево.

ServiceAccountUsername -> (строка)

Имя пользователя сервисного аккаунта. Сервисный аккаунт — это учетная запись на вашем LDAP-сервере, которая имеет доступ к инициации подключения. Например, cn=admin,dc=corp, dc=example, dc=com.

UserBase -> (строка)

Выберите определенное поддерево дерева информации каталога (DIT) для поиска записей пользователей. Поддерево определяется DN, который определяет базовый узел поддерева. Например, установив это значение в ou=Users,ou=corp, dc=corp, dc=example, dc=com, поиск записей пользователей ограничивается поддеревом под ou=Users, ou=corp, dc=corp, dc=example, dc=com.

UserRoleName -> (строка)

Указывает имя атрибута LDAP для членства в группе пользователей.

UserSearchMatching -> (строка)

Фильтр поиска LDAP, используемый для поиска пользователей в userBase. Имя пользователя клиента подставляется в заполнитель {0} в фильтре поиска. Например, если это значение установлено в (uid={0}), а полученное имя пользователя — janedoe, фильтр поиска становится (uid=janedoe) после подстановки строк. В результате будет сопоставлена запись типа uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

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

Область поиска каталога для пользователя. Если установлено значение true, область поиска охватывает все поддерево.

PendingSecurityGroups -> (список)

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

(строка)

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

Разрешает подключения из приложений, находящихся вне VPC, в котором находятся подсети брокера.

SecurityGroups -> (список)

Список правил (минимум 1, максимум 125), разрешающих подключения к брокерам.

(строка)

StorageType -> (строка)

Тип хранения брокера.

SubnetIds -> (список)

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

(строка)

Tags -> (карта)

Список всех тегов, связанных с этим брокером.

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

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

Users -> (список)

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

(структура)

Возвращает список всех пользователей брокера. Не относится к брокерам RabbitMQ.

PendingChange -> (строка)

Тип ожидаемого изменения для пользователя брокера.

Username -> (строка)

Обязательно. Имя пользователя брокера. Это значение может содержать только буквенно-цифровые символы, дефисы, точки, нижние подчеркивания и тильды (- . _ ~). Это значение должно быть длиной от 2 до 100 символов.

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

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

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

Описание брокера-реплики/главного брокера. Возвращается только в том случае, если этот брокер в настоящее время установлен в качестве основного или резервного в свойстве dataReplicationRole брокера.

BrokerId -> (строка)

Обязательно. Уникальный идентификатор брокера, сгенерированный Amazon MQ.

Region -> (строка)

Обязательно. Регион брокера.

DataReplicationRole -> (строка)

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

DataReplicationMode -> (строка)

Описывает, является ли этот брокер частью пары репликации данных.

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

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

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

Описание брокера-реплики/главного брокера. Возвращается только в том случае, если этот брокер в настоящее время установлен в качестве основного или резервного в свойстве dataReplicationRole брокера.

BrokerId -> (строка)

Обязательно. Уникальный идентификатор брокера, сгенерированный Amazon MQ.

Region -> (строка)

Обязательно. Регион брокера.

DataReplicationRole -> (строка)

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

PendingDataReplicationMode -> (строка)

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

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

Spec-Zone.ru

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