Add section to aws devel guidelines about module_defaults (ansible#66699

)
raphaelm · Jan 23, 2020 · ac881b0 · ac881b0
1 parent 72fbed2
commit ac881b0
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst b/docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
@@ -153,6 +153,18 @@ or:
        if not HAS_BOTO3:
            module.fail_json(msg='boto3 and botocore are required for this module')
 
+Supporting Module Defaults
+--------------------------
+
+The existing AWS modules support using :ref:`module_defaults <module_defaults>` for common 
+authentication parameters.  To do the same for your new module, add an entry for it in
+``lib/ansible/config/module_defaults.yml``.  These entries take the form of:
+
+.. code-block:: yaml
+
+  aws_module_name:
+  - aws
+
 Connecting to AWS
 =================