Skip to content

Commit

Permalink
Docs: sanity fixes (ansible-collections#133)
Browse files Browse the repository at this point in the history
Signed-off-by: Abhijeet Kasurde <[email protected]>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@059cf9e
  • Loading branch information
Akasurde authored and alinabuzachis committed Oct 6, 2023
1 parent 927b3c7 commit 1fd6420
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions plugins/modules/iam_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: iam_role
version_added: 1.0.0
Expand Down Expand Up @@ -49,6 +49,7 @@
- To embed an inline policy, use M(community.aws.iam_policy).
aliases: ['managed_policy']
type: list
elements: str
max_session_duration:
description:
- The maximum duration (in seconds) of a session when assuming the role.
Expand Down Expand Up @@ -95,7 +96,7 @@
'''

EXAMPLES = '''
EXAMPLES = r'''
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create a role with description and tags
Expand Down Expand Up @@ -126,7 +127,7 @@
state: absent
'''
RETURN = '''
RETURN = r'''
iam_role:
description: dictionary containing the IAM Role data
returned: success
Expand Down Expand Up @@ -613,7 +614,7 @@ def main():
name=dict(type='str', required=True),
path=dict(type='str', default="/"),
assume_role_policy_document=dict(type='json'),
managed_policies=dict(type='list', aliases=['managed_policy']),
managed_policies=dict(type='list', aliases=['managed_policy'], elements='str'),
max_session_duration=dict(type='int'),
state=dict(type='str', choices=['present', 'absent'], default='present'),
description=dict(type='str'),
Expand All @@ -630,7 +631,7 @@ def main():

if module.params.get('purge_policies') is None:
module.deprecate('In Ansible 2.14 the default value of purge_policies will change from true to false.'
' To maintain the existing behaviour explicity set purge_policies=true', date='2022-06-01', collection_name='community.aws')
' To maintain the existing behaviour explicitly set purge_policies=true', date='2022-06-01', collection_name='community.aws')

if module.params.get('boundary'):
if module.params.get('create_instance_profile'):
Expand Down

0 comments on commit 1fd6420

Please sign in to comment.