Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mq ]



Creates a broker. Note: This API is asynchronous.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--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>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--authentication-strategy (string) The authentication strategy used to secure the broker.

Possible values:

  • LDAP

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (boolean) Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

--broker-name (string) Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

--configuration (structure) A list of information about the configuration.Id -> (string)

Required. The unique ID that Amazon MQ generates for the configuration.

Revision -> (integer)

The revision number of the configuration.

Shorthand Syntax:


JSON Syntax:

  "Id": "string",
  "Revision": integer

--creator-request-id (string) The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

--deployment-mode (string) Required. The deployment mode of the broker.

Possible values:


--encryption-options (structure) Encryption options for the broker.KmsKeyId -> (string)

The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

UseAwsOwnedKey -> (boolean)

Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).

Shorthand Syntax:


JSON Syntax:

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

--engine-type (string) Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Possible values:


--engine-version (string) Required. The version of the broker engine. For a list of supported engine versions, see

--host-instance-type (string) Required. The broker's instance type.

--ldap-server-metadata (structure) The metadata of the LDAP server used to authenticate and authorize connections to the broker.Hosts -> (list)

Fully qualified domain name of the LDAP server. Optional failover server.


RoleBase -> (string)

Fully qualified name of the directory to search for a user’s groups.

RoleName -> (string)

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

RoleSearchMatching -> (string)

The search criteria for groups.

RoleSearchSubtree -> (boolean)

The directory search scope for the role. If set to true, scope is to search the entire sub-tree.

ServiceAccountPassword -> (string)

Service account password.

ServiceAccountUsername -> (string)

Service account username.

UserBase -> (string)

Fully qualified name of the directory where you want to search for users.

UserRoleName -> (string)

Specifies the name of the LDAP attribute for the user group membership.

UserSearchMatching -> (string)

The search criteria for users.

UserSearchSubtree -> (boolean)

The directory search scope for the user. If set to true, scope is to search the entire sub-tree.

Shorthand Syntax:


JSON Syntax:

  "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 (structure) Enables Amazon CloudWatch logging for brokers.Audit -> (boolean)

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

General -> (boolean)

Enables general logging.

Shorthand Syntax:


JSON Syntax:

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

--maintenance-window-start-time (structure) The parameters that determine the WeeklyStartTime.DayOfWeek -> (string)

Required. The day of the week.

TimeOfDay -> (string)

Required. The time, in 24-hour format.

TimeZone -> (string)

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

Shorthand Syntax:


JSON Syntax:

  "TimeOfDay": "string",
  "TimeZone": "string"

--publicly-accessible | --no-publicly-accessible (boolean) Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.

--security-groups (list) The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.(string)


"string" "string" ...

--storage-type (string) The broker's storage type.

Possible values:

  • EBS
  • EFS

--subnet-ids (list) The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.(string)


"string" "string" ...

--tags (map) Create tags when creating the broker.key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--users (list) Required. The list of broker users (persons or applications) who can access queues and topics. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.(structure)

A user associated with the broker.

ConsoleAccess -> (boolean)

Enables access to the ActiveMQ Web Console for the ActiveMQ user (Does not apply to RabbitMQ brokers).

Groups -> (list)

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


Password -> (string)

Required. The password of the broker user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

Username -> (string)

Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


BrokerArn -> (string)

The Amazon Resource Name (ARN) of the broker.

BrokerId -> (string)

The unique ID that Amazon MQ generates for the broker.