Adds tagging option to elasticache module

[stefanhorning]

trafficstars

SUMMARY

Adds AWS resource tagging option to elasticache module.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

elasticache module

[github-actions[bot]]

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/6576002589

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/elasticache_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/elasticache_module.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/elasticache_module.html
index 32214ea..df59e0b 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/elasticache_module.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/elasticache_module.html
@@ -342,6 +342,20 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 </div></td>
 </tr>
 <tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-purge_tags"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-purge-tags"><strong>purge_tags</strong></p>
+<a class="ansibleOptionLink" href="#parameter-purge_tags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>If <em>purge_tags=true</em> and <em>tags</em> is set, existing tags will be purged from the resource to match exactly what is defined by <em>tags</em> parameter.</p>
+<p>If the <em>tags</em> parameter is not set then tags will not be modified, even if <em>purge_tags=True</em>.</p>
+<p>Tag keys beginning with <code class="docutils literal notranslate"><span class="pre">aws:</span></code> are reserved by Amazon and can not be modified.  As such they will be ignored for the purposes of the <em>purge_tags</em> parameter.  See the Amazon documentation for more information <a class="reference external" href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions</a>.</p>
+<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
+<ul class="simple">
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
+<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-region"></div>
 <div class="ansibleOptionAnchor" id="parameter-aws_region"></div>
 <div class="ansibleOptionAnchor" id="parameter-ec2_region"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-region"><span id="ansible-collections-community-aws-elasticache-module-parameter-ec2-region"></span><span id="ansible-collections-community-aws-elasticache-module-parameter-aws-region"></span><strong>region</strong></p>
@@ -356,7 +370,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 <p>Support for the <code class="docutils literal notranslate"><span class="pre">EC2_REGION</span></code> environment variable has been deprecated and will be removed in a release after 2024-12-01.</p>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-secret_key"></div>
 <div class="ansibleOptionAnchor" id="parameter-aws_secret_access_key"></div>
 <div class="ansibleOptionAnchor" id="parameter-aws_secret_key"></div>
@@ -373,7 +387,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 <p>Support for the <code class="docutils literal notranslate"><span class="pre">EC2_SECRET_KEY</span></code> environment variable has been deprecated and will be removed in a release after 2024-12-01.</p>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-security_group_ids"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-security-group-ids"><strong>security_group_ids</strong></p>
 <a class="ansibleOptionLink" href="#parameter-security_group_ids" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
 </div></td>
@@ -381,7 +395,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
 </div></td>
 </tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-session_token"></div>
 <div class="ansibleOptionAnchor" id="parameter-aws_session_token"></div>
 <div class="ansibleOptionAnchor" id="parameter-security_token"></div>
@@ -399,7 +413,7 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 <p>Support for the <code class="docutils literal notranslate"><span class="pre">EC2_SECRET_KEY</span></code> and <code class="docutils literal notranslate"><span class="pre">AWS_SECURITY_TOKEN</span></code> environment variables has been deprecated and will be removed in a release after 2024-12-01.</p>
 </div></td>
 </tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-state"><strong>state</strong></p>
 <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
 </div></td>
@@ -413,6 +427,15 @@ see <a class="reference internal" href="#ansible-collections-community-aws-elast
 </ul>
 </div></td>
 </tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-tags"></div>
+<div class="ansibleOptionAnchor" id="parameter-resource_tags"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-tags"><span id="ansible-collections-community-aws-elasticache-module-parameter-resource-tags"></span><strong>tags</strong></p>
+<a class="ansibleOptionLink" href="#parameter-tags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: resource_tags</span></p>
+<p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>A dictionary of tags to apply when creating an Elasticache instance.</p>
+</div></td>
+</tr>
 <tr class="row-odd"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div><p class="ansible-option-title" id="ansible-collections-community-aws-elasticache-module-parameter-validate-certs"><strong>validate_certs</strong></p>
 <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>

[softwarefactory-project-zuul[bot]]

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

:x: ansible-galaxy-importer FAILURE in 5m 44s (non-voting) :heavy_check_mark: build-ansible-collection SUCCESS in 13m 01s :heavy_check_mark: ansible-test-splitter SUCCESS in 4m 54s :heavy_check_mark: integration-community.aws-1 SUCCESS in 9m 27s Skipped 21 jobs

[softwarefactory-project-zuul[bot]]

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

:x: ansible-galaxy-importer FAILURE in 4m 39s (non-voting) :heavy_check_mark: build-ansible-collection SUCCESS in 12m 27s :heavy_check_mark: ansible-test-splitter SUCCESS in 4m 44s :heavy_check_mark: integration-community.aws-1 SUCCESS in 7m 26s Skipped 21 jobs

[tremble]

@stefanhorning

FYI it should now be possible to use tox -m lint to run the formatting linters and tox -m format to automatically format code before you push.

[softwarefactory-project-zuul[bot]]

Build failed. https://ansible.softwarefactory-project.io/zuul/buildset/e56d8a275b0a4e5b9fe9083a1a9625ff

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 01s (non-voting) :heavy_check_mark: build-ansible-collection SUCCESS in 13m 25s :heavy_check_mark: ansible-test-splitter SUCCESS in 4m 49s :x: integration-community.aws-1 RETRY_LIMIT in 1m 42s Skipped 21 jobs

[stefanhorning]

Anything I still need to do? All builds are green, but some didn't run due to a timeout(?), so should I somehow restart it?