update-broker
Описание
Добавляет ожидаемое изменение конфигурации брокера.
См. также: Документацию API AWS
Синтаксис
update-broker
[--authentication-strategy <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
--broker-id <value>
[--configuration <value>]
[--engine-version <value>]
[--host-instance-type <value>]
[--ldap-server-metadata <value>]
[--logs <value>]
[--maintenance-window-start-time <value>]
[--security-groups <value>]
[--data-replication-mode <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]
Параметры
--authentication-strategy (строка)
Необязательно. Стратегия аутентификации, используемая для защиты брокера. По умолчанию SIMPLE.
Возможные значения:
SIMPLELDAP
--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (булево)
Включает автоматические обновления до новых версий патчей для брокеров по мере выпуска и поддержки новых версий Amazon MQ. Автоматические обновления происходят во время запланированного окна технического обслуживания или после перезапуска брокера вручную.
Примечание
Должно быть установлено в значение true для брокеров ActiveMQ версии 5.18 и выше и для брокеров RabbitMQ версии 3.13 и выше.--broker-id (строка)
--configuration (структура)
Список информации о конфигурации.
Id -> (строка)
Revision -> (целое число)
Сокращенный синтаксис:
Id=string,Revision=integer
Синтаксис JSON:
{
"Id": "string",
"Revision": integer
}
--engine-version (строка)
Версия движка брокера. Для получения дополнительной информации см. разделы управления версиями ActiveMQ и RabbitMQ в руководстве разработчика Amazon MQ.
Примечание
При обновлении до ActiveMQ версии 5.18 и выше или RabbitMQ версии 3.13 и выше, для брокера необходимо установить autoMinorVersionUpgrade в значение true.--host-instance-type (строка)
--ldap-server-metadata (структура)
Необязательно. Метаданные сервера LDAP, используемые для аутентификации и авторизации подключений к брокеру. Не применимо к брокерам RabbitMQ.
Hosts -> (список)
Указывает расположение сервера LDAP, например, Directory Service для Microsoft Active Directory. Необязательный сервер резервного копирования.
(строка)
RoleBase -> (строка)
RoleName -> (строка)
RoleSearchMatching -> (строка)
RoleSearchSubtree -> (булево)
ServiceAccountPassword -> (строка)
ServiceAccountUsername -> (строка)
UserBase -> (строка)
UserRoleName -> (строка)
UserSearchMatching -> (строка)
UserSearchSubtree -> (булево)
Сокращенный синтаксис:
Hosts=string,string,RoleBase=string,RoleName=string,RoleSearchMatching=string,RoleSearchSubtree=boolean,ServiceAccountPassword=string,ServiceAccountUsername=string,UserBase=string,UserRoleName=string,UserSearchMatching=string,UserSearchSubtree=boolean
Синтаксис JSON:
{
"Hosts": ["string", ...],
"RoleBase": "string",
"RoleName": "string",
"RoleSearchMatching": "string",
"RoleSearchSubtree": true|false,
"ServiceAccountPassword": "string",
"ServiceAccountUsername": "string",
"UserBase": "string",
"UserRoleName": "string",
"UserSearchMatching": "string",
"UserSearchSubtree": true|false
}
--logs (структура)
Включает ведение журнала Amazon CloudWatch для брокеров.
Audit -> (булево)
General -> (булево)
Сокращенный синтаксис:
Audit=boolean,General=boolean
Синтаксис JSON:
{
"Audit": true|false,
"General": true|false
}
--maintenance-window-start-time (структура)
Параметры, определяющие WeeklyStartTime.
DayOfWeek -> (строка)
TimeOfDay -> (строка)
TimeZone -> (строка)
Сокращенный синтаксис:
DayOfWeek=string,TimeOfDay=string,TimeZone=string
Синтаксис JSON:
{
"DayOfWeek": "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY",
"TimeOfDay": "string",
"TimeZone": "string"
}
--security-groups (список)
Список сетей безопасности (минимально 1, максимально 5), которые разрешают подключения к брокерам.
(строка)
Синтаксис:
"string" "string" ...
--data-replication-mode (строка)
Определяет, является ли этот брокер частью пары репликации данных.
Возможные значения:
NONECRDR
--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 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.
Вывод
AuthenticationStrategy -> (строка)
AutoMinorVersionUpgrade -> (логическое значение)
BrokerId -> (строка)
Configuration -> (структура)
Идентификатор обновленной конфигурации.
Id -> (строка)
Revision -> (целое число)
EngineVersion -> (строка)
HostInstanceType -> (строка)
LdapServerMetadata -> (структура)
Необязательно. Метаданные сервера LDAP, используемого для аутентификации и авторизации подключений к брокеру. Не относится к брокер RabbitMQ.
Hosts -> (список)
Указывает расположение сервера LDAP, например, Службы каталогов Microsoft Active Directory. Необязательный сервер резервного копирования.
(строка)
RoleBase -> (строка)
RoleName -> (строка)
RoleSearchMatching -> (строка)
RoleSearchSubtree -> (логическое значение)
ServiceAccountUsername -> (строка)
UserBase -> (строка)
UserRoleName -> (строка)
UserSearchMatching -> (строка)
UserSearchSubtree -> (логическое значение)
Logs -> (структура)
Список информации о журналах, которые нужно включить для указанного брокера.
Audit -> (логическое значение)
General -> (логическое значение)
MaintenanceWindowStartTime -> (структура)
Параметры, определяющие WeeklyStartTime.
DayOfWeek -> (строка)
TimeOfDay -> (строка)
TimeZone -> (строка)
SecurityGroups -> (список)
Список групп безопасности (минимум 1, максимум 5), которые разрешают подключения к брокеру.
(строка)
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.