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 (строка)
--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 -> (строка)
AutoMinorVersionUpgrade -> (логическое значение)
BrokerArn -> (строка)
BrokerId -> (строка)
BrokerInstances -> (список)
Список информации об выделенных брокерах.
(структура)
Возвращает информацию обо всех брокерах.
ConsoleURL -> (строка)
Endpoints -> (список)
Точки подключения протокола брокера на уровне сети.
(строка)
IpAddress -> (строка)
BrokerName -> (строка)
BrokerState -> (строка)
Configurations -> (структура)
Список всех ревизий для указанной конфигурации.
Current -> (структура)
Текущая конфигурация брокера.
Id -> (строка)
Revision -> (целое число)
History -> (список)
История конфигураций, примененных к брокеру.
(структура)
Список информации о конфигурации.
Id -> (строка)
Revision -> (целое число)
Pending -> (структура)
Конфигурация брокера, ожидающая обработки.
Id -> (строка)
Revision -> (целое число)
Created -> (метка времени)
DeploymentMode -> (строка)
EncryptionOptions -> (структура)
Параметры шифрования для брокера.
KmsKeyId -> (строка)
UseAwsOwnedKey -> (логическое значение)
EngineType -> (строка)
EngineVersion -> (строка)
HostInstanceType -> (строка)
LdapServerMetadata -> (структура)
Метаданные LDAP-сервера, используемого для аутентификации и авторизации подключений к брокеру.
Hosts -> (список)
Указывает расположение LDAP-сервера, например, Directory Service для Microsoft Active Directory. Дополнительный сервер резервного копирования.
(строка)
RoleBase -> (строка)
RoleName -> (строка)
RoleSearchMatching -> (строка)
RoleSearchSubtree -> (логическое значение)
ServiceAccountUsername -> (строка)
UserBase -> (строка)
UserRoleName -> (строка)
UserSearchMatching -> (строка)
UserSearchSubtree -> (логическое значение)
Logs -> (структура)
Список информации о журналах, которые в настоящее время включены и ожидают развертывания для указанного брокера.
Audit -> (логическое значение)
AuditLogGroup -> (строка)
General -> (логическое значение)
GeneralLogGroup -> (строка)
Pending -> (структура)
Список информации о журналах, которые ожидают развертывания для указанного брокера.
Audit -> (логическое значение)
General -> (логическое значение)
MaintenanceWindowStartTime -> (структура)
Параметры, определяющие WeeklyStartTime.
DayOfWeek -> (строка)
TimeOfDay -> (строка)
TimeZone -> (строка)
PendingAuthenticationStrategy -> (строка)
PendingEngineVersion -> (строка)
PendingHostInstanceType -> (строка)
PendingLdapServerMetadata -> (структура)
Метаданные LDAP-сервера, которые будут использоваться для аутентификации и авторизации подключений к брокеру после перезапуска.
Hosts -> (список)
Указывает расположение LDAP-сервера, например, Directory Service для Microsoft Active Directory. Дополнительный сервер резервного копирования.
(строка)
RoleBase -> (строка)
RoleName -> (строка)
RoleSearchMatching -> (строка)
RoleSearchSubtree -> (логическое значение)
ServiceAccountUsername -> (строка)
UserBase -> (строка)
UserRoleName -> (строка)
UserSearchMatching -> (строка)
UserSearchSubtree -> (логическое значение)
PendingSecurityGroups -> (список)
Список ожидающих групп безопасности для авторизации подключений к брокерам.
(строка)
PubliclyAccessible -> (логическое значение)
SecurityGroups -> (список)
Список правил (минимум 1, максимум 125), разрешающих подключения к брокерам.
(строка)
StorageType -> (строка)
SubnetIds -> (список)
Список групп, определяющих, какие подсети и диапазоны IP-адресов может использовать брокер из разных зон доступности.
(строка)
Tags -> (карта)
Список всех тегов, связанных с этим брокером.
ключ -> (строка)
значение -> (строка)
Users -> (список)
Список всех имен пользователей брокера для указанного брокера.
(структура)
Возвращает список всех пользователей брокера. Не относится к брокерам RabbitMQ.
PendingChange -> (строка)
Username -> (строка)
DataReplicationMetadata -> (структура)
Подробности репликации данных для брокера, поддерживающего репликацию данных. Возвращается только в том случае, если dataReplicationMode установлено в CRDR.
DataReplicationCounterpart -> (структура)
Описание брокера-реплики/главного брокера. Возвращается только в том случае, если этот брокер в настоящее время установлен в качестве основного или резервного в свойстве dataReplicationRole брокера.
BrokerId -> (строка)
Region -> (строка)
DataReplicationRole -> (строка)
DataReplicationMode -> (строка)
PendingDataReplicationMetadata -> (структура)
Ожидаемые данные репликации для брокера, поддерживающего репликацию данных. Возвращается только в том случае, если pendingDataReplicationMode установлено в CRDR.
DataReplicationCounterpart -> (структура)
Описание брокера-реплики/главного брокера. Возвращается только в том случае, если этот брокер в настоящее время установлен в качестве основного или резервного в свойстве dataReplicationRole брокера.
BrokerId -> (строка)
Region -> (строка)
DataReplicationRole -> (строка)
PendingDataReplicationMode -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.