Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DNM] rds_instance_pram_group_info: add new module rds_instance_pram_group_info #2372

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mandar242
Copy link
Contributor

SUMMARY

Adding a new module for retrieving parameter group info.
Can get info for

  • a specific RDS parameter group
  • the parameter group associated with a specified RDS instance
  • all parameter groups available in the current region.

Resolves #2313

ISSUE TYPE
  • New Module Pull Request
COMPONENT NAME

rds_instance_pram_group_info

ADDITIONAL INFORMATION

Created basic module, waiting on confirmation to move forward with adding tests, etc.

Copy link

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/amazon.aws/actions/runs/11600302044

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

File changes:

  • A collections/amazon/aws/rds_instance_param_group_info_module.html
  • M collections/amazon/aws/index.html
  • M collections/amazon/aws/rds_instance_param_group_module.html
  • M collections/amazon/aws/rds_instance_snapshot_module.html
  • M collections/index_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/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
index e892a3d..525b86a 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
@@ -337,6 +337,7 @@
 <li><p><a class="reference internal" href="rds_instance_module.html#ansible-collections-amazon-aws-rds-instance-module"><span class="std std-ref">rds_instance module</span></a> – Manage RDS instances</p></li>
 <li><p><a class="reference internal" href="rds_instance_info_module.html#ansible-collections-amazon-aws-rds-instance-info-module"><span class="std std-ref">rds_instance_info module</span></a> – obtain information about one or more RDS instances</p></li>
 <li><p><a class="reference internal" href="rds_instance_param_group_module.html#ansible-collections-amazon-aws-rds-instance-param-group-module"><span class="std std-ref">rds_instance_param_group module</span></a> – manage RDS parameter groups</p></li>
+<li><p><a class="reference internal" href="rds_instance_param_group_info_module.html#ansible-collections-amazon-aws-rds-instance-param-group-info-module"><span class="std std-ref">rds_instance_param_group_info module</span></a> – Describes the RDS parameter group.</p></li>
 <li><p><a class="reference internal" href="rds_instance_snapshot_module.html#ansible-collections-amazon-aws-rds-instance-snapshot-module"><span class="std std-ref">rds_instance_snapshot module</span></a> – Manage Amazon RDS instance snapshots</p></li>
 <li><p><a class="reference internal" href="rds_option_group_module.html#ansible-collections-amazon-aws-rds-option-group-module"><span class="std std-ref">rds_option_group module</span></a> – Manages the creation, modification, deletion of RDS option groups</p></li>
 <li><p><a class="reference internal" href="rds_option_group_info_module.html#ansible-collections-amazon-aws-rds-option-group-info-module"><span class="std std-ref">rds_option_group_info module</span></a> – rds_option_group_info module</p></li>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/rds_instance_param_group_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/rds_instance_param_group_module.html
index 050ff21..3e72493 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/rds_instance_param_group_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/rds_instance_param_group_module.html
@@ -22,7 +22,7 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="amazon.aws.rds_instance_snapshot module – Manage Amazon RDS instance snapshots" href="rds_instance_snapshot_module.html" />
+    <link rel="next" title="amazon.aws.rds_instance_param_group_info module – Describes the RDS parameter group." href="rds_instance_param_group_info_module.html" />
     <link rel="prev" title="amazon.aws.rds_instance_info module – obtain information about one or more RDS instances" href="rds_instance_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
@@ -521,7 +521,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-rds-inst
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="rds_instance_info_module.html" class="btn btn-neutral float-left" title="amazon.aws.rds_instance_info module – obtain information about one or more RDS instances" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="rds_instance_snapshot_module.html" class="btn btn-neutral float-right" title="amazon.aws.rds_instance_snapshot module – Manage Amazon RDS instance snapshots" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="rds_instance_param_group_info_module.html" class="btn btn-neutral float-right" title="amazon.aws.rds_instance_param_group_info module – Describes the RDS parameter group." accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/rds_instance_snapshot_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/rds_instance_snapshot_module.html
index 5fe1b57..8eccdc2 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/rds_instance_snapshot_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/rds_instance_snapshot_module.html
@@ -23,7 +23,7 @@
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="amazon.aws.rds_option_group module – Manages the creation, modification, deletion of RDS option groups" href="rds_option_group_module.html" />
-    <link rel="prev" title="amazon.aws.rds_instance_param_group module – manage RDS parameter groups" href="rds_instance_param_group_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+    <link rel="prev" title="amazon.aws.rds_instance_param_group_info module – Describes the RDS parameter group." href="rds_instance_param_group_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
 
