CINXE.COM

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Broker - Amazon MQ</title><meta name="viewport" content="width=device-width,initial-scale=1" /><meta name="assets_root" content="/assets" /><meta name="target_state" content="brokers-broker-id" /><meta name="default_state" content="brokers-broker-id" /><link rel="icon" type="image/ico" href="/assets/images/favicon.ico" /><link rel="shortcut icon" type="image/ico" href="/assets/images/favicon.ico" /><link rel="canonical" href="https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html" /><meta name="description" content="A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. For more information about the different components of an Amazon MQ broker, see How Amazon MQ works in the Amazon MQ Developer Guide ." /><meta name="deployment_region" content="IAD" /><meta name="product" content="Amazon MQ" /><meta name="guide" content="REST API Reference" /><meta name="guide-locale" content="en_us" /><meta name="tocs" content="toc-contents.json" /><link rel="canonical" href="https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html" /><link rel="alternative" href="https://docs.aws.amazon.com/id_id/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="id-id" /><link rel="alternative" href="https://docs.aws.amazon.com/id_id/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="id" /><link rel="alternative" href="https://docs.aws.amazon.com/de_de/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="de-de" /><link rel="alternative" href="https://docs.aws.amazon.com/de_de/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="de" /><link rel="alternative" href="https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="en-us" /><link rel="alternative" href="https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="en" /><link rel="alternative" href="https://docs.aws.amazon.com/es_es/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="es-es" /><link rel="alternative" href="https://docs.aws.amazon.com/es_es/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="es" /><link rel="alternative" href="https://docs.aws.amazon.com/fr_fr/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="fr-fr" /><link rel="alternative" href="https://docs.aws.amazon.com/fr_fr/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="fr" /><link rel="alternative" href="https://docs.aws.amazon.com/it_it/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="it-it" /><link rel="alternative" href="https://docs.aws.amazon.com/it_it/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="it" /><link rel="alternative" href="https://docs.aws.amazon.com/ja_jp/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="ja-jp" /><link rel="alternative" href="https://docs.aws.amazon.com/ja_jp/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="ja" /><link rel="alternative" href="https://docs.aws.amazon.com/ko_kr/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="ko-kr" /><link rel="alternative" href="https://docs.aws.amazon.com/ko_kr/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="ko" /><link rel="alternative" href="https://docs.aws.amazon.com/pt_br/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="pt-br" /><link rel="alternative" href="https://docs.aws.amazon.com/pt_br/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="pt" /><link rel="alternative" href="https://docs.aws.amazon.com/zh_cn/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="zh-cn" /><link rel="alternative" href="https://docs.aws.amazon.com/zh_tw/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="zh-tw" /><link rel="alternative" href="https://docs.aws.amazon.com/amazon-mq/latest/api-reference/brokers-broker-id.html" hreflang="x-default" /><meta name="feedback-item" content="AMQ" /><meta name="this_doc_product" content="Amazon MQ" /><meta name="this_doc_guide" content="REST API Reference" /><script defer="" src="/assets/r/vendor4.js?version=2021.12.02"></script><script defer="" src="/assets/r/vendor3.js?version=2021.12.02"></script><script defer="" src="/assets/r/vendor1.js?version=2021.12.02"></script><script defer="" src="/assets/r/awsdocs-common.js?version=2021.12.02"></script><script defer="" src="/assets/r/awsdocs-doc-page.js?version=2021.12.02"></script><link href="/assets/r/vendor4.css?version=2021.12.02" rel="stylesheet" /><link href="/assets/r/awsdocs-common.css?version=2021.12.02" rel="stylesheet" /><link href="/assets/r/awsdocs-doc-page.css?version=2021.12.02" rel="stylesheet" /><script async="" id="awsc-panorama-bundle" type="text/javascript" src="https://prod.pa.cdn.uis.awsstatic.com/panorama-nav-init.js" data-config="{'appEntity':'aws-documentation','region':'us-east-1','service':'amazon-mq'}"></script><meta id="panorama-serviceSubSection" value="REST API Reference" /><meta id="panorama-serviceConsolePage" value="Broker" /></head><body class="awsdocs awsui"><div class="awsdocs-container"><awsdocs-header></awsdocs-header><awsui-app-layout id="app-layout" class="awsui-util-no-gutters" ng-controller="ContentController as $ctrl" header-selector="awsdocs-header" navigation-hide="false" navigation-width="$ctrl.navWidth" navigation-open="$ctrl.navOpen" navigation-change="$ctrl.onNavChange($event)" tools-hide="$ctrl.hideTools" tools-width="$ctrl.toolsWidth" tools-open="$ctrl.toolsOpen" tools-change="$ctrl.onToolsChange($event)"><div id="guide-toc" dom-region="navigation"><awsdocs-toc></awsdocs-toc></div><div id="main-column" dom-region="content" tabindex="-1"><awsdocs-view class="awsdocs-view"><div id="awsdocs-content"><head><title>Broker - Amazon MQ</title><meta name="pdf" content="/pdfs/amazon-mq/latest/api-reference/amazon-mq-api.pdf#brokers-broker-id" /><meta name="forums" content="https://repost.aws/tags/TAYRafuC0UQvCx_4E9n3IwNw" /><meta name="feedback" content="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=AMQ&topic_url=https://docs.aws.amazon.com/en_us/amazon-mq/latest/api-reference/brokers-broker-id.html" /><meta name="feedback-yes" content="feedbackyes.html?topic_url=https://docs.aws.amazon.com/en_us/amazon-mq/latest/api-reference/brokers-broker-id.html" /><meta name="feedback-no" content="feedbackno.html?topic_url=https://docs.aws.amazon.com/en_us/amazon-mq/latest/api-reference/brokers-broker-id.html" /><script type="application/ld+json"> { "@context" : "https://schema.org", "@type" : "BreadcrumbList", "itemListElement" : [ { "@type" : "ListItem", "position" : 1, "name" : "AWS", "item" : "https://aws.amazon.com" }, { "@type" : "ListItem", "position" : 2, "name" : "Amazon MQ", "item" : "https://docs.aws.amazon.com/amazon-mq/index.html" }, { "@type" : "ListItem", "position" : 3, "name" : "REST API Reference", "item" : "https://docs.aws.amazon.com/amazon-mq/latest/api-reference" }, { "@type" : "ListItem", "position" : 4, "name" : "Resources", "item" : "https://docs.aws.amazon.com/amazon-mq/latest/api-reference/resources.html" }, { "@type" : "ListItem", "position" : 5, "name" : "Broker", "item" : "https://docs.aws.amazon.com/amazon-mq/latest/api-reference/resources.html" } ] } </script></head><body><div id="main"><div style="display: none"><a href="/pdfs/amazon-mq/latest/api-reference/amazon-mq-api.pdf#brokers-broker-id" target="_blank" rel="noopener noreferrer" title="Open PDF"></a></div><div id="breadcrumbs" class="breadcrumb"><a href="https://aws.amazon.com">AWS</a><a href="/index.html">Documentation</a><a href="/amazon-mq/index.html">Amazon MQ</a><a href="welcome.html">REST API Reference</a></div><div id="page-toc-src"><a href="#brokers-broker-id-url">URI</a><a href="#brokers-broker-id-http-methods">HTTP methods</a><a href="#brokers-broker-id-schemas">Schemas</a><a href="#brokers-broker-id-properties">Properties</a><a href="#brokers-broker-id-see-also">See also</a></div><div id="main-content" class="awsui-util-container"><div id="main-col-body"><awsdocs-language-banner data-service="$ctrl.pageService"></awsdocs-language-banner><h1 class="topictitle" id="brokers-broker-id">Broker</h1><div class="awsdocs-page-header-container"><awsdocs-page-header></awsdocs-page-header><awsdocs-filter-selector id="awsdocs-filter-selector"></awsdocs-filter-selector></div><p>A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. For more information about the different components of an Amazon MQ broker, see <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-how-it-works.html">How Amazon MQ works</a> in the <em>Amazon MQ Developer Guide</em>.</p><h2 id="brokers-broker-id-url">URI</h2><p><code class="code">/v1/brokers/<code class="replaceable">broker-id</code></code></p><h2 id="brokers-broker-id-http-methods">HTTP methods</h2><h3 id="brokers-broker-idget" xreflabel="DescribeBroker">GET</h3><p><b>Operation ID:</b> <code class="code">DescribeBroker</code></p><p>Returns information about the specified broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b1b3"><caption>Path parameters</caption><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="replaceable">broker-id</code></td><td tabindex="-1">String</td><td tabindex="-1">True</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr></table></div></div><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b1b4"><caption>Responses</caption><thead><tr><th>Status code</th><th>Response model</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="code">200</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-describebrokeroutput-example"> DescribeBrokerOutput</a></code></td><td tabindex="-1"><p>HTTP Status Code 200: OK.</p></td></tr><tr><td tabindex="-1"><code class="code">400</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">403</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p></td></tr><tr><td tabindex="-1"><code class="code">404</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">500</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p></td></tr></table></div></div><h3 id="brokers-broker-idput" xreflabel="UpdateBroker">PUT</h3><p><b>Operation ID:</b> <code class="code">UpdateBroker</code></p><p>Adds a pending configuration change to a broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b2b3"><caption>Path parameters</caption><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="replaceable">broker-id</code></td><td tabindex="-1">String</td><td tabindex="-1">True</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr></table></div></div><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b2b4"><caption>Responses</caption><thead><tr><th>Status code</th><th>Response model</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="code">200</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-updatebrokeroutput-example"> UpdateBrokerOutput</a></code></td><td tabindex="-1"><p>HTTP Status Code 200: OK.</p></td></tr><tr><td tabindex="-1"><code class="code">400</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">403</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p></td></tr><tr><td tabindex="-1"><code class="code">404</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">409</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.</p></td></tr><tr><td tabindex="-1"><code class="code">500</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p></td></tr></table></div></div><h3 id="brokers-broker-iddelete" xreflabel="DeleteBroker">DELETE</h3><p><b>Operation ID:</b> <code class="code">DeleteBroker</code></p><p>Deletes a broker. Note: This API is asynchronous.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b3b3"><caption>Path parameters</caption><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="replaceable">broker-id</code></td><td tabindex="-1">String</td><td tabindex="-1">True</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr></table></div></div><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b3b4"><caption>Responses</caption><thead><tr><th>Status code</th><th>Response model</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="code">200</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-deletebrokeroutput-example"> DeleteBrokerOutput</a></code></td><td tabindex="-1"><p>HTTP Status Code 200: OK.</p></td></tr><tr><td tabindex="-1"><code class="code">400</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">403</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p></td></tr><tr><td tabindex="-1"><code class="code">404</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p></td></tr><tr><td tabindex="-1"><code class="code">500</code></td><td tabindex="-1"><code class="code"><a href="#brokers-broker-id-response-body-error-example">Error</a></code></td><td tabindex="-1"><p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p></td></tr></table></div></div><h3 id="brokers-broker-idoptions">OPTIONS</h3><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b4b1"><caption>Path parameters</caption><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="replaceable">broker-id</code></td><td tabindex="-1">String</td><td tabindex="-1">True</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr></table></div></div><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b3b4b2"><caption>Responses</caption><thead><tr><th>Status code</th><th>Response model</th><th>Description</th></tr></thead><tr><td tabindex="-1"><code class="code">200</code></td><td tabindex="-1">None</td><td tabindex="-1"><p>Default response for CORS method</p></td></tr></table></div></div><h2 id="brokers-broker-id-schemas">Schemas</h2><h3 id="brokers-broker-id-request-examples">Request bodies</h3><div class="collapsible" data-expand-section="brokers-broker-id-request-body-put-example"><awsui-expandable-section variant="container" header="PUT schema" id="brokers-broker-id-request-body-put-example" expanded="true"><pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><code class="json "><span>{</span> "<a href="#brokers-broker-id-prop-updatebrokerinput-datareplicationmode">dataReplicationMode</a>": enum, "<a href="#brokers-broker-id-prop-updatebrokerinput-engineversion">engineVersion</a>": "string", "<a href="#brokers-broker-id-prop-updatebrokerinput-maintenancewindowstarttime">maintenanceWindowStartTime</a>": <span>{</span> "<a href="#brokers-broker-id-prop-weeklystarttime-dayofweek">dayOfWeek</a>": enum, "<a href="#brokers-broker-id-prop-weeklystarttime-timezone">timeZone</a>": "string", "<a href="#brokers-broker-id-prop-weeklystarttime-timeofday">timeOfDay</a>": "string" }, "<a href="#brokers-broker-id-prop-updatebrokerinput-configuration">configuration</a>": <span>{</span> "<a href="#brokers-broker-id-prop-configurationid-id">id</a>": "string", "<a href="#brokers-broker-id-prop-configurationid-revision">revision</a>": integer }, "<a href="#brokers-broker-id-prop-updatebrokerinput-authenticationstrategy">authenticationStrategy</a>": enum, "<a href="#brokers-broker-id-prop-updatebrokerinput-securitygroups">securityGroups</a>": [ "string" ], "<a href="#brokers-broker-id-prop-updatebrokerinput-ldapservermetadata">ldapServerMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-ldapservermetadatainput-rolesearchmatching">roleSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-serviceaccountpassword">serviceAccountPassword</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-rolebase">roleBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-hosts">hosts</a>": [ "string" ], "<a href="#brokers-broker-id-prop-ldapservermetadatainput-rolename">roleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-userbase">userBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-rolesearchsubtree">roleSearchSubtree</a>": boolean, "<a href="#brokers-broker-id-prop-ldapservermetadatainput-serviceaccountusername">serviceAccountUsername</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-userrolename">userRoleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-usersearchmatching">userSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadatainput-usersearchsubtree">userSearchSubtree</a>": boolean }, "<a href="#brokers-broker-id-prop-updatebrokerinput-logs">logs</a>": <span>{</span> "<a href="#brokers-broker-id-prop-logs-general">general</a>": boolean, "<a href="#brokers-broker-id-prop-logs-audit">audit</a>": boolean }, "<a href="#brokers-broker-id-prop-updatebrokerinput-hostinstancetype">hostInstanceType</a>": "string", "<a href="#brokers-broker-id-prop-updatebrokerinput-autominorversionupgrade">autoMinorVersionUpgrade</a>": boolean }</code></pre></awsui-expandable-section></div><h3 id="brokers-broker-id-response-examples">Response bodies</h3><div class="collapsible" data-expand-section="brokers-broker-id-response-body-describebrokeroutput-example"><awsui-expandable-section variant="container" header="
 
 DescribeBrokerOutput schema" id="brokers-broker-id-response-body-describebrokeroutput-example" expanded="true"><pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><code class="json "><span>{</span> "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingengineversion">pendingEngineVersion</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingauthenticationstrategy">pendingAuthenticationStrategy</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingsecuritygroups">pendingSecurityGroups</a>": [ "string" ], "<a href="#brokers-broker-id-prop-describebrokeroutput-configurations">configurations</a>": <span>{</span> "<a href="#brokers-broker-id-prop-configurations-current">current</a>": <span>{</span> "<a href="#brokers-broker-id-prop-configurationid-id">id</a>": "string", "<a href="#brokers-broker-id-prop-configurationid-revision">revision</a>": integer }, "<a href="#brokers-broker-id-prop-configurations-pending">pending</a>": <span>{</span> "<a href="#brokers-broker-id-prop-configurationid-id">id</a>": "string", "<a href="#brokers-broker-id-prop-configurationid-revision">revision</a>": integer }, "<a href="#brokers-broker-id-prop-configurations-history">history</a>": [ <span>{</span> "<a href="#brokers-broker-id-prop-configurationid-id">id</a>": "string", "<a href="#brokers-broker-id-prop-configurationid-revision">revision</a>": integer } ] }, "<a href="#brokers-broker-id-prop-describebrokeroutput-brokerstate">brokerState</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingdatareplicationmode">pendingDataReplicationMode</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-enginetype">engineType</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-brokerinstances">brokerInstances</a>": [ <span>{</span> "<a href="#brokers-broker-id-prop-brokerinstance-endpoints">endpoints</a>": [ "string" ], "<a href="#brokers-broker-id-prop-brokerinstance-consoleurl">consoleURL</a>": "string", "<a href="#brokers-broker-id-prop-brokerinstance-ipaddress">ipAddress</a>": "string" } ], "<a href="#brokers-broker-id-prop-describebrokeroutput-hostinstancetype">hostInstanceType</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-datareplicationmode">dataReplicationMode</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-publiclyaccessible">publiclyAccessible</a>": boolean, "<a href="#brokers-broker-id-prop-describebrokeroutput-logs">logs</a>": <span>{</span> "<a href="#brokers-broker-id-prop-logssummary-generalloggroup">generalLogGroup</a>": "string", "<a href="#brokers-broker-id-prop-logssummary-general">general</a>": boolean, "<a href="#brokers-broker-id-prop-logssummary-audit">audit</a>": boolean, "<a href="#brokers-broker-id-prop-logssummary-pending">pending</a>": <span>{</span> "<a href="#brokers-broker-id-prop-pendinglogs-general">general</a>": boolean, "<a href="#brokers-broker-id-prop-pendinglogs-audit">audit</a>": boolean }, "<a href="#brokers-broker-id-prop-logssummary-auditloggroup">auditLogGroup</a>": "string" }, "<a href="#brokers-broker-id-prop-describebrokeroutput-ldapservermetadata">ldapServerMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchmatching">roleSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolebase">roleBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-hosts">hosts</a>": [ "string" ], "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolename">roleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userbase">userBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchsubtree">roleSearchSubtree</a>": boolean, "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-serviceaccountusername">serviceAccountUsername</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userrolename">userRoleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchmatching">userSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchsubtree">userSearchSubtree</a>": boolean }, "<a href="#brokers-broker-id-prop-describebrokeroutput-subnetids">subnetIds</a>": [ "string" ], "<a href="#brokers-broker-id-prop-describebrokeroutput-pendinghostinstancetype">pendingHostInstanceType</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-engineversion">engineVersion</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-brokerarn">brokerArn</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-deploymentmode">deploymentMode</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-maintenancewindowstarttime">maintenanceWindowStartTime</a>": <span>{</span> "<a href="#brokers-broker-id-prop-weeklystarttime-dayofweek">dayOfWeek</a>": enum, "<a href="#brokers-broker-id-prop-weeklystarttime-timezone">timeZone</a>": "string", "<a href="#brokers-broker-id-prop-weeklystarttime-timeofday">timeOfDay</a>": "string" }, "<a href="#brokers-broker-id-prop-describebrokeroutput-created">created</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-authenticationstrategy">authenticationStrategy</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-users">users</a>": [ <span>{</span> "<a href="#brokers-broker-id-prop-usersummary-pendingchange">pendingChange</a>": enum, "<a href="#brokers-broker-id-prop-usersummary-username">username</a>": "string" } ], "<a href="#brokers-broker-id-prop-describebrokeroutput-tags">tags</a>": <span>{</span> }, "<a href="#brokers-broker-id-prop-describebrokeroutput-datareplicationmetadata">dataReplicationMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationcounterpart">dataReplicationCounterpart</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationcounterpart-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-datareplicationcounterpart-region">region</a>": "string" }, "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationrole">dataReplicationRole</a>": "string" }, "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingldapservermetadata">pendingLdapServerMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchmatching">roleSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolebase">roleBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-hosts">hosts</a>": [ "string" ], "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolename">roleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userbase">userBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchsubtree">roleSearchSubtree</a>": boolean, "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-serviceaccountusername">serviceAccountUsername</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userrolename">userRoleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchmatching">userSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchsubtree">userSearchSubtree</a>": boolean }, "<a href="#brokers-broker-id-prop-describebrokeroutput-encryptionoptions">encryptionOptions</a>": <span>{</span> "<a href="#brokers-broker-id-prop-encryptionoptions-useawsownedkey">useAwsOwnedKey</a>": boolean, "<a href="#brokers-broker-id-prop-encryptionoptions-kmskeyid">kmsKeyId</a>": "string" }, "<a href="#brokers-broker-id-prop-describebrokeroutput-pendingdatareplicationmetadata">pendingDataReplicationMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationcounterpart">dataReplicationCounterpart</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationcounterpart-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-datareplicationcounterpart-region">region</a>": "string" }, "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationrole">dataReplicationRole</a>": "string" }, "<a href="#brokers-broker-id-prop-describebrokeroutput-storagetype">storageType</a>": enum, "<a href="#brokers-broker-id-prop-describebrokeroutput-actionsrequired">actionsRequired</a>": [ <span>{</span> "<a href="#brokers-broker-id-prop-actionrequired-actionrequiredcode">actionRequiredCode</a>": "string", "<a href="#brokers-broker-id-prop-actionrequired-actionrequiredinfo">actionRequiredInfo</a>": "string" } ], "<a href="#brokers-broker-id-prop-describebrokeroutput-securitygroups">securityGroups</a>": [ "string" ], "<a href="#brokers-broker-id-prop-describebrokeroutput-brokername">brokerName</a>": "string", "<a href="#brokers-broker-id-prop-describebrokeroutput-autominorversionupgrade">autoMinorVersionUpgrade</a>": boolean }</code></pre></awsui-expandable-section></div><div class="collapsible" data-expand-section="brokers-broker-id-response-body-updatebrokeroutput-example"><awsui-expandable-section variant="container" header="
 
 UpdateBrokerOutput schema" id="brokers-broker-id-response-body-updatebrokeroutput-example" expanded="true"><pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><code class="json "><span>{</span> "<a href="#brokers-broker-id-prop-updatebrokeroutput-engineversion">engineVersion</a>": "string", "<a href="#brokers-broker-id-prop-updatebrokeroutput-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-updatebrokeroutput-maintenancewindowstarttime">maintenanceWindowStartTime</a>": <span>{</span> "<a href="#brokers-broker-id-prop-weeklystarttime-dayofweek">dayOfWeek</a>": enum, "<a href="#brokers-broker-id-prop-weeklystarttime-timezone">timeZone</a>": "string", "<a href="#brokers-broker-id-prop-weeklystarttime-timeofday">timeOfDay</a>": "string" }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-configuration">configuration</a>": <span>{</span> "<a href="#brokers-broker-id-prop-configurationid-id">id</a>": "string", "<a href="#brokers-broker-id-prop-configurationid-revision">revision</a>": integer }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-authenticationstrategy">authenticationStrategy</a>": enum, "<a href="#brokers-broker-id-prop-updatebrokeroutput-pendingdatareplicationmode">pendingDataReplicationMode</a>": enum, "<a href="#brokers-broker-id-prop-updatebrokeroutput-hostinstancetype">hostInstanceType</a>": "string", "<a href="#brokers-broker-id-prop-updatebrokeroutput-datareplicationmode">dataReplicationMode</a>": enum, "<a href="#brokers-broker-id-prop-updatebrokeroutput-datareplicationmetadata">dataReplicationMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationcounterpart">dataReplicationCounterpart</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationcounterpart-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-datareplicationcounterpart-region">region</a>": "string" }, "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationrole">dataReplicationRole</a>": "string" }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-pendingdatareplicationmetadata">pendingDataReplicationMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationcounterpart">dataReplicationCounterpart</a>": <span>{</span> "<a href="#brokers-broker-id-prop-datareplicationcounterpart-brokerid">brokerId</a>": "string", "<a href="#brokers-broker-id-prop-datareplicationcounterpart-region">region</a>": "string" }, "<a href="#brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationrole">dataReplicationRole</a>": "string" }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-securitygroups">securityGroups</a>": [ "string" ], "<a href="#brokers-broker-id-prop-updatebrokeroutput-ldapservermetadata">ldapServerMetadata</a>": <span>{</span> "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchmatching">roleSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolebase">roleBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-hosts">hosts</a>": [ "string" ], "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolename">roleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userbase">userBase</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-rolesearchsubtree">roleSearchSubtree</a>": boolean, "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-serviceaccountusername">serviceAccountUsername</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-userrolename">userRoleName</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchmatching">userSearchMatching</a>": "string", "<a href="#brokers-broker-id-prop-ldapservermetadataoutput-usersearchsubtree">userSearchSubtree</a>": boolean }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-logs">logs</a>": <span>{</span> "<a href="#brokers-broker-id-prop-logs-general">general</a>": boolean, "<a href="#brokers-broker-id-prop-logs-audit">audit</a>": boolean }, "<a href="#brokers-broker-id-prop-updatebrokeroutput-autominorversionupgrade">autoMinorVersionUpgrade</a>": boolean }</code></pre></awsui-expandable-section></div><div class="collapsible" data-expand-section="brokers-broker-id-response-body-deletebrokeroutput-example"><awsui-expandable-section variant="container" header="
 
 DeleteBrokerOutput schema" id="brokers-broker-id-response-body-deletebrokeroutput-example" expanded="true"><pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><code class="json "><span>{</span> "<a href="#brokers-broker-id-prop-deletebrokeroutput-brokerid">brokerId</a>": "string" }</code></pre></awsui-expandable-section></div><div class="collapsible" data-expand-section="brokers-broker-id-response-body-error-example"><awsui-expandable-section variant="container" header="Error schema" id="brokers-broker-id-response-body-error-example" expanded="true"><pre class="programlisting"><div class="code-btn-container"><div class="btn-copy-code" title="Copy"><awsui-icon name="copy"></awsui-icon></div></div><code class="json "><span>{</span> "<a href="#brokers-broker-id-prop-error-errorattribute">errorAttribute</a>": "string", "<a href="#brokers-broker-id-prop-error-message">message</a>": "string" }</code></pre></awsui-expandable-section></div><h2 id="brokers-broker-id-properties">Properties</h2><h3 id="brokers-broker-id-model-actionrequired">ActionRequired</h3><p>Action required for a broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5b1b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-actionrequired-actionrequiredcode" xreflabel="actionRequiredCode"><code class="code">actionRequiredCode</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The code you can use to find instructions on the action required to resolve your broker issue.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-actionrequired-actionrequiredinfo" xreflabel="actionRequiredInfo"><code class="code">actionRequiredInfo</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Information about the action required to resolve your broker issue.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-authenticationstrategy">AuthenticationStrategy</h3><p>Optional. The authentication strategy used to secure the broker. The default is <code class="code">SIMPLE</code>.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">SIMPLE</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">LDAP</code></p></li></ul></div><h3 id="brokers-broker-id-model-brokerinstance">BrokerInstance</h3><p>Returns information about all brokers.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5b3b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-brokerinstance-consoleurl" xreflabel="consoleURL"><code class="code">consoleURL</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The brokers web console URL.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-brokerinstance-endpoints" xreflabel="endpoints"><code class="code">endpoints</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's wire-level protocol endpoints.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-brokerinstance-ipaddress" xreflabel="ipAddress"><code class="code">ipAddress</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-brokerstate">BrokerState</h3><p>The broker's status.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">CREATION_IN_PROGRESS</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">CREATION_FAILED</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">DELETION_IN_PROGRESS</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">RUNNING</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">REBOOT_IN_PROGRESS</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">CRITICAL_ACTION_REQUIRED</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">REPLICA</code></p></li></ul></div><h3 id="brokers-broker-id-model-brokerstoragetype">BrokerStorageType</h3><p>The broker's storage type.</p><div class="awsdocs-note awsdocs-important"><div class="awsdocs-note-title"><awsui-icon name="status-warning" variant="error"></awsui-icon><h6>Important</h6></div><div class="awsdocs-note-text"><p> <code class="code">EFS</code> is not supported for RabbitMQ engine type.</p></div></div><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">EBS</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">EFS</code></p></li></ul></div><h3 id="brokers-broker-id-model-changetype">ChangeType</h3><p>The type of change pending for the ActiveMQ user.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">CREATE</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">UPDATE</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">DELETE</code></p></li></ul></div><h3 id="brokers-broker-id-model-configurationid">ConfigurationId</h3><p>A list of information about the configuration.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5b7b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-configurationid-id" xreflabel="id"><code class="code">id</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The unique ID that Amazon MQ generates for the configuration.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-configurationid-revision" xreflabel="revision"><code class="code">revision</code></td><td tabindex="-1"><p>integer</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The revision number of the configuration.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-configurations">Configurations</h3><p>Broker configuration information</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5b8b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-configurations-current" xreflabel="current"><code class="code">current</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-configurationid">ConfigurationId</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's current configuration.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-configurations-history" xreflabel="history"><code class="code">history</code></td><td tabindex="-1"><p>Array of type ConfigurationId</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The history of configurations applied to the broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-configurations-pending" xreflabel="pending"><code class="code">pending</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-configurationid">ConfigurationId</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's pending configuration.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-datareplicationcounterpart">DataReplicationCounterpart</h3><p>Specifies a broker in a data replication pair.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5b9b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-datareplicationcounterpart-brokerid" xreflabel="brokerId"><code class="code">brokerId</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The unique broker id generated by Amazon MQ.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-datareplicationcounterpart-region" xreflabel="region"><code class="code">region</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The region of the broker.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-datareplicationmetadataoutput">DataReplicationMetadataOutput</h3><p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c10b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationcounterpart" xreflabel="dataReplicationCounterpart"><code class="code">dataReplicationCounterpart</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationcounterpart">DataReplicationCounterpart</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-datareplicationmetadataoutput-datareplicationrole" xreflabel="dataReplicationRole"><code class="code">dataReplicationRole</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-datareplicationmode">DataReplicationMode</h3><p>Specifies whether a broker is a part of a data replication pair.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">NONE</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">CRDR</code></p></li></ul></div><h3 id="brokers-broker-id-model-deletebrokeroutput">DeleteBrokerOutput</h3><p>Returns information about the deleted broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c12b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-deletebrokeroutput-brokerid" xreflabel="brokerId"><code class="code">brokerId</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-deploymentmode">DeploymentMode</h3><p>The broker's deployment mode.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">SINGLE_INSTANCE</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">ACTIVE_STANDBY_MULTI_AZ</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">CLUSTER_MULTI_AZ</code></p></li></ul></div><h3 id="brokers-broker-id-model-describebrokeroutput">DescribeBrokerOutput</h3><p>Returns information about the specified broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c14b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-actionsrequired" xreflabel="actionsRequired"><code class="code">actionsRequired</code></td><td tabindex="-1"><p>Array of type ActionRequired</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Actions required for a broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-authenticationstrategy" xreflabel="authenticationStrategy"><code class="code">authenticationStrategy</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-authenticationstrategy">AuthenticationStrategy</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The authentication strategy used to secure the broker. The default is <code class="code">SIMPLE</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-autominorversionupgrade" xreflabel="autoMinorVersionUpgrade"><code class="code">autoMinorVersionUpgrade</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-brokerarn" xreflabel="brokerArn"><code class="code">brokerArn</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's Amazon Resource Name (ARN).</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-brokerid" xreflabel="brokerId"><code class="code">brokerId</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The unique ID that Amazon MQ generates for the broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-brokerinstances" xreflabel="brokerInstances"><code class="code">brokerInstances</code></td><td tabindex="-1"><p>Array of type BrokerInstance</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>A list of information about allocated brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-brokername" xreflabel="brokerName"><code class="code">brokerName</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's name. This value must be unique in your AWS account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-brokerstate" xreflabel="brokerState"><code class="code">brokerState</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-brokerstate">BrokerState</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's status.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-configurations" xreflabel="configurations"><code class="code">configurations</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-configurations">Configurations</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of all revisions for the specified configuration.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-created" xreflabel="created"><code class="code">created</code></td><td tabindex="-1"><p>string</p><p><span>Format</span>: date-time</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The time when the broker was created.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-datareplicationmetadata" xreflabel="dataReplicationMetadata"><code class="code">dataReplicationMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmetadataoutput">DataReplicationMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-datareplicationmode" xreflabel="dataReplicationMode"><code class="code">dataReplicationMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmode">DataReplicationMode</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Describes whether this broker is a part of a data replication pair.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-deploymentmode" xreflabel="deploymentMode"><code class="code">deploymentMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-deploymentmode">DeploymentMode</a></p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The broker's deployment mode.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-encryptionoptions" xreflabel="encryptionOptions"><code class="code">encryptionOptions</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-encryptionoptions">EncryptionOptions</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Encryption options for the broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-enginetype" xreflabel="engineType"><code class="code">engineType</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-enginetype">EngineType</a></p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The type of broker engine. Currently, Amazon MQ supports <code class="code">ACTIVEMQ</code> and <code class="code">RABBITMQ</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-engineversion" xreflabel="engineVersion"><code class="code">engineVersion</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-hostinstancetype" xreflabel="hostInstanceType"><code class="code">hostInstanceType</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's instance type.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-ldapservermetadata" xreflabel="ldapServerMetadata"><code class="code">ldapServerMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-ldapservermetadataoutput">LdapServerMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The metadata of the LDAP server used to authenticate and authorize connections to the broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-logs" xreflabel="logs"><code class="code">logs</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-logssummary">LogsSummary</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of information about logs currently enabled and pending to be deployed for the specified broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-maintenancewindowstarttime" xreflabel="maintenanceWindowStartTime"><code class="code">maintenanceWindowStartTime</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-weeklystarttime">WeeklyStartTime</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The parameters that determine the WeeklyStartTime.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingauthenticationstrategy" xreflabel="pendingAuthenticationStrategy"><code class="code">pendingAuthenticationStrategy</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-authenticationstrategy">AuthenticationStrategy</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The authentication strategy that will be applied when the broker is rebooted. The default is <code class="code">SIMPLE</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingdatareplicationmetadata" xreflabel="pendingDataReplicationMetadata"><code class="code">pendingDataReplicationMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmetadataoutput">DataReplicationMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingdatareplicationmode" xreflabel="pendingDataReplicationMode"><code class="code">pendingDataReplicationMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmode">DataReplicationMode</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Describes whether this broker will be a part of a data replication pair after reboot.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingengineversion" xreflabel="pendingEngineVersion"><code class="code">pendingEngineVersion</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker engine version to upgrade to. For more information, see the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendinghostinstancetype" xreflabel="pendingHostInstanceType"><code class="code">pendingHostInstanceType</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>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>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingldapservermetadata" xreflabel="pendingLdapServerMetadata"><code class="code">pendingLdapServerMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-ldapservermetadataoutput">LdapServerMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-pendingsecuritygroups" xreflabel="pendingSecurityGroups"><code class="code">pendingSecurityGroups</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of pending security groups to authorize connections to brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-publiclyaccessible" xreflabel="publiclyAccessible"><code class="code">publiclyAccessible</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Enables connections from applications outside of the VPC that hosts the broker's subnets.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-securitygroups" xreflabel="securityGroups"><code class="code">securityGroups</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-storagetype" xreflabel="storageType"><code class="code">storageType</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-brokerstoragetype">BrokerStorageType</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker's storage type.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-subnetids" xreflabel="subnetIds"><code class="code">subnetIds</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-tags" xreflabel="tags"><code class="code">tags</code></td><td tabindex="-1"><p>object</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of all tags associated with this broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-describebrokeroutput-users" xreflabel="users"><code class="code">users</code></td><td tabindex="-1"><p>Array of type UserSummary</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of all broker usernames for the specified broker.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-encryptionoptions">EncryptionOptions</h3><p>Encryption options for the broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c15b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-encryptionoptions-kmskeyid" xreflabel="kmsKeyId"><code class="code">kmsKeyId</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The customer master key (CMK) to use for the A AWS KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-encryptionoptions-useawsownedkey" xreflabel="useAwsOwnedKey"><code class="code">useAwsOwnedKey</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to <code class="code">true</code> by default, if no value is provided, for example, for RabbitMQ brokers.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-enginetype">EngineType</h3><p>The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem" style="list-style-type: none"><p><code class="code">ACTIVEMQ</code></p></li><li class="listitem" style="list-style-type: none"><p><code class="code">RABBITMQ</code></p></li></ul></div><h3 id="brokers-broker-id-model-error">Error</h3><p>Returns information about an error.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c17b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-error-errorattribute" xreflabel="errorAttribute"><code class="code">errorAttribute</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The attribute which caused the error.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-error-message" xreflabel="message"><code class="code">message</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The explanation of the error.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-ldapservermetadatainput">LdapServerMetadataInput</h3><p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.</p><div class="awsdocs-note awsdocs-important"><div class="awsdocs-note-title"><awsui-icon name="status-warning" variant="error"></awsui-icon><h6>Important</h6></div><div class="awsdocs-note-text"><p>Does not apply to RabbitMQ brokers.</p></div></div><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c18b3a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-hosts" xreflabel="hosts"><code class="code">hosts</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. Optional failover server.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-rolebase" xreflabel="roleBase"><code class="code">roleBase</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, <code class="code">ou=group, ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-rolename" xreflabel="roleName"><code class="code">roleName</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-rolesearchmatching" xreflabel="roleSearchMatching"><code class="code">roleSearchMatching</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The LDAP search filter used to find roles within the <code class="code">roleBase</code>. The distinguished name of the user matched by <code class="code">userSearchMatching</code> is substituted into the <code class="code"><span>{</span>0}</code> placeholder in the search filter. The client's username is substituted into the <code class="code"><span>{</span>1}</code> placeholder. For example, if you set this option to <code class="code">(member=uid=<span>{</span>1})</code>for the user <code class="code">janedoe</code>, the search filter becomes <code class="code">(member=uid=janedoe)</code> after string substitution. It matches all role entries that have a member attribute equal to <code class="code">uid=janedoe</code> under the subtree selected by the <code class="code">roleBase</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-rolesearchsubtree" xreflabel="roleSearchSubtree"><code class="code">roleSearchSubtree</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The directory search scope for the role. If set to true, scope is to search the entire subtree.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-serviceaccountpassword" xreflabel="serviceAccountPassword"><code class="code">serviceAccountPassword</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, <code class="code">cn=admin,dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-serviceaccountusername" xreflabel="serviceAccountUsername"><code class="code">serviceAccountUsername</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, <code class="code">cn=admin,dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-userbase" xreflabel="userBase"><code class="code">userBase</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to <code class="code">ou=Users,ou=corp, dc=corp, dc=example, dc=com</code>, the search for user entries is restricted to the subtree beneath <code class="code">ou=Users, ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-userrolename" xreflabel="userRoleName"><code class="code">userRoleName</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Specifies the name of the LDAP attribute for the user group membership.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-usersearchmatching" xreflabel="userSearchMatching"><code class="code">userSearchMatching</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The LDAP search filter used to find users within the <code class="code">userBase</code>. The client's username is substituted into the <code class="code"><span>{</span>0}</code> placeholder in the search filter. For example, if this option is set to <code class="code">(uid=<span>{</span>0})</code> and the received username is <code class="code">janedoe</code>, the search filter becomes <code class="code">(uid=janedoe)</code> after string substitution. It will result in matching an entry like <code class="code">uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadatainput-usersearchsubtree" xreflabel="userSearchSubtree"><code class="code">userSearchSubtree</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The directory search scope for the user. If set to true, scope is to search the entire subtree.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-ldapservermetadataoutput">LdapServerMetadataOutput</h3><p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c19b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-hosts" xreflabel="hosts"><code class="code">hosts</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. Optional failover server.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-rolebase" xreflabel="roleBase"><code class="code">roleBase</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, <code class="code">ou=group, ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-rolename" xreflabel="roleName"><code class="code">roleName</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-rolesearchmatching" xreflabel="roleSearchMatching"><code class="code">roleSearchMatching</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The LDAP search filter used to find roles within the <code class="code">roleBase</code>. The distinguished name of the user matched by <code class="code">userSearchMatching</code> is substituted into the <code class="code"><span>{</span>0}</code> placeholder in the search filter. The client's username is substituted into the <code class="code"><span>{</span>1}</code> placeholder. For example, if you set this option to <code class="code">(member=uid=<span>{</span>1})</code>for the user <code class="code">janedoe</code>, the search filter becomes <code class="code">(member=uid=janedoe)</code> after string substitution. It matches all role entries that have a member attribute equal to <code class="code">uid=janedoe</code> under the subtree selected by the <code class="code">roleBase</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-rolesearchsubtree" xreflabel="roleSearchSubtree"><code class="code">roleSearchSubtree</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The directory search scope for the role. If set to true, scope is to search the entire subtree.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-serviceaccountusername" xreflabel="serviceAccountUsername"><code class="code">serviceAccountUsername</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, <code class="code">cn=admin,dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-userbase" xreflabel="userBase"><code class="code">userBase</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to <code class="code">ou=Users,ou=corp, dc=corp, dc=example, dc=com</code>, the search for user entries is restricted to the subtree beneath <code class="code">ou=Users, ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-userrolename" xreflabel="userRoleName"><code class="code">userRoleName</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Specifies the name of the LDAP attribute for the user group membership.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-usersearchmatching" xreflabel="userSearchMatching"><code class="code">userSearchMatching</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The LDAP search filter used to find users within the <code class="code">userBase</code>. The client's username is substituted into the <code class="code"><span>{</span>0}</code> placeholder in the search filter. For example, if this option is set to <code class="code">(uid=<span>{</span>0})</code> and the received username is <code class="code">janedoe</code>, the search filter becomes <code class="code">(uid=janedoe)</code> after string substitution. It will result in matching an entry like <code class="code">uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-ldapservermetadataoutput-usersearchsubtree" xreflabel="userSearchSubtree"><code class="code">userSearchSubtree</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The directory search scope for the user. If set to true, scope is to search the entire subtree.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-logs">Logs</h3><p>The list of information about logs to be enabled for the specified broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c20b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-logs-audit" xreflabel="audit"><code class="code">audit</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-logs-general" xreflabel="general"><code class="code">general</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables general logging.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-logssummary">LogsSummary</h3><p>The list of information about logs currently enabled and pending to be deployed for the specified broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c21b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-logssummary-audit" xreflabel="audit"><code class="code">audit</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-logssummary-auditloggroup" xreflabel="auditLogGroup"><code class="code">auditLogGroup</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The location of the CloudWatch Logs log group where audit logs are sent.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-logssummary-general" xreflabel="general"><code class="code">general</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Enables general logging.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-logssummary-generalloggroup" xreflabel="generalLogGroup"><code class="code">generalLogGroup</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>The location of the CloudWatch Logs log group where general logs are sent.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-logssummary-pending" xreflabel="pending"><code class="code">pending</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-pendinglogs">PendingLogs</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of information about logs pending to be deployed for the specified broker.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-pendinglogs">PendingLogs</h3><p>The list of information about logs to be enabled for the specified broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c22b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-pendinglogs-audit" xreflabel="audit"><code class="code">audit</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-pendinglogs-general" xreflabel="general"><code class="code">general</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables general logging.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-updatebrokerinput">UpdateBrokerInput</h3><p>Updates the broker using the specified properties.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c23b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-authenticationstrategy" xreflabel="authenticationStrategy"><code class="code">authenticationStrategy</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-authenticationstrategy">AuthenticationStrategy</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Optional. The authentication strategy used to secure the broker. The default is <code class="code">SIMPLE</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-autominorversionupgrade" xreflabel="autoMinorVersionUpgrade"><code class="code">autoMinorVersionUpgrade</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p><div class="awsdocs-note"><div class="awsdocs-note-title"><awsui-icon name="status-info" variant="link"></awsui-icon><h6>Note</h6></div><div class="awsdocs-note-text"><p>Must be set to <code class="code">true</code> for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p></div></div></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-configuration" xreflabel="configuration"><code class="code">configuration</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-configurationid">ConfigurationId</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>A list of information about the configuration.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-datareplicationmode" xreflabel="dataReplicationMode"><code class="code">dataReplicationMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmode">DataReplicationMode</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Defines whether this broker is a part of a data replication pair.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-engineversion" xreflabel="engineVersion"><code class="code">engineVersion</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p><div class="awsdocs-note"><div class="awsdocs-note-title"><awsui-icon name="status-info" variant="link"></awsui-icon><h6>Note</h6></div><div class="awsdocs-note-text"><p>When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have <code class="code">autoMinorVersionUpgrade</code> set to <code class="code">true</code> for the broker.</p></div></div></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-hostinstancetype" xreflabel="hostInstanceType"><code class="code">hostInstanceType</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>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>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-ldapservermetadata" xreflabel="ldapServerMetadata"><code class="code">ldapServerMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-ldapservermetadatainput">LdapServerMetadataInput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-logs" xreflabel="logs"><code class="code">logs</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-logs">Logs</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables Amazon CloudWatch logging for brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-maintenancewindowstarttime" xreflabel="maintenanceWindowStartTime"><code class="code">maintenanceWindowStartTime</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-weeklystarttime">WeeklyStartTime</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The parameters that determine the WeeklyStartTime.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokerinput-securitygroups" xreflabel="securityGroups"><code class="code">securityGroups</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-updatebrokeroutput">UpdateBrokerOutput</h3><p>Returns information about the updated broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c24b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-authenticationstrategy" xreflabel="authenticationStrategy"><code class="code">authenticationStrategy</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-authenticationstrategy">AuthenticationStrategy</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Optional. The authentication strategy used to secure the broker. The default is <code class="code">SIMPLE</code>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-autominorversionupgrade" xreflabel="autoMinorVersionUpgrade"><code class="code">autoMinorVersionUpgrade</code></td><td tabindex="-1"><p>boolean</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-brokerid" xreflabel="brokerId"><code class="code">brokerId</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The unique ID that Amazon MQ generates for the broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-configuration" xreflabel="configuration"><code class="code">configuration</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-configurationid">ConfigurationId</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The ID of the updated configuration.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-datareplicationmetadata" xreflabel="dataReplicationMetadata"><code class="code">dataReplicationMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmetadataoutput">DataReplicationMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-datareplicationmode" xreflabel="dataReplicationMode"><code class="code">dataReplicationMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmode">DataReplicationMode</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Describes whether this broker is a part of a data replication pair.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-engineversion" xreflabel="engineVersion"><code class="code">engineVersion</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The broker engine version to upgrade to. For more information, see the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-hostinstancetype" xreflabel="hostInstanceType"><code class="code">hostInstanceType</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>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>.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-ldapservermetadata" xreflabel="ldapServerMetadata"><code class="code">ldapServerMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-ldapservermetadataoutput">LdapServerMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-logs" xreflabel="logs"><code class="code">logs</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-logs">Logs</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of information about logs to be enabled for the specified broker.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-maintenancewindowstarttime" xreflabel="maintenanceWindowStartTime"><code class="code">maintenanceWindowStartTime</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-weeklystarttime">WeeklyStartTime</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The parameters that determine the WeeklyStartTime.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-pendingdatareplicationmetadata" xreflabel="pendingDataReplicationMetadata"><code class="code">pendingDataReplicationMetadata</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmetadataoutput">DataReplicationMetadataOutput</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-pendingdatareplicationmode" xreflabel="pendingDataReplicationMode"><code class="code">pendingDataReplicationMode</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-datareplicationmode">DataReplicationMode</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>Describes whether this broker will be a part of a data replication pair after reboot.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-updatebrokeroutput-securitygroups" xreflabel="securityGroups"><code class="code">securityGroups</code></td><td tabindex="-1"><p>Array of type string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-usersummary">UserSummary</h3><p>Returns a list of all broker users. Does not apply to RabbitMQ brokers.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c25b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-usersummary-pendingchange" xreflabel="pendingChange"><code class="code">pendingChange</code></td><td tabindex="-1"><p><a href="#brokers-broker-id-model-changetype">ChangeType</a></p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The type of change pending for the broker user.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-usersummary-username" xreflabel="username"><code class="code">username</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p></td></tr></table></div></div><h3 id="brokers-broker-id-model-weeklystarttime">WeeklyStartTime</h3><p>The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.</p><div class="table-container"><div class="table-contents disable-scroll"><table id="w107aab3b3b5c26b2a"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tr><td tabindex="-1" id="brokers-broker-id-prop-weeklystarttime-dayofweek" xreflabel="dayOfWeek"><code class="code">dayOfWeek</code></td><td tabindex="-1"><p>string</p><p><span>Values</span>: <code class="code">MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY</code></p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The day of the week.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-weeklystarttime-timeofday" xreflabel="timeOfDay"><code class="code">timeOfDay</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">True</td><td tabindex="-1"><p>Required. The time, in 24-hour format.</p></td></tr><tr><td tabindex="-1" id="brokers-broker-id-prop-weeklystarttime-timezone" xreflabel="timeZone"><code class="code">timeZone</code></td><td tabindex="-1"><p>string</p></td><td tabindex="-1">False</td><td tabindex="-1"><p>The time zone, UTC by default, in either the Country/City format, or the UTC offset format.</p></td></tr></table></div></div><h2 id="brokers-broker-id-see-also">See also</h2><p>For more information about using this API in one of the language-specific AWS SDKs and references, see the following:</p><h3 id="DescribeBroker-see-also">DescribeBroker</h3><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"><p><a href="/goto/aws-cli/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS Command Line Interface</a></p></li><li class="listitem"><p><a href="/goto/DotNetSDKV3/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for .NET</a></p></li><li class="listitem"><p><a href="/goto/SdkForCpp/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for C++</a></p></li><li class="listitem"><p><a href="/goto/SdkForGoV2/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Go v2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaV2/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Java V2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaScriptV3/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for JavaScript V3</a></p></li><li class="listitem"><p><a href="/goto/SdkForPHPV3/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for PHP V3</a></p></li><li class="listitem"><p><a href="/goto/boto3/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Python</a></p></li><li class="listitem"><p><a href="/goto/SdkForRubyV3/mq-2017-11-27/DescribeBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Ruby V3</a></p></li></ul></div><h3 id="UpdateBroker-see-also">UpdateBroker</h3><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"><p><a href="/goto/aws-cli/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS Command Line Interface</a></p></li><li class="listitem"><p><a href="/goto/DotNetSDKV3/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for .NET</a></p></li><li class="listitem"><p><a href="/goto/SdkForCpp/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for C++</a></p></li><li class="listitem"><p><a href="/goto/SdkForGoV2/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Go v2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaV2/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Java V2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaScriptV3/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for JavaScript V3</a></p></li><li class="listitem"><p><a href="/goto/SdkForPHPV3/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for PHP V3</a></p></li><li class="listitem"><p><a href="/goto/boto3/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Python</a></p></li><li class="listitem"><p><a href="/goto/SdkForRubyV3/mq-2017-11-27/UpdateBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Ruby V3</a></p></li></ul></div><h3 id="DeleteBroker-see-also">DeleteBroker</h3><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"><p><a href="/goto/aws-cli/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS Command Line Interface</a></p></li><li class="listitem"><p><a href="/goto/DotNetSDKV3/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for .NET</a></p></li><li class="listitem"><p><a href="/goto/SdkForCpp/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for C++</a></p></li><li class="listitem"><p><a href="/goto/SdkForGoV2/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Go v2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaV2/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Java V2</a></p></li><li class="listitem"><p><a href="/goto/SdkForJavaScriptV3/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for JavaScript V3</a></p></li><li class="listitem"><p><a href="/goto/SdkForPHPV3/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for PHP V3</a></p></li><li class="listitem"><p><a href="/goto/boto3/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Python</a></p></li><li class="listitem"><p><a href="/goto/SdkForRubyV3/mq-2017-11-27/DeleteBroker" rel="noopener noreferrer" target="_blank">AWS SDK for Ruby V3</a></p></li></ul></div><awsdocs-copyright class="copyright-print"></awsdocs-copyright><awsdocs-thumb-feedback right-edge="{{$ctrl.thumbFeedbackRightEdge}}"></awsdocs-thumb-feedback></div><noscript><div><div><div><div id="js_error_message"><p><img src="https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png" alt="Warning" /> <strong>Javascript is disabled or is unavailable in your browser.</strong></p><p>To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.</p></div></div></div></div></noscript><div id="main-col-footer" class="awsui-util-font-size-0"><div id="doc-conventions"><a target="_top" href="/general/latest/gr/docconventions.html">Document Conventions</a></div><div class="prev-next"><div id="previous" class="prev-link" accesskey="p" href="./resources.html">Resources</div><div id="next" class="next-link" accesskey="n" href="./broker-engine-types.html">Broker Engine Types</div></div></div><awsdocs-page-utilities></awsdocs-page-utilities></div><div id="quick-feedback-yes" style="display: none;"><div class="title">Did this page help you? - Yes</div><div class="content"><p>Thanks for letting us know we're doing a good job!</p><p>If you've got a moment, please tell us what we did right so we can do more of it.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=AMQ&topic_url=https://docs.aws.amazon.com/en_us/amazon-mq/latest/api-reference/brokers-broker-id.html"></awsui-button></p></div></div><div id="quick-feedback-no" style="display: none;"><div class="title">Did this page help you? - No</div><div class="content"><p>Thanks for letting us know this page needs work. We're sorry we let you down.</p><p>If you've got a moment, please tell us how we can make the documentation better.</p><p><awsui-button id="fblink" rel="noopener noreferrer" target="_blank" text="Feedback" click="linkClick($event)" href="https://docs.aws.amazon.com/forms/aws-doc-feedback?hidden_service_name=AMQ&topic_url=https://docs.aws.amazon.com/en_us/amazon-mq/latest/api-reference/brokers-broker-id.html"></awsui-button></p></div></div></div></body></div></awsdocs-view><div class="page-loading-indicator" id="page-loading-indicator"><awsui-spinner size="large"></awsui-spinner></div></div><div id="tools-panel" dom-region="tools"><awsdocs-tools-panel id="awsdocs-tools-panel"></awsdocs-tools-panel></div></awsui-app-layout><awsdocs-cookie-banner class="doc-cookie-banner"></awsdocs-cookie-banner></div></body></html>