Add documentation for the use of strings with compose (#1283)

Add documentation for the use of strings with compose SUMMARY Documentation for the use of strings with compose is documented in https://docs.ansible.com/ansible/latest/plugins/inventory.html#using-inventory-plugins. However, in the module, it is not well documented. This documentation and example provides documentation in the module docs. Related to #570 ISSUE TYPE Docs Pull Request COMPONENT NAME aws_ec2 inventory Reviewed-by: Gonéri Le Bouder <[email protected]> Reviewed-by: Mark Chappell <None>
ansible-collections · Dec 1, 2022 · e823f89 · e823f89
1 parent d73b9e4
commit e823f89
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/changelogs/fragments/1283-aws_ec2_inventory_compose_doc_examples.yml b/changelogs/fragments/1283-aws_ec2_inventory_compose_doc_examples.yml
@@ -0,0 +1,2 @@
+trivial:
+- Add documentation for using string with compose feature in ec2 dynamic inventory.
diff --git a/docs/docsite/rst/aws_ec2_guide.rst b/docs/docsite/rst/aws_ec2_guide.rst
@@ -275,6 +275,11 @@ Some examples are shown below:
     # This sets the ec2_security_group_ids variable.
     ec2_security_group_ids: security_groups | map(attribute='group_id') | list |  join(',')
 
+    # Host variables that are strings need to be wrapped with two sets of quotes.
+    # See https://docs.ansible.com/ansible/latest/plugins/inventory.html#using-inventory-plugins for details.
+    ansible_connection: '"community.aws.aws_ssm"'
+    ansible_user: '"ssm-user"'
+
 
 ``include_filters`` and ``exclude_filters``
 -------------------------------------------