Table Of Contents

Feedback

User Guide

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

[ aws . mq ]

update-broker

Description

Adds a pending configuration change to a broker.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-broker
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
--broker-id <value>
[--configuration <value>]
[--engine-version <value>]
[--logs <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (boolean) 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-id (string) 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:

Id=string,Revision=integer

JSON Syntax:

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

--engine-version (string) The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

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

Shorthand Syntax:

Audit=boolean,General=boolean

JSON Syntax:

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

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

Output

AutoMinorVersionUpgrade -> (boolean)

The new value of automatic upgrades to new minor version for brokers.

BrokerId -> (string)

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

Configuration -> (structure)

The ID of the updated configuration.

Id -> (string)

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

Revision -> (integer)

The revision number of the configuration.

EngineVersion -> (string)

The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

Logs -> (structure)

The list of information about logs to be enabled for the specified broker.

Audit -> (boolean)

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

General -> (boolean)

Enables general logging.