Spec-Zone.ru › AWS CLI v2

[ aws . mq ]

create-broker

Описание

Создаёт брокер. Примечание: этот API асинхронный.

Для создания брокера необходимо использовать политику IAM AmazonMQFullAccess или включить следующие разрешения EC2 в политике IAM.

  • ec2:CreateNetworkInterface Это разрешение необходимо для того, чтобы Amazon MQ мог создавать эластический сетевой интерфейс (ENI) от имени вашей учетной записи.
  • ec2:CreateNetworkInterfacePermission Это разрешение необходимо для подключения ENI к экземпляру брокера.
  • ec2:DeleteNetworkInterface
  • ec2:DeleteNetworkInterfacePermission
  • ec2:DetachNetworkInterface
  • ec2:DescribeInternetGateways
  • ec2:DescribeNetworkInterfaces
  • ec2:DescribeNetworkInterfacePermissions
  • ec2:DescribeRouteTables
  • ec2:DescribeSecurityGroups
  • ec2:DescribeSubnets
  • ec2:DescribeVpcs

Дополнительную информацию см. в руководстве разработчика Amazon MQ в разделе «Создание пользователя IAM и получение ваших учетных данных Amazon Web Services» и «Никогда не изменяйте или не удаляйте эластический сетевой интерфейс Amazon MQ».

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

Синтаксис

  create-broker
