Amazon MQ · Schema
User
A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
BroadcastingMedia ProcessingMedia
Properties
| Name | Type | Description |
|---|---|---|
| ConsoleAccess | object | |
| Groups | object | |
| Password | object | |
| Username | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mq/refs/heads/main/json-schema/mq-api-user-schema.json",
"title": "User",
"description": "A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.",
"type": "object",
"properties": {
"ConsoleAccess": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"xml": {
"name": "consoleAccess"
},
"description": "Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers."
}
]
},
"Groups": {
"allOf": [
{
"$ref": "#/components/schemas/__listOf__string"
},
{
"xml": {
"name": "groups"
},
"description": "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers."
}
]
},
"Password": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "password"
},
"description": "Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=)."
}
]
},
"Username": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"xml": {
"name": "username"
},
"description": "<p>important><title>Amazon MQ for ActiveMQ</title> <para>For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p>/important> <important><title>Amazon MQ for RabbitMQ</title> <p>For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.</p></important></para>"
}
]
}
},
"required": [
"Username",
"Password"
]
}