POST

/v1/configurations

http://mq.{region}.amazonaws.com/v1/configurations

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Access Token Required: API Key

Body Params

namestringrequired

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.

tagsobject

Create tags when creating the configuration.

engineTypestringrequired

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

engineVersionstringrequired

Required. The broker engine's 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>.

authenticationStrategystring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://mq.{region}.amazonaws.com/v1/configurations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}