mirror of https://github.com/ansible/ansible.git
Moved AWS modules over to common module fragments
Created common module doc fragment, and applied to all modules that use ec2_connect or connect_to_aws as they definitely share the common doc fragmentspull/6913/head
willthames
11 years ago
committed by
Will Thames
parent
5ce6c86595
commit
509561f658
@ -0,0 +1,76 @@
|
|||||||
|
# (c) 2014, Will Thames <will@thames.id.au>
|
||||||
|
#
|
||||||
|
# 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 <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
class ModuleDocFragment(object):
|
||||||
|
|
||||||
|
# AWS only documentation fragment
|
||||||
|
DOCUMENTATION = """
|
||||||
|
options:
|
||||||
|
ec2_url:
|
||||||
|
description:
|
||||||
|
- Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Must be specified if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
aliases: []
|
||||||
|
aws_secret_key:
|
||||||
|
description:
|
||||||
|
- AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
aliases: [ 'ec2_secret_key', 'secret_key' ]
|
||||||
|
aws_access_key:
|
||||||
|
description:
|
||||||
|
- AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
aliases: [ 'ec2_access_key', 'access_key' ]
|
||||||
|
validate_certs:
|
||||||
|
description:
|
||||||
|
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
||||||
|
required: false
|
||||||
|
default: "yes"
|
||||||
|
choices: ["yes", "no"]
|
||||||
|
aliases: []
|
||||||
|
version_added: "1.5"
|
||||||
|
profile:
|
||||||
|
description:
|
||||||
|
- uses a boto profile. Only works with boto >= 2.24.0
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
aliases: []
|
||||||
|
version_added: "1.6"
|
||||||
|
security_token:
|
||||||
|
description:
|
||||||
|
- security token to authenticate against AWS
|
||||||
|
required: false
|
||||||
|
default: null
|
||||||
|
aliases: []
|
||||||
|
version_added: "1.6"
|
||||||
|
requirements:
|
||||||
|
- boto
|
||||||
|
notes:
|
||||||
|
- The following environment variables can be used C(AWS_ACCESS_KEY) or
|
||||||
|
C(EC2_ACCESS_KEY) or C(AWS_ACCESS_KEY_ID),
|
||||||
|
C(AWS_SECRET_KEY) or C(EC2_SECRET_KEY) or C(AWS_SECRET_ACCESS_KEY),
|
||||||
|
C(AWS_REGION) or C(EC2_REGION), C(AWS_SECURITY_TOKEN)
|
||||||
|
- Ansible uses the boto configuration file (typically ~/.boto) if no
|
||||||
|
credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
|
||||||
|
- C(AWS_REGION) or C(EC2_REGION) can be typically be used to specify the
|
||||||
|
AWS region, when required, but
|
||||||
|
this can also be configured in the boto config file
|
||||||
|
"""
|
||||||
Loading…
Reference in New Issue