Configuration
A configuration contains all of the settings for your broker. For more information, see Amazon MQ for RabbitMQ broker configurations and Amazon MQ for ActiveMQ broker configurations in the Amazon MQ Developer Guide.
You can create a configuration before creating any brokers. You can then apply the configuration to one or more brokers.
Important
Making changes to a configuration does not apply the changes to the broker immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker.
URI
/v1/configurations/
configuration-id
HTTP methods
GET
Operation ID: DescribeConfiguration
Returns information about the specified configuration.
Name | Type | Required | Description |
---|---|---|---|
configuration-id | String | True | The unique ID that Amazon MQ generates for the configuration. |
Status code | Response model | Description |
---|---|---|
200 |
Configuration | HTTP Status Code 200: OK. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
500 | Error | HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. |
PUT
Operation ID: UpdateConfiguration
Updates the specified configuration.
Name | Type | Required | Description |
---|---|---|---|
configuration-id | String | True | The unique ID that Amazon MQ generates for the configuration. |
Status code | Response model | Description |
---|---|---|
200 |
UpdateConfigurationOutput | HTTP Status Code 200: OK. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
409 | Error | HTTP Status Code 409: Configuration ID is already in use. Remove the configuration from all brokers and retry the request. |
500 | Error | HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. |
DELETE
Operation ID: DeleteConfiguration
Deletes the specified configuration.
Name | Type | Required | Description |
---|---|---|---|
configuration-id | String | True | The unique ID that Amazon MQ generates for the configuration. |
Status code | Response model | Description |
---|---|---|
200 |
DeleteConfigurationOutput | HTTP Status Code 200: OK. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
409 | Error | HTTP Status Code 409: Configuration ID is already in use. Remove the configuration from all brokers and retry the request. |
500 | Error | HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. |
OPTIONS
Name | Type | Required | Description |
---|---|---|---|
configuration-id | String | True | The unique ID that Amazon MQ generates for the configuration. |
Status code | Response model | Description |
---|---|---|
200 | None | Default response for CORS method |
Schemas
Request bodies
{ "data": "string", "description": "string" }
Response bodies
{ "engineVersion": "string", "created": "string", "authenticationStrategy": enum, "name": "string", "description": "string", "engineType": enum, "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }, "tags": { } }
{ "created": "string", "warnings": [ { "reason": enum, "attributeName": "string", "elementName": "string" } ], "name": "string", "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer } }
{ "configurationId": "string" }
{ "errorAttribute": "string", "message": "string" }
Properties
AuthenticationStrategy
Optional. The authentication strategy used to secure the broker. The
default is SIMPLE
.
SIMPLE
LDAP
Configuration
Returns information about all configurations.
Property | Type | Required | Description |
---|---|---|---|
arn | string | True | Required. The ARN of the configuration. |
authenticationStrategy | True | Optional. The authentication strategy associated with the configuration. The
default is | |
created | string Format: date-time | True | Required. The date and time of the configuration revision. |
description | string | True | Required. The description of the configuration. |
engineType | True | Required. The type of broker engine. Currently, Amazon MQ supports | |
engineVersion | string | True | The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide. |
id | string | True | Required. The unique ID that Amazon MQ generates for the configuration. |
latestRevision | True | Required. The latest revision of the configuration. | |
name | string | True | Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. |
tags | object | False | The list of all tags associated with this configuration. |
ConfigurationRevision
Returns information about the specified configuration revision.
Property | Type | Required | Description |
---|---|---|---|
created | string Format: date-time | True | Required. The date and time of the configuration revision. |
description | string | False | The description of the configuration revision. |
revision | integer | True | Required. The revision number of the configuration. |
DeleteConfigurationOutput
Returns information about the deleted configuration.
Property | Type | Required | Description |
---|---|---|---|
configurationId | string | False | The unique ID that Amazon MQ generates for the configuration. |
EngineType
The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
ACTIVEMQ
RABBITMQ
Error
Returns information about an error.
Property | Type | Required | Description |
---|---|---|---|
errorAttribute | string | False | The attribute which caused the error. |
message | string | False | The explanation of the error. |
SanitizationWarning
Returns information about the configuration element or attribute that was sanitized in the configuration.
Property | Type | Required | Description |
---|---|---|---|
attributeName | string | False | The name of the configuration attribute that has been sanitized. |
elementName | string | False | The name of the configuration element that has been sanitized. |
reason | True | The reason for which the configuration elements or attributes were sanitized. |
SanitizationWarningReason
The reason for which the configuration elements or attributes were sanitized.
DISALLOWED_ELEMENT_REMOVED
DISALLOWED_ATTRIBUTE_REMOVED
INVALID_ATTRIBUTE_VALUE_REMOVED
UpdateConfigurationInput
Updates the specified configuration.
Property | Type | Required | Description |
---|---|---|---|
data | string Format: byte | True | Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration. |
description | string | False | The description of the configuration. |
UpdateConfigurationOutput
Returns information about the updated configuration.
Property | Type | Required | Description |
---|---|---|---|
arn | string | True | The Amazon Resource Name (ARN) of the configuration. |
created | string Format: date-time | True | Required. The date and time of the configuration. |
id | string | True | The unique ID that Amazon MQ generates for the configuration. |
latestRevision | False | The latest revision of the configuration. | |
name | string | True | The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. |
warnings | Array of type SanitizationWarning | False | The list of the first 20 warnings about the configuration elements or attributes that were sanitized. |