Table Of Contents


User Guide

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

[ aws . mq ]



Creates a broker. Note: This API is asynchronous.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--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>]
[--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>]


--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.

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.

Shorthand Syntax:


JSON Syntax:

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

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

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.

--logs (structure) Enables Amazon CloudWatch logging for brokers.

Shorthand Syntax:


JSON Syntax:

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

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

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" ...

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

Possible values:

  • EBS
  • EFS

--subnet-ids (list) The list of groups (2 maximum) 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 requires two subnets.


"string" "string" ...

--tags (map) Create tags when creating the broker.

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--users (list) Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. 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.