[PR #1888/f65eb5a1 backport][stable-7] feat: add wait and wait_timeout to mq_broker; closes #1879

[patchback]

This is a backport of PR #1888 as merged into main (f65eb5a).

SUMMARY

add wait and wait_timeout to wait for broker desired state. This will be used instead of polling for broker desired state though a separate module, broker_info.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

mq_broker

ADDITIONAL INFORMATION

  wait:
    description:
      - Specifies whether the module waits for the desired C(state).
    type: bool
  wait_timeout:
    description:
      - How long to wait (in seconds) for the broker to reach the desired state.
    default: 900
    type: int

[github-actions]

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run:
https://github.com/ansible-collections/community.aws/actions/runs/7460252079

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/community.aws/branch/main

File changes:

• M collections/community/aws/mq_broker_module.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/mq_broker_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/mq_broker_module.html
index 23ed555..14aa94d 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/mq_broker_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/mq_broker_module.html
@@ -525,6 +525,29 @@ see <a class="reference internal" href="#ansible-collections-community-aws-mq-br
 </ul>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-wait"></div><p class="ansible-option-title" id="ansible-collections-community-aws-mq-broker-module-parameter-wait"><strong>wait</strong></p>
+<a class="ansibleOptionLink" href="#parameter-wait" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
+<p><em class="ansible-option-versionadded">added in community.aws 7.1.0</em></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>Specifies whether the module waits for the desired <code class="docutils literal notranslate"><span class="pre">state</span></code>.</p>
+<p>The time to wait can be controlled by setting <em>wait_timeout</em>.</p>
+<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
+<ul class="simple">
+<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-aws-mq-broker-module-parameter-wait-timeout"><strong>wait_timeout</strong></p>
+<a class="ansibleOptionLink" href="#parameter-wait_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
+<p><em class="ansible-option-versionadded">added in community.aws 7.1.0</em></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>How long to wait (in seconds) for the broker to reach the desired state if <em>wait=true</em>.</p>
+<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">900</span></code></p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/bac537eb484e4b91a869440d977dee07

✔️ ansible-galaxy-importer SUCCESS in 4m 37s (non-voting)
✔️ build-ansible-collection SUCCESS in 14m 39s
✔️ ansible-test-splitter SUCCESS in 6m 19s
✔️ integration-community.aws-1 SUCCESS in 6m 18s
Skipped 21 jobs

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/13e228f18ce2497bb127843a1b8e0dcd

✔️ ansible-galaxy-importer SUCCESS in 4m 24s (non-voting)
✔️ build-ansible-collection SUCCESS in 15m 19s
✔️ ansible-test-splitter SUCCESS in 5m 20s
✔️ integration-community.aws-1 SUCCESS in 8m 47s
Skipped 21 jobs