Spec-Zone.ru › AWS CLI v2

[ aws . mq ]

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.

Возможные значения:

  • SIMPLE
  • LDAP

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (булево)

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

Примечание

Должно быть установлено в значение true для брокеров ActiveMQ версии 5.18 и выше и для брокеров RabbitMQ версии 3.13 и выше.

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

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

--configuration (структура)

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

Id -> (строка)

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

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 -> (строка)

Отличительное имя узла в дереве информации каталога (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, область поиска — всё поддерево.

ServiceAccountPassword -> (строка)

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

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, область поиска — всё поддерево.

Сокращенный синтаксис:

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 -> (булево)

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

General -> (булево)

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

Сокращенный синтаксис:

Audit=boolean,General=boolean

Синтаксис JSON:

{
  "Audit": true|false,
  "General": true|false
}

--maintenance-window-start-time (структура)

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

DayOfWeek -> (строка)

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

TimeOfDay -> (строка)

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

TimeZone -> (строка)

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

Сокращенный синтаксис:

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 (строка)

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

Возможные значения:

  • NONE
  • CRDR

--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 -> (строка)

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

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

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

BrokerId -> (строка)

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

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

Идентификатор обновленной конфигурации.

Id -> (строка)

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

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

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

EngineVersion -> (строка)

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

HostInstanceType -> (строка)

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

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

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

Hosts -> (список)

Указывает расположение сервера LDAP, например, Службы каталогов Microsoft Active Directory. Необязательный сервер резервного копирования.

(строка)

RoleBase -> (строка)

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

RoleName -> (строка)

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

RoleSearchMatching -> (строка)

Фильтр поиска LDAP, используемый для поиска ролей в пределах roleBase. Отличительное имя пользователя, соответствующего userSearchMatching, подставляется в placeholder {0} в фильтре поиска. Имя пользователя клиента подставляется в placeholder {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. Имя пользователя клиента подставляется в placeholder {0} в фильтре поиска. Например, если этот параметр установлен в значение (uid={0}), а полученное имя пользователя — janedoe, фильтр поиска станет (uid=janedoe) после подстановки строк. Результатом будет соответствие записи, подобной uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

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

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

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

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

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

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

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

Включает общее протоколирование.

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

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

DayOfWeek -> (строка)

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

TimeOfDay -> (строка)

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

TimeZone -> (строка)

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

SecurityGroups -> (список)

Список групп безопасности (минимум 1, максимум 5), которые разрешают подключения к брокеру.

(строка)

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