Convert from dos line endings to unix because dos line endings break our documentation build.

reviewable/pr18780/r1
Toshio Kuratomi 9 years ago
parent fdb4a58f97
commit 8ce3104bc5

@ -1,156 +1,156 @@
#!/usr/bin/python #!/usr/bin/python
# This file is part of Ansible # This file is part of Ansible
# #
# Ansible is free software: you can redistribute it and/or modify # Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by # it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or # the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version. # (at your option) any later version.
# #
# Ansible is distributed in the hope that it will be useful, # Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of # but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details. # GNU General Public License for more details.
# #
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>. # along with Ansible. If not, see <http://www.gnu.org/licenses/>.
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: sts_assume_role module: sts_assume_role
short_description: Assume a role using AWS Security Token Service and obtain temporary credentials short_description: Assume a role using AWS Security Token Service and obtain temporary credentials
description: description:
- Assume a role using AWS Security Token Service and obtain temporary credentials - Assume a role using AWS Security Token Service and obtain temporary credentials
version_added: "2.0" version_added: "2.0"
author: Boris Ekelchik (@bekelchik) author: Boris Ekelchik (@bekelchik)
options: options:
role_arn: role_arn:
description: description:
- The Amazon Resource Name (ARN) of the role that the caller is assuming (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs) - The Amazon Resource Name (ARN) of the role that the caller is assuming (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs)
required: true required: true
role_session_name: role_session_name:
description: description:
- Name of the role's session - will be used by CloudTrail - Name of the role's session - will be used by CloudTrail
required: true required: true
policy: policy:
description: description:
- Supplemental policy to use in addition to assumed role's policies. - Supplemental policy to use in addition to assumed role's policies.
required: false required: false
default: null default: null
duration_seconds: duration_seconds:
description: description:
- The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. - The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
required: false required: false
default: null default: null
external_id: external_id:
description: description:
- A unique identifier that is used by third parties to assume a role in their customers' accounts. - A unique identifier that is used by third parties to assume a role in their customers' accounts.
required: false required: false
default: null default: null
mfa_serial_number: mfa_serial_number:
description: description:
- he identification number of the MFA device that is associated with the user who is making the AssumeRole call. - he identification number of the MFA device that is associated with the user who is making the AssumeRole call.
required: false required: false
default: null default: null
mfa_token: mfa_token:
description: description:
- The value provided by the MFA device, if the trust policy of the role being assumed requires MFA. - The value provided by the MFA device, if the trust policy of the role being assumed requires MFA.
required: false required: false
default: null default: null
notes: notes:
- In order to use the assumed role in a following playbook task you must pass the access_key, access_secret and access_token - In order to use the assumed role in a following playbook task you must pass the access_key, access_secret and access_token
extends_documentation_fragment: extends_documentation_fragment:
- aws - aws
- ec2 - ec2
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Note: These examples do not set authentication details, see the AWS Guide for details. # Note: These examples do not set authentication details, see the AWS Guide for details.
# Assume an existing role (more details: http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) # Assume an existing role (more details: http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
sts_assume_role: sts_assume_role:
role_arn: "arn:aws:iam::123456789012:role/someRole" role_arn: "arn:aws:iam::123456789012:role/someRole"
session_name: "someRoleSession" session_name: "someRoleSession"
register: assumed_role register: assumed_role
# Use the assumed role above to tag an instance in account 123456789012 # Use the assumed role above to tag an instance in account 123456789012
ec2_tag: ec2_tag:
aws_access_key: "{{ assumed_role.sts_creds.access_key }}" aws_access_key: "{{ assumed_role.sts_creds.access_key }}"
aws_secret_key: "{{ assumed_role.sts_creds.secret_key }}" aws_secret_key: "{{ assumed_role.sts_creds.secret_key }}"
security_token: "{{ assumed_role.sts_creds.session_token }}" security_token: "{{ assumed_role.sts_creds.session_token }}"
resource: i-xyzxyz01 resource: i-xyzxyz01
state: present state: present
tags: tags:
MyNewTag: value MyNewTag: value
''' '''
import sys import sys
import time import time
try: try:
import boto.sts import boto.sts
from boto.exception import BotoServerError from boto.exception import BotoServerError
HAS_BOTO = True HAS_BOTO = True
except ImportError: except ImportError:
HAS_BOTO = False HAS_BOTO = False
def assume_role_policy(connection, module): def assume_role_policy(connection, module):
role_arn = module.params.get('role_arn') role_arn = module.params.get('role_arn')
role_session_name = module.params.get('role_session_name') role_session_name = module.params.get('role_session_name')
policy = module.params.get('policy') policy = module.params.get('policy')
duration_seconds = module.params.get('duration_seconds') duration_seconds = module.params.get('duration_seconds')
external_id = module.params.get('external_id') external_id = module.params.get('external_id')
mfa_serial_number = module.params.get('mfa_serial_number') mfa_serial_number = module.params.get('mfa_serial_number')
mfa_token = module.params.get('mfa_token') mfa_token = module.params.get('mfa_token')
changed = False changed = False
try: try:
assumed_role = connection.assume_role(role_arn, role_session_name, policy, duration_seconds, external_id, mfa_serial_number, mfa_token) assumed_role = connection.assume_role(role_arn, role_session_name, policy, duration_seconds, external_id, mfa_serial_number, mfa_token)
changed = True changed = True
except BotoServerError, e: except BotoServerError, e:
module.fail_json(msg=e) module.fail_json(msg=e)
module.exit_json(changed=changed, sts_creds=assumed_role.credentials.__dict__, sts_user=assumed_role.user.__dict__) module.exit_json(changed=changed, sts_creds=assumed_role.credentials.__dict__, sts_user=assumed_role.user.__dict__)
def main(): def main():
argument_spec = ec2_argument_spec() argument_spec = ec2_argument_spec()
argument_spec.update( argument_spec.update(
dict( dict(
role_arn = dict(required=True, default=None), role_arn = dict(required=True, default=None),
role_session_name = dict(required=True, default=None), role_session_name = dict(required=True, default=None),
duration_seconds = dict(required=False, default=None, type='int'), duration_seconds = dict(required=False, default=None, type='int'),
external_id = dict(required=False, default=None), external_id = dict(required=False, default=None),
policy = dict(required=False, default=None), policy = dict(required=False, default=None),
mfa_serial_number = dict(required=False, default=None), mfa_serial_number = dict(required=False, default=None),
mfa_token = dict(required=False, default=None) mfa_token = dict(required=False, default=None)
) )
) )
module = AnsibleModule(argument_spec=argument_spec) module = AnsibleModule(argument_spec=argument_spec)
if not HAS_BOTO: if not HAS_BOTO:
module.fail_json(msg='boto required for this module') module.fail_json(msg='boto required for this module')
region, ec2_url, aws_connect_params = get_aws_connection_info(module) region, ec2_url, aws_connect_params = get_aws_connection_info(module)
if region: if region:
try: try:
connection = connect_to_aws(boto.sts, region, **aws_connect_params) connection = connect_to_aws(boto.sts, region, **aws_connect_params)
except (boto.exception.NoAuthHandlerFound, StandardError), e: except (boto.exception.NoAuthHandlerFound, StandardError), e:
module.fail_json(msg=str(e)) module.fail_json(msg=str(e))
else: else:
module.fail_json(msg="region must be specified") module.fail_json(msg="region must be specified")
try: try:
assume_role_policy(connection, module) assume_role_policy(connection, module)
except BotoServerError, e: except BotoServerError, e:
module.fail_json(msg=e) module.fail_json(msg=e)
# import module snippets # import module snippets
from ansible.module_utils.basic import * from ansible.module_utils.basic import *
from ansible.module_utils.ec2 import * from ansible.module_utils.ec2 import *
main() main()

Loading…
Cancel
Save