From c77733e64eade7d1764c23142305c99ad21b4143 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Wed, 7 Oct 2015 15:52:06 -0400 Subject: [PATCH] added docs for commonly used region parameter in some ec2 modules --- .../utils/module_docs_fragments/ec2.py | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 lib/ansible/utils/module_docs_fragments/ec2.py diff --git a/lib/ansible/utils/module_docs_fragments/ec2.py b/lib/ansible/utils/module_docs_fragments/ec2.py new file mode 100644 index 0000000000..3681c0ea8d --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/ec2.py @@ -0,0 +1,29 @@ +# (c) 2015, Ansible, Inc +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + + +class ModuleDocFragment(object): + + # EC2 only documentation fragment + DOCUMENTATION = """ +options: + region: + description: + - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) + required: false + aliases: [ 'aws_region', 'ec2_region' ] +"""