Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Module DOCUMENTATION should match argspec #34895

Merged
merged 4 commits into from
Jan 16, 2018
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/ansible/modules/cloud/amazon/_ec2_ami_find.py
Expand Up @@ -158,6 +158,8 @@
choices: ['success', 'fail']
default: 'success'
required: false
extends_documentation_fragment:
- aws
requirements:
- "python >= 2.6"
- boto
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/aws_acm_facts.py
Expand Up @@ -25,7 +25,9 @@
- boto3
author:
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/aws_api_gateway.py
Expand Up @@ -63,6 +63,7 @@
- 'Michael De La Rue (@mikedlr)'
extends_documentation_fragment:
- aws
- ec2
notes:
- A future version of this module will probably use tags or another
ID so that an API can be create only once.
Expand Down
Expand Up @@ -17,6 +17,9 @@
The connection may later be associated or disassociated with a link aggregation group.
version_added: "2.4"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore
Expand All @@ -36,7 +39,7 @@
description:
- The ID of the Direct Connect connection. I(name) or I(connection_id) is
required to recreate or delete a connection. Modifying attributes of a
connection with I(force_update) will result in a new Direct Connect connection ID.
connection with I(forced_update) will result in a new Direct Connect connection ID.
location:
description:
- Where the Direct Connect connection is located. Required when I(state=present).
Expand All @@ -50,7 +53,7 @@
description:
- The ID of the link aggregation group you want to associate with the connection.
This is optional in case a stand-alone connection is desired.
force_update:
forced_update:
description:
- To modify bandwidth or location the connection will need to be deleted and recreated.
By default this will not happen - this option must be set to True.
Expand Down Expand Up @@ -80,7 +83,7 @@
name: ansible-test-connection
location: EqDC2
bandwidth: 10Gbps
force_update: True
forced_update: True

# delete the connection
aws_direct_connect_connection:
Expand Down
Expand Up @@ -21,6 +21,9 @@
- Deletes AWS Direct Connect Gateway
- Attaches Virtual Gateways to Direct Connect Gateway
- Detaches Virtual Gateways to Direct Connect Gateway
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3 ]
options:
state:
Expand Down
Expand Up @@ -15,6 +15,9 @@
- Create, delete, or modify a Direct Connect link aggregation group.
version_added: "2.4"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/aws_s3.py
Expand Up @@ -143,7 +143,9 @@
author:
- "Lester Wade (@lwade)"
- "Sloane Hertel (@s-hertel)"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/aws_s3_cors.py
Expand Up @@ -32,6 +32,7 @@
choices: [ 'present', 'absent' ]
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/aws_waf_facts.py
Expand Up @@ -21,7 +21,9 @@
author:
- Mike Mochan (@mmochan)
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
6 changes: 3 additions & 3 deletions lib/ansible/modules/cloud/amazon/cloudfront_facts.py
Expand Up @@ -93,7 +93,7 @@
I(domain_name_alias) to be specified.
required: false
default: false
streaming_distribution_configuration:
streaming_distribution_config:
description:
- Get the configuration information about a specified RTMP distribution.
Requires I(distribution_id) or I(domain_name_alias) to be specified.
Expand Down Expand Up @@ -214,11 +214,11 @@
I(distribution_id) or I(domain_name_alias) to be specified.
returned: only if I(streaming_distribution) is true
type: dict
streaming_distribution_configuration:
streaming_distribution_config:
description: >
Describes the streaming configuration information for the distribution.
Requires I(distribution_id) or I(domain_name_alias) to be specified.
returned: only if I(streaming_distribution_configuration) is true
returned: only if I(streaming_distribution_config) is true
type: dict
summary:
description: Gives a summary of distributions, streaming distributions and origin access identities.
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/cloudwatchevent_rule.py
Expand Up @@ -20,6 +20,7 @@
version_added: "2.2"
extends_documentation_fragment:
- aws
- ec2
author: "Jim Dalton (@jsdalton) <jim.dalton@gmail.com>"
requirements:
- python >= 2.6
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/ec2_key.py
Expand Up @@ -55,6 +55,7 @@

extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3 ]
author:
- "Vincent Viallet (@zbal)"
Expand Down
2 changes: 2 additions & 0 deletions lib/ansible/modules/cloud/amazon/ec2_lc_find.py
Expand Up @@ -51,6 +51,8 @@
requirements:
- "python >= 2.6"
- boto3
extends_documentation_fragment:
- aws
"""

EXAMPLES = '''
Expand Down
2 changes: 2 additions & 0 deletions lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py
Expand Up @@ -26,6 +26,8 @@
The module must be called from within the EC2 instance itself.
notes:
- Parameters to filter on ec2_metadata_facts may be added later.
extends_documentation_fragment:
- url
'''

EXAMPLES = '''
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py
Expand Up @@ -108,7 +108,9 @@
default: present
choices: [ 'absent', 'present' ]
version_added: "2.1"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto
"""
Expand Down
Expand Up @@ -33,7 +33,7 @@
- Provide this value as a list
required: false
default: None
aliases: ['DhcpOptionsIds']
aliases: ['DhcpOptionIds']
extends_documentation_fragment:
- aws
- ec2
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint_facts.py
Expand Up @@ -39,7 +39,9 @@
required: false
default: None
author: Karen Cheng(@Etherdaemon)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py
Expand Up @@ -63,7 +63,9 @@
choices: ['present', 'absent']
default: present
author: Mike Mochan(@mmochan)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements: [ botocore, boto3, json ]
'''

Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py
Expand Up @@ -51,7 +51,9 @@
default: present
choices: ['present', 'absent', 'accept', 'reject']
author: Mike Mochan(@mmochan)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
requirements: [ botocore, boto3, json ]
'''

Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_peering_facts.py
Expand Up @@ -31,7 +31,9 @@
required: false
default: None
author: Karen Cheng(@Etherdaemon)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
1 change: 0 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py
Expand Up @@ -87,7 +87,6 @@
version_added: "2.5"
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
1 change: 0 additions & 1 deletion lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py
Expand Up @@ -59,7 +59,6 @@
aliases: [ "resource_tags" ]
author: Nick Aslanidis (@naslanidis)
extends_documentation_fragment:
- aws
- ec2
'''

Expand Down
3 changes: 3 additions & 0 deletions lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py
Expand Up @@ -15,6 +15,9 @@
- This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters
option or specifying the VPN connection identifier.
version_added: "2.4"
extends_documentation_fragment:
- ec2
- aws
requirements: ['boto3', 'botocore']
author: "Sloane Hertel (@s-hertel)"
options:
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/ecs_ecr.py
Expand Up @@ -52,7 +52,9 @@
default: 'present'
author:
- David M. Lee (@leedm777)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
3 changes: 2 additions & 1 deletion lib/ansible/modules/cloud/amazon/efs_facts.py
Expand Up @@ -45,7 +45,8 @@
required: false
default: None
extends_documentation_fragment:
- aws
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/elasticache_facts.py
Expand Up @@ -19,7 +19,9 @@

author:
- Will Thames (@willthames)
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
Expand Up @@ -28,6 +28,9 @@
- Returns information about the specified cache cluster.
version_added: "2.3"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3, botocore ]
options:
group_family:
Expand Down
3 changes: 3 additions & 0 deletions lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
Expand Up @@ -20,6 +20,9 @@
- Returns information about the specified snapshot.
version_added: "2.3"
author: "Sloane Hertel (@s-hertel)"
extends_documentation_fragment:
- aws
- ec2
requirements: [ boto3, botocore ]
options:
name:
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/execute_lambda.py
Expand Up @@ -29,6 +29,7 @@
version_added: "2.2"
extends_documentation_fragment:
- aws
- ec2
author: "Ryan Scott Brown (@ryansb) <ryansb@redhat.com>"
requirements:
- python >= 2.6
Expand Down
4 changes: 3 additions & 1 deletion lib/ansible/modules/cloud/amazon/iam.py
Expand Up @@ -99,7 +99,9 @@
author:
- "Jonathan I. Davila (@defionscode)"
- "Paul Seiffert (@seiffert)"
extends_documentation_fragment: aws
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/iam_group.py
Expand Up @@ -57,6 +57,7 @@
requirements: [ botocore, boto3 ]
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
3 changes: 3 additions & 0 deletions lib/ansible/modules/cloud/amazon/iam_managed_policy.py
Expand Up @@ -45,6 +45,9 @@
default: null
choices: [ "present", "absent" ]
author: "Dan Kozlowski (@dkhenry)"
extends_documentation_fragment:
- aws
- ec2
requirements:
- boto3
- botocore
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/iam_role.py
Expand Up @@ -66,6 +66,7 @@
requirements: [ botocore, boto3 ]
extends_documentation_fragment:
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
3 changes: 2 additions & 1 deletion lib/ansible/modules/cloud/amazon/iam_role_facts.py
Expand Up @@ -37,7 +37,8 @@
required: false
default: None
extends_documentation_fragment:
- aws
- aws
- ec2
'''

EXAMPLES = '''
Expand Down
6 changes: 3 additions & 3 deletions lib/ansible/modules/cloud/amazon/lambda_alias.py
Expand Up @@ -52,9 +52,9 @@
requirements:
- boto3
extends_documentation_fragment:
- aws

'''
- aws
- ec2
'''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this extra space accidental?


EXAMPLES = '''
---
Expand Down
1 change: 1 addition & 0 deletions lib/ansible/modules/cloud/amazon/lambda_event.py
Expand Up @@ -66,6 +66,7 @@
- boto3
extends_documentation_fragment:
- aws
- ec2

'''

Expand Down