Update aws_ec2 documentation for the use_ssm_inventory option (#1586) (…

…#1590) [PR #1586/463d5880 backport][stable-6] Update aws_ec2 documentation for the use_ssm_inventory option This is a backport of PR #1586 as merged into main (463d588). SUMMARY Update aws_ec2 documentation for the use_ssm_inventory option Might fix #1461 ISSUE TYPE Docs Pull Request COMPONENT NAME aws_ec2 Reviewed-by: Alina Buzachis
ansible-collections · Jun 5, 2023 · 5ff9190 · 5ff9190
1 parent 58d381c
commit 5ff9190
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml b/changelogs/fragments/20230531-aws_ec2-use_ssm_inventory_documentation.yml
@@ -0,0 +1,2 @@
+trivial:
+  - "Update the ``aws_ec2`` inventory plugins documentation for the ``use_ssm_inventory`` option."
diff --git a/docs/docsite/rst/aws_ec2_guide.rst b/docs/docsite/rst/aws_ec2_guide.rst
@@ -484,7 +484,9 @@ Now the output of ``ansible-inventory -i demo.aws_ec2.yml --list``:
 ``use_ssm_inventory``
 ---------------------
 
-``use_ssm_inventory: True`` will include SSM inventory variables into hostvars for ssm-configured instances.
+``use_ssm_inventory: True`` enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars. By leveraging the SSM inventory data, the ``use_ssm_inventory`` option provides additional details and attributes about the EC2 instances in your inventory.
+These details can include operating system information, installed software, network configurations, and custom inventory attributes defined in SSM.
+
 
 ``cache``
 ---------

diff --git a/plugins/inventory/aws_ec2.py b/plugins/inventory/aws_ec2.py
@@ -138,7 +138,10 @@
     version_added: 3.1.0
   use_ssm_inventory:
     description:
-      - Add SSM inventory information into hostvars.
+      - Enables fetching additional EC2 instance information from the AWS Systems Manager (SSM) inventory service into hostvars.
+      - By leveraging the SSM inventory data, the I(use_ssm_inventory) option provides additional details and attributes
+        about the EC2 instances in your inventory. These details can include operating system information, installed software,
+        network configurations, and custom inventory attributes defined in SSM.
     type: bool
     default: False
     version_added: 6.0.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		trivial:
		- "Update the ``aws_ec2`` inventory plugins documentation for the ``use_ssm_inventory`` option."