Amazon MQ · JSON Structure

Mq Api Configuration Structure

Returns information about all configurations.

Type: object Properties: 10 Required: 9
BroadcastingMedia ProcessingMedia

Configuration is a JSON Structure definition published by Amazon MQ, describing 10 properties, of which 9 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Arn AuthenticationStrategy Created Description EngineType EngineVersion Id LatestRevision Name Tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mq/refs/heads/main/json-structure/mq-api-configuration-structure.json",
  "name": "Configuration",
  "type": "object",
  "description": "Returns information about all configurations.",
  "properties": {
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "arn"
          },
          "description": "Required. The ARN of the configuration."
        }
      ]
    },
    "AuthenticationStrategy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationStrategy"
        },
        {
          "xml": {
            "name": "authenticationStrategy"
          },
          "description": "Optional. The authentication strategy associated with the configuration. The default is SIMPLE."
        }
      ]
    },
    "Created": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__timestampIso8601"
        },
        {
          "xml": {
            "name": "created"
          },
          "description": "Required. The date and time of the configuration revision."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "Required. The description of the configuration."
        }
      ]
    },
    "EngineType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EngineType"
        },
        {
          "xml": {
            "name": "engineType"
          },
          "description": "Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ."
        }
      ]
    },
    "EngineVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "engineVersion"
          },
          "description": "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>."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "id"
          },
          "description": "Required. The unique ID that Amazon MQ generates for the configuration."
        }
      ]
    },
    "LatestRevision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationRevision"
        },
        {
          "xml": {
            "name": "latestRevision"
          },
          "description": "Required. The latest revision of the configuration."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__mapOf__string"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "The list of all tags associated with this configuration."
        }
      ]
    }
  },
  "required": [
    "Description",
    "EngineVersion",
    "LatestRevision",
    "AuthenticationStrategy",
    "EngineType",
    "Id",
    "Arn",
    "Name",
    "Created"
  ]
}