Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1422100118.2 KB

Adds a pending configuration change to a broker.

put/v1/brokers/{broker-id}

Path parameters

broker-idstring required

The unique ID that Amazon MQ generates for the broker.

Request body

authenticationStrategy'SIMPLE' | 'LDAP'

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

autoMinorVersionUpgradeboolean

Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

engineVersionstring

The broker engine version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.

hostInstanceTypestring

The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.

securityGroupsString[]

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

Response

Success

AuthenticationStrategy'SIMPLE' | 'LDAP'

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgradeboolean

The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.

BrokerIdstring

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

EngineVersionstring

The broker engine version to upgrade to. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.

HostInstanceTypestring

The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.

SecurityGroupsString[]

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