[--authentication-strategy <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
--broker-name <value>
[--configuration <value>]
[--creator-request-id <value>]
--deployment-mode <value>
[--encryption-options <value>]
--engine-type <value>
[--engine-version <value>]
--host-instance-type <value>
[--ldap-server-metadata <value>]
[--logs <value>]
[--maintenance-window-start-time <value>]
--publicly-accessible | --no-publicly-accessible
[--security-groups <value>]
[--storage-type <value>]
[--subnet-ids <value>]
[--tags <value>]
--users <value>
[--data-replication-mode <value>]
[--data-replication-primary-broker-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]

Параметры

--authentication-strategy (строка)

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

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

  • SIMPLE
  • LDAP

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

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

Примечание

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

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

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

Предупреждение

Не добавляйте в имена брокеров персональную информацию (PII) или другую конфиденциальную или чувствительную информацию. Имена брокеров доступны другим службам Amazon Web Services, включая CloudWatch Logs. Имена брокеров не предназначены для использования с частными или чувствительными данными.

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

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

Id -> (строка)

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

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

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

Краткая синтаксическая запись:

Id=string,Revision=integer

Синтаксис JSON:

{
  "Id": "string",
  "Revision": integer
}

--creator-request-id (строка)

Уникальный идентификатор, который получатель получает для созданного брокера. Amazon MQ передает ваш идентификатор с действием API.

Примечание

Рекомендуется использовать универсальный уникальный идентификатор (UUID) для creatorRequestId. Вы можете опустить creatorRequestId, если ваше приложение не требует идемпотентности.

--deployment-mode (строка)

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

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

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ
  • CLUSTER_MULTI_AZ

--encryption-options (структура)

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

KmsKeyId -> (строка)

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

UseAwsOwnedKey -> (булево)

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

Краткая синтаксическая запись:

KmsKeyId=string,UseAwsOwnedKey=boolean

Синтаксис JSON:

{
  "KmsKeyId": "string",
  "UseAwsOwnedKey": true|false
}

--engine-type (строка)

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

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

  • ACTIVEMQ
  • RABBITMQ

--engine-version (строка)

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

--host-instance-type (строка)

Обязательно. Тип экземпляра брокера.

--ldap-server-metadata (структура)

Необязательно. Метаданные сервера 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, подставляется в заполнитель {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"
}

--publicly-accessible | --no-publicly-accessible (булево)

Включает подключения от приложений за пределами VPC, в котором находятся подсети брокера. По умолчанию установлено в false, если значение не указано.

--security-groups (список)

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

(строка)

Синтаксис:

"string" "string" ...

--storage-type (строка)

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

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

  • EBS
  • EFS

--subnet-ids (список)

Список групп, определяющих, какие подсети и диапазоны IP брокером могут быть использованы из разных зон доступности. Если вы укажете более одной подсети, подсети должны находиться в разных зонах доступности. Amazon MQ не сможет создать VPC-точки входа для вашего брокера с несколькими подсетями в одной зоне доступности. Развертывание SINGLE_INSTANCE требует одной подсети (например, стандартной подсети). Развертывание Amazon MQ для ActiveMQ ACTIVE_STANDBY_MULTI_AZ требует двух подсетей. Развертывание Amazon MQ для RabbitMQ CLUSTER_MULTI_AZ не имеет требований к подсетям при развертывании с общедоступностью. Развертывание без общедоступности требует по крайней мере одной подсети.

Предупреждение

Если вы указываете подсети в общей VPC для брокера RabbitMQ, связанная VPC, к которой относятся указанные подсети, должна принадлежать вашей учетной записи Amazon Web Services. Amazon MQ не сможет создать VPC-точки входа в VPC, не принадлежащие вашей учетной записи Amazon Web Services.

(строка)

Синтаксис:

"string" "string" ...

--tags (карта)

Создайте теги при создании брокера.

key -> (строка)

value -> (строка)

Краткая синтаксическая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--users (список)

Список пользователей брокера (физических лиц или приложений), которые могут получить доступ к очередям и темам. Для брокеров Amazon MQ for RabbitMQ при первом развертывании принимается и создается только один административный пользователь. Все последующие пользователи брокера создаются путём прямых вызовов API RabbitMQ к брокерам или через веб-консоль RabbitMQ.

(структура)

Пользователь, связанный с брокером. Для брокеров Amazon MQ for RabbitMQ при первом развертывании принимается и создается только один административный пользователь. Все последующие пользователи брокера создаются путём прямых вызовов API RabbitMQ к брокерам или через веб-консоль RabbitMQ.

ConsoleAccess -> (boolean)

Включает доступ к веб-консоли ActiveMQ для пользователя ActiveMQ. Не применяется к брокерам RabbitMQ.

Groups -> (список)

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

(строка)

Password -> (строка)

Обязательно. Пароль пользователя. Это значение должно быть длиной не менее 12 символов, содержать не менее 4 уникальных символов и не должно содержать запятые, двоеточия или знаки равенства (,:=).

Username -> (строка)

Имя пользователя брокера. Применяются следующие ограничения к именам пользователей брокера:

  • Для брокеров Amazon MQ for ActiveMQ это значение может содержать только буквенно-цифровые символы, дефисы, точки, нижние подчеркивания и тильды (- . _ ~). Это значение должно быть длиной от 2 до 100 символов.
  • para>Для брокеров Amazon MQ for RabbitMQ это значение может содержать только буквенно-цифровые символы, дефисы и точки (- . _). Это значение не должно содержать символа тильды (~). Amazon MQ запрещает использование guest в качестве имени пользователя. Это значение должно быть длиной от 2 до 100 символов.

Предупреждение

Не добавляйте персональные данные (PII) или другую конфиденциальную или чувствительную информацию в имена пользователей брокера. Имена пользователей брокера доступны другим службам Amazon Web Services, включая CloudWatch Logs. Имена пользователей брокеров не предназначены для использования с частными или конфиденциальными данными.

ReplicationUser -> (boolean)

Определяет, предназначен ли этот пользователь для целей репликации CRDR.

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

ConsoleAccess=boolean,Groups=string,string,Password=string,Username=string,ReplicationUser=boolean ...

Синтаксис JSON:

[
  {
    "ConsoleAccess": true|false,
    "Groups": ["string", ...],
    "Password": "string",
    "Username": "string",
    "ReplicationUser": true|false
  }
  ...
]

--data-replication-mode (строка)

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

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

  • NONE
  • CRDR

--data-replication-primary-broker-arn (строка)

Amazon Resource Name (ARN) первичного брокера, используемого для репликации данных в паре репликации данных и применяемого к брокеру-копии. Должен быть задан, когда dataReplicationMode установлен в 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 (boolean)

Включить отладку логов.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--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 (boolean)

Отключить вывод пейджера CLI.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

BrokerArn -> (строка)

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

BrokerId -> (строка)

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

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

Spec-Zone.ru

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