@@ -718,7 +718,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-rds-inst
           
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="rds_instance_param_group_module.html" class="btn btn-neutral float-left" title="amazon.aws.rds_instance_param_group module – manage RDS parameter groups" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="rds_instance_param_group_info_module.html" class="btn btn-neutral float-left" title="amazon.aws.rds_instance_param_group_info module – Describes the RDS parameter group." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="rds_option_group_module.html" class="btn btn-neutral float-right" title="amazon.aws.rds_option_group module – Manages the creation, modification, deletion of RDS option groups" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/index_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/index_module.html
index 5f47b80..95acf94 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/index_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/index_module.html
@@ -245,6 +245,7 @@
 <li><p><a class="reference internal" href="amazon/aws/rds_instance_module.html#ansible-collections-amazon-aws-rds-instance-module"><span class="std std-ref">amazon.aws.rds_instance</span></a> – Manage RDS instances</p></li>
 <li><p><a class="reference internal" href="amazon/aws/rds_instance_info_module.html#ansible-collections-amazon-aws-rds-instance-info-module"><span class="std std-ref">amazon.aws.rds_instance_info</span></a> – obtain information about one or more RDS instances</p></li>
 <li><p><a class="reference internal" href="amazon/aws/rds_instance_param_group_module.html#ansible-collections-amazon-aws-rds-instance-param-group-module"><span class="std std-ref">amazon.aws.rds_instance_param_group</span></a> – manage RDS parameter groups</p></li>
+<li><p><a class="reference internal" href="amazon/aws/rds_instance_param_group_info_module.html#ansible-collections-amazon-aws-rds-instance-param-group-info-module"><span class="std std-ref">amazon.aws.rds_instance_param_group_info</span></a> – Describes the RDS parameter group.</p></li>
 <li><p><a class="reference internal" href="amazon/aws/rds_instance_snapshot_module.html#ansible-collections-amazon-aws-rds-instance-snapshot-module"><span class="std std-ref">amazon.aws.rds_instance_snapshot</span></a> – Manage Amazon RDS instance snapshots</p></li>
 <li><p><a class="reference internal" href="amazon/aws/rds_option_group_module.html#ansible-collections-amazon-aws-rds-option-group-module"><span class="std std-ref">amazon.aws.rds_option_group</span></a> – Manages the creation, modification, deletion of RDS option groups</p></li>
 <li><p><a class="reference internal" href="amazon/aws/rds_option_group_info_module.html#ansible-collections-amazon-aws-rds-option-group-info-module"><span class="std std-ref">amazon.aws.rds_option_group_info</span></a> – rds_option_group_info module</p></li>

Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 5m 59s
✔️ build-ansible-collection SUCCESS in 10m 10s
✔️ ansible-test-splitter SUCCESS in 3m 52s
Skipped 44 jobs

@GomathiselviS
Copy link
Collaborator

Can you add tests to validate this module?

@mandar242
Copy link
Contributor Author

mandar242 commented Nov 1, 2024

Can you add tests to validate this module?

@GomathiselviS just wanted to know thoughts on whether the approach taken for module looks good or not before moving ahead with adding tests. Specifically the way module will work.
related https://redhat-internal.slack.com/archives/CGUMLTNLS/p1730471070036829

EXAMPLES = r"""
- name: Get specific DB instance's parameter group info
  amazon.aws.rds_instance_param_group_info:
    db_instance_identifier: database-1

- name: Get specific DB parameter group's info
  amazon.aws.rds_instance_param_group_info:
    db_parameter_group_name: my-test-pg

- name: Get all parameter group info from the region
  amazon.aws.rds_instance_param_group_info:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add module rds_instance_param_group_info
2 participants