wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixup parameter documentation ("doc-required-mismatch") AWS simple cases (#65462)

Browse source 
* Clean up "required" lines in AWS module docs, remove corresponding ignore.txt entries, general docs cleanup
This commit is contained in:
Mark Chappell 2019-12-04 17:00:50 +01:00 committed by Alicia Cozine
parent 4184b05cc1
commit b51a1bc429
32 changed files with 148 additions and 209 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
lib/ansible/modules/cloud/amazon/_lambda_facts.py
View file

@ -29,7 +29,6 @@ options:
query:
description:
- Specifies the resource type for which to gather facts. Leave blank to retrieve all facts.
required: true
choices: [ "aliases", "all", "config", "mappings", "policy", "versions" ]
default: "all"
type: str

21
lib/ansible/modules/cloud/amazon/aws_batch_job_definition.py
View file

@ -24,11 +24,11 @@ author: Jon Meran (@jonmer85)
options:
job_definition_arn:
description:
- The arn for the job definition
- The ARN for the job definition.
type: str
job_definition_name:
description:
- The name for the job definition
- The name for the job definition.
required: true
type: str
state:
@ -39,7 +39,7 @@ options:
type: str
type:
description:
- The type of job definition
- The type of job definition.
required: true
type: str
parameters:
@ -55,24 +55,27 @@ options:
Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes,
and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker
Remote API and the IMAGE parameter of docker run.
required: true
type: str
vcpus:
description:
- The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container
section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to
1,024 CPU shares.
required: true
type: int
memory:
description:
- The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory
specified here, the container is killed. This parameter maps to Memory in the Create a container section of the
Docker Remote API and the --memory option to docker run.
required: true
type: int
command:
description:
- The command that is passed to the container. This parameter maps to Cmd in the Create a container section of
the Docker Remote API and the COMMAND parameter to docker run. For more information,
see U(https://docs.docker.com/engine/reference/builder/#cmd)
see U(https://docs.docker.com/engine/reference/builder/#cmd).
type: list
elements: str
job_role_arn:
@ -81,7 +84,7 @@ options:
type: str
volumes:
description:
- A list of data volumes used in a job. List of dictionaries.
- A list of data volumes used in a job.
suboptions:
host:
description:
@ -104,7 +107,7 @@ options:
environment:
description:
- The environment variables to pass to a container. This parameter maps to Env in the Create a container section
of the Docker Remote API and the --env option to docker run. List of dictionaries.
of the Docker Remote API and the --env option to docker run.
suboptions:
name:
description:
@ -117,7 +120,7 @@ options:
mount_points:
description:
- The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container
section of the Docker Remote API and the --volume option to docker run. List of dictionaries.
section of the Docker Remote API and the --volume option to docker run.
suboptions:
containerPath:
description:
@ -125,7 +128,7 @@ options:
readOnly:
description:
- If this value is true , the container has read-only access to the volume; otherwise, the container can write
to the volume. The default value is false.
to the volume. The default value is C(false).
sourceVolume:
description:
- The name of the volume to mount.
@ -146,7 +149,7 @@ options:
ulimits:
description:
- A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section
of the Docker Remote API and the --ulimit option to docker run. List of dictionaries.
of the Docker Remote API and the --ulimit option to docker run.
suboptions:
hardLimit:
description:

47
lib/ansible/modules/cloud/amazon/aws_codebuild.py
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: aws_codebuild
short_description: Create or delete an AWS CodeBuild project
notes:
- for details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html)
- For details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html).
description:
- Create or delete a CodeBuild projects on AWS, used for building code artifacts from source code.
version_added: "2.9"
@ -26,13 +26,12 @@ requirements: [ botocore, boto3 ]
options:
name:
description:
- Name of the CodeBuild project
- Name of the CodeBuild project.
required: true
type: str
description:
description:
- Descriptive text of the CodeBuild project
required: false
- Descriptive text of the CodeBuild project.
type: str
source:
description:
@ -41,28 +40,24 @@ options:
suboptions:
type:
description:
- "The type of the source. Allows one of these: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE"
- "The type of the source. Allows one of these: C(CODECOMMIT), C(CODEPIPELINE), C(GITHUB), C(S3), C(BITBUCKET), C(GITHUB_ENTERPRISE)."
required: true
type: str
location:
description:
- Information about the location of the source code to be built. For type CODEPIPELINE location should not be specified.
required: false
type: str
git_clone_depth:
description:
- When using git you can specify the clone depth as an integer here.
required: false
type: int
buildspec:
description:
- The build spec declaration to use for the builds in this build project. Leave empty if part of the code project.
required: false
type: str
insecure_ssl:
description:
- Enable this flag to ignore SSL warnings while connecting to the project source code.
required: false
type: bool
type: dict
artifacts:
@ -72,40 +67,34 @@ options:
suboptions:
type:
description:
- "The type of build output for artifacts. Can be one of the following: CODEPIPELINE, NO_ARTIFACTS, S3"
- "The type of build output for artifacts. Can be one of the following: C(CODEPIPELINE), C(NO_ARTIFACTS), C(S3)."
required: true
location:
description:
- Information about the build output artifact location. When choosing type S3, set the bucket name here.
required: false
path:
description:
- Along with namespace_type and name, the pattern that AWS CodeBuild will use to name and store the output artifacts.
- Used for path in S3 bucket when type is S3
required: false
- Used for path in S3 bucket when type is C(S3).
namespace_type:
description:
- Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifacts
- Accepts BUILD_ID and NONE
- "See docs here: U(http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project)"
required: false
- Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifacts.
- Accepts C(BUILD_ID) and C(NONE).
- "See docs here: U(http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project)."
name:
description:
- Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact
required: false
- Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact.
packaging:
description:
- The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file
required: false
- The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file.
type: dict
cache:
description:
- Caching params to speed up following builds.
required: false
suboptions:
type:
description:
- Cache type. Can be NO_CACHE or S3.
- Cache type. Can be C(NO_CACHE) or C(S3).
required: true
location:
description:
@ -115,11 +104,10 @@ options:
environment:
description:
- Information about the build environment for the build project.
required: true
suboptions:
type:
description:
- The type of build environment to use for the project. Usually LINUX_CONTAINER
- The type of build environment to use for the project. Usually C(LINUX_CONTAINER).
required: true
image:
description:
@ -128,38 +116,32 @@ options:
compute_type:
description:
- Information about the compute resources the build project will use.
- "Available values include: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE"
- "Available values include: C(BUILD_GENERAL1_SMALL), C(BUILD_GENERAL1_MEDIUM), C(BUILD_GENERAL1_LARGE)."
required: true
environment_variables:
description:
- A set of environment variables to make available to builds for the build project. List of dictionaries with name and value fields.
- "Example: { name: 'MY_ENV_VARIABLE', value: 'test' }"
required: false
privileged_mode:
description:
- Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images.
required: false
type: dict
service_role:
description:
- The ARN of the AWS IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
required: false
type: str
timeout_in_minutes:
description:
- How long CodeBuild should wait until timing out any build that has not been marked as completed.
default: 60
required: false
type: int
encryption_key:
description:
- The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
required: false
type: str
tags:
description:
- A set of tags for the build project.
required: false
type: list
elements: dict
suboptions:
@ -172,7 +154,6 @@ options:
vpc_config:
description:
- The VPC config enables AWS CodeBuild to access resources in an Amazon VPC.
required: false
type: dict
state:
description:

2
lib/ansible/modules/cloud/amazon/aws_config_aggregation_authorization.py
View file

@ -33,10 +33,12 @@ options:
description:
- The 12-digit account ID of the account authorized to aggregate data.
type: str
required: true
authorized_aws_region:
description:
- The region authorized to collect aggregated data.
type: str
required: true
extends_documentation_fragment:
- aws
- ec2

2
lib/ansible/modules/cloud/amazon/aws_config_aggregator.py
View file

@ -54,6 +54,7 @@ options:
type: bool
type: list
elements: dict
required: true
organization_source:
description:
- The region authorized to collect aggregated data.
@ -72,6 +73,7 @@ options:
- If true, aggregate existing AWS Config regions and future regions.
type: bool
type: dict
required: true
extends_documentation_fragment:
- aws
- ec2

1
lib/ansible/modules/cloud/amazon/aws_config_delivery_channel.py
View file

@ -38,6 +38,7 @@ options:
description:
- The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
type: str
required: true
s3_prefix:
description:
- The prefix for the specified Amazon S3 bucket.

11
lib/ansible/modules/cloud/amazon/aws_config_rule.py
View file

@ -45,18 +45,18 @@ options:
compliance_types:
description:
- The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
You can only specify one type if you also specify a resource ID for `compliance_id`.
You can only specify one type if you also specify a resource ID for I(compliance_id).
compliance_id:
description:
- The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID,
you must specify one resource type for `compliance_types`.
you must specify one resource type for I(compliance_types).
tag_key:
description:
- The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
tag_value:
description:
- The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.
If you specify a value for `tag_value`, you must also specify a value for `tag_key`.
If you specify a value for I(tag_value), you must also specify a value for I(tag_key).
type: dict
source:
description:
@ -66,11 +66,11 @@ options:
owner:
description:
- The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
You can only specify one type if you also specify a resource ID for `compliance_id`.
You can only specify one type if you also specify a resource ID for I(compliance_id).
identifier:
description:
- The ID of the only AWS resource that you want to trigger an evaluation for the rule.
If you specify a resource ID, you must specify one resource type for `compliance_types`.
If you specify a resource ID, you must specify one resource type for I(compliance_types).
details:
description:
- Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
@ -79,6 +79,7 @@ options:
- Key `MessageType` The type of notification that triggers AWS Config to run an evaluation for a rule.
- Key `MaximumExecutionFrequency` The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
type: dict
required: true
input_parameters:
description:
- A string, in JSON format, that is passed to the AWS Config rule Lambda function.

19
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
View file

@ -34,25 +34,28 @@ options:
- present
- absent
type: str
required: true
name:
description:
- The name of the Direct Connect connection. This is required to create a
new connection. To recreate or delete a connection I(name) or I(connection_id)
is required.
new connection.
- One of I(connection_id) or I(name) must be specified.
type: str
connection_id:
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(forced_update) will result in a new Direct Connect connection ID.
- The ID of the Direct Connect connection.
- Modifying attributes of a connection with I(forced_update) will result in a new Direct Connect connection ID.
- One of I(connection_id) or I(name) must be specified.
type: str
location:
description:
- Where the Direct Connect connection is located. Required when I(state=present).
- Where the Direct Connect connection is located.
- Required when I(state=present).
type: str
bandwidth:
description:
- The bandwidth of the Direct Connect connection. Required when I(state=present).
- The bandwidth of the Direct Connect connection.
- Required when I(state=present).
choices:
- 1Gbps
- 10Gbps
@ -60,7 +63,7 @@ options:
link_aggregation_group:
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.
- This is optional when a stand-alone connection is desired.
type: str
forced_update:
description:

31
lib/ansible/modules/cloud/amazon/aws_direct_connect_gateway.py
View file

@ -15,12 +15,12 @@ DOCUMENTATION = '''
module: aws_direct_connect_gateway
author: Gobin Sougrakpam (@gobins)
version_added: "2.5"
short_description: Manage AWS Direct Connect Gateway.
short_description: Manage AWS Direct Connect gateway
description:
- Creates AWS Direct Connect Gateway
- Deletes AWS Direct Connect Gateway
- Attaches Virtual Gateways to Direct Connect Gateway
- Detaches Virtual Gateways to Direct Connect Gateway
- Creates AWS Direct Connect Gateway.
- Deletes AWS Direct Connect Gateway.
- Attaches Virtual Gateways to Direct Connect Gateway.
- Detaches Virtual Gateways to Direct Connect Gateway.
extends_documentation_fragment:
- aws
- ec2
@ -28,35 +28,32 @@ requirements: [ boto3 ]
options:
state:
description:
- present to ensure resource is created.
- absent to remove resource
required: false
- Set I(state=present) to ensure a resource is created.
- Set I(state=absent) to remove a resource.
default: present
choices: [ "present", "absent"]
type: str
name:
description:
- name of the dxgw to be created or deleted
required: false
- Name of the Direct Connect Gateway to be created or deleted.
type: str
amazon_asn:
description:
- amazon side asn
required: true
- The Amazon side ASN.
- Required when I(state=present).
type: str
direct_connect_gateway_id:
description:
- id of an existing direct connect gateway
required: false
- The ID of an existing Direct Connect Gateway.
- Required when I(state=absent).
type: str
virtual_gateway_id:
description:
- vpn gateway id of an existing virtual gateway
required: false
- The VPN gateway ID of an existing virtual gateway.
type: str
wait_timeout:
description:
- How long to wait for the association to be deleted
- How long to wait for the association to be deleted.
type: int
default: 320
'''

10
lib/ansible/modules/cloud/amazon/aws_direct_connect_link_aggregation_group.py
View file

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
---
module: aws_direct_connect_link_aggregation_group
short_description: Manage Direct Connect LAG bundles.
short_description: Manage Direct Connect LAG bundles
description:
- Create, delete, or modify a Direct Connect link aggregation group.
version_added: "2.4"
@ -32,6 +32,7 @@ options:
- present
- absent
type: str
required: true
name:
description:
- The name of the Direct Connect link aggregation group.
@ -71,12 +72,13 @@ options:
type: bool
wait:
description:
- Whether or not to wait for the operation to complete. May be useful when waiting for virtual interfaces
to be deleted. May modify the time of waiting with C(wait_timeout).
- Whether or not to wait for the operation to complete.
- May be useful when waiting for virtual interfaces to be deleted.
- The time to wait can be controlled by setting I(wait_timeout).
type: bool
wait_timeout:
description:
- The duration in seconds to wait if I(wait) is True.
- The duration in seconds to wait if I(wait=true).
default: 120
type: int
"""

4
lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py
View file

@ -13,7 +13,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
---
module: aws_direct_connect_virtual_interface
short_description: Manage Direct Connect virtual interfaces.
short_description: Manage Direct Connect virtual interfaces
description:
- Create, delete, or modify a Direct Connect public or private virtual interface.
version_added: "2.5"
@ -27,11 +27,13 @@ options:
- The desired state of the Direct Connect virtual interface.
choices: [present, absent]
type: str
required: true
id_to_associate:
description:
- The ID of the link aggregation group or connection to associate with the virtual interface.
aliases: [link_aggregation_group_id, connection_id]
type: str
required: true
public:
description:
- The type of virtual interface.

8
lib/ansible/modules/cloud/amazon/aws_glue_connection.py
View file

@ -23,29 +23,25 @@ options:
description:
- The ID of the Data Catalog in which to create the connection. If none is supplied,
the AWS account ID is used by default.
required: false
type: str
connection_properties:
description:
- A dict of key-value pairs used as parameters for this connection.
required: true
- Required when I(state=present).
type: dict
connection_type:
description:
- The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
required: false
default: JDBC
choices: [ 'JDBC', 'SFTP' ]
type: str
description:
description:
- The description of the connection.
required: false
type: str
match_criteria:
description:
- A list of UTF-8 strings that specify the criteria that you can use in selecting this connection.
required: false
type: list
elements: str
name:
@ -56,7 +52,6 @@ options:
security_groups:
description:
- A list of security groups to be used by the connection. Use either security group name or ID.
required: false
type: list
elements: str
state:
@ -68,7 +63,6 @@ options:
subnet_id:
description:
- The subnet ID used by the connection.
required: false
type: str
extends_documentation_fragment:
- aws

12
lib/ansible/modules/cloud/amazon/aws_glue_job.py
View file

@ -24,46 +24,39 @@ options:
- The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs
can be allocated; the default is 10. A DPU is a relative measure of processing power that consists
of 4 vCPUs of compute capacity and 16 GB of memory.
required: false
type: int
command_name:
description:
- The name of the job command. This must be 'glueetl'.
required: false
default: glueetl
type: str
command_script_location:
description:
- The S3 path to a script that executes a job.
required: true
- Required when I(state=present).
type: str
connections:
description:
- A list of Glue connections used for this job.
required: false
type: list
elements: str
default_arguments:
description:
- A dict of default arguments for this job. You can specify arguments here that your own job-execution
script consumes, as well as arguments that AWS Glue itself consumes.
required: false
type: dict
description:
description:
- Description of the job being defined.
required: false
type: str
max_concurrent_runs:
description:
- The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when
this threshold is reached. The maximum value you can specify is controlled by a service limit.
required: false
type: int
max_retries:
description:
- The maximum number of times to retry this job if it fails.
required: false
type: int
name:
description:
@ -73,7 +66,7 @@ options:
role:
description:
- The name or ARN of the IAM role associated with this job.
required: true
- Required when I(state=present).
type: str
state:
description:
@ -84,7 +77,6 @@ options:
timeout:
description:
- The job timeout in minutes.
required: false
type: int
extends_documentation_fragment:
- aws

13
lib/ansible/modules/cloud/amazon/aws_netapp_cvs_active_directory.py
View file

@ -42,15 +42,14 @@ options:
domain:
description:
- Name of the Active Directory domain
required: true
- Name of the Active Directory domain.
- Required when I(state=present).
type: str
DNS:
description:
- DNS server address for the Active Directory domain
- Required when C(state=present)
- Required when C(state=present), to modify ActiveDirectory properties.
- DNS server address for the Active Directory domain.
- Required when I(state=present), to modify ActiveDirectory properties.
type: str
netBIOS:
@ -60,12 +59,12 @@ options:
username:
description:
- Username of the Active Directory domain administrator
- Username of the Active Directory domain administrator.
type: str
password:
description:
- Password of the Active Directory domain administrator
- Password of the Active Directory domain administrator.
type: str
'''

2
lib/ansible/modules/cloud/amazon/aws_waf_condition.py
View file

@ -40,6 +40,7 @@ options:
- sql
- xss
type: str
required: true
filters:
description:
- A list of the filters against which to match.
@ -50,6 +51,7 @@ options:
- For I(type=size), valid keys are I(field_to_match), I(transformation), I(comparison) and I(size).
- For I(type=sql), valid keys are I(field_to_match) and I(transformation).
- For I(type=xss), valid keys are I(field_to_match) and I(transformation).
- Required when I(state=present).
type: list
elements: dict
suboptions:

27
lib/ansible/modules/cloud/amazon/dms_endpoint.py
View file

@ -30,11 +30,13 @@ options:
description:
- An identifier name for the endpoint.
type: str
required: true
endpointtype:
description:
- Type of endpoint we want to manage.
choices: ['source', 'target']
type: str
required: true
enginename:
description:
- Database engine that we want to use, please refer to
@ -44,6 +46,7 @@ options:
'redshift', 's3', 'db2', 'azuredb', 'sybase',
'dynamodb', 'mongodb', 'sqlserver']
type: str
required: true
username:
description:
- Username our endpoint will use to connect to the database.
@ -64,7 +67,7 @@ options:
type: int
databasename:
description:
- Name for the database on the origin or target side
- Name for the database on the origin or target side.
type: str
extraconnectionattributes:
description:
@ -87,7 +90,7 @@ options:
type: str
sslmode:
description:
- Mode used for the ssl connection
- Mode used for the SSL connection.
default: none
choices: ['none', 'require', 'verify-ca', 'verify-full']
type: str
@ -98,12 +101,12 @@ options:
type: str
externaltabledefinition:
description:
- The external table definition
- The external table definition.
type: str
dynamodbsettings:
description:
- Settings in JSON format for the target Amazon DynamoDB endpoint
if source or target is dynamodb
if source or target is dynamodb.
type: dict
s3settings:
description:
@ -112,33 +115,35 @@ options:
dmstransfersettings:
description:
- The settings in JSON format for the DMS transfer type of
source endpoint
source endpoint.
type: dict
mongodbsettings:
description:
- Settings in JSON format for the source MongoDB endpoint
- Settings in JSON format for the source MongoDB endpoint.
type: dict
kinesissettings:
description:
- Settings in JSON format for the target Amazon Kinesis
Data Streams endpoint
Data Streams endpoint.
type: dict
elasticsearchsettings:
description:
- Settings in JSON format for the target Elasticsearch endpoint
- Settings in JSON format for the target Elasticsearch endpoint.
type: dict
wait:
description:
- should wait for the object to be deleted when state = absent
- Whether Ansible should wait for the object to be deleted when I(state=absent).
type: bool
default: 'false'
default: false
timeout:
description:
- time in seconds we should wait for when deleting a resource
- Time in seconds we should wait for when deleting a resource.
- Required when I(wait=true).
type: int
retries:
description:
- number of times we should retry when deleting a resource
- Required when I(wait=true).
type: int
author:
- "Rui Moreira (@ruimoreira)"

3
lib/ansible/modules/cloud/amazon/dms_replication_subnet_group.py
View file

@ -32,16 +32,19 @@ options:
Must contain no more than 255 alphanumeric characters,
periods, spaces, underscores, or hyphens. Must not be "default".
type: str
required: true
description:
description:
- The description for the subnet group.
type: str
required: true
subnet_ids:
description:
- A list containing the subnet ids for the replication subnet group,
needs to be at least 2 items in the list.
type: list
elements: str
required: true
author:
- "Rui Moreira (@ruimoreira)"
extends_documentation_fragment:

5
lib/ansible/modules/cloud/amazon/ec2_scaling_policy.py
View file

@ -23,7 +23,6 @@ options:
state:
description:
- Register or deregister the policy.
required: true
default: present
choices: ['present', 'absent']
type: str
@ -40,23 +39,19 @@ options:
adjustment_type:
description:
- The type of change in capacity of the autoscaling group.
required: false
choices: ['ChangeInCapacity','ExactCapacity','PercentChangeInCapacity']
type: str
scaling_adjustment:
description:
- The amount by which the autoscaling group is adjusted by the policy.
required: false
type: int
min_adjustment_step:
description:
- Minimum amount of adjustment when policy is triggered.
required: false
type: int
cooldown:
description:
- The minimum period of time (in seconds) between which autoscaling actions can take place.
required: false
type: int
extends_documentation_fragment:
- aws

2
lib/ansible/modules/cloud/amazon/ec2_tag.py
View file

@ -36,7 +36,7 @@ options:
description:
- A dictionary of tags to add or remove from the resource.
- If the value provided for a tag is null and I(state=absent), the tag will be removed regardless of its current value.
required: true
- Required when I(state=present) or I(state=absent).
type: dict
purge_tags:
description:

17
lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py
View file

@ -45,11 +45,13 @@ options:
type: bool
purge_tags:
version_added: "2.5"
description: Purge existing tags that are not found in route table
description: Purge existing tags that are not found in route table.
type: bool
default: 'no'
route_table_id:
description: The ID of the route table to update or delete.
description:
- The ID of the route table to update or delete.
- Required when I(lookup=id).
type: str
routes:
description: List of routes in the route table.
@ -58,9 +60,9 @@ options:
If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'.
Routes are required for present states.
type: list
elements: str
elements: dict
state:
description: Create or destroy the VPC route table
description: Create or destroy the VPC route table.
default: present
choices: [ 'present', 'absent' ]
type: str
@ -71,13 +73,14 @@ options:
elements: str
tags:
description: >
A dictionary of resource tags of the form: { tag1: value1, tag2: value2 }. Tags are
A dictionary of resource tags of the form: C({ tag1: value1, tag2: value2 }). Tags are
used to uniquely identify route tables within a VPC when the route_table_id is not supplied.
aliases: [ "resource_tags" ]
type: dict
vpc_id:
description: VPC ID of the VPC in which to create the route table.
required: true
description:
- VPC ID of the VPC in which to create the route table.
- Required when I(state=present) or I(lookup=tag).
type: str
extends_documentation_fragment:
- aws

7
lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: ec2_vpc_subnet
short_description: Manage subnets in AWS virtual private clouds
description:
- Manage subnets in AWS virtual private clouds
- Manage subnets in AWS virtual private clouds.
version_added: "2.0"
author:
- Robert Estelle (@erydo)
@ -31,6 +31,7 @@ options:
description:
- "The CIDR block for the subnet. E.g. 192.0.2.0/24."
type: str
required: true
ipv6_cidr:
description:
- "The IPv6 CIDR block for the subnet. The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range."
@ -44,7 +45,7 @@ options:
type: dict
state:
description:
- "Create or remove the subnet"
- "Create or remove the subnet."
default: present
choices: [ 'present', 'absent' ]
type: str
@ -67,7 +68,7 @@ options:
version_added: "2.5"
wait:
description:
- "When specified,I(state=present) module will wait for subnet to be in available state before continuing."
- "When I(wait=true) and I(state=present), module will wait for subnet to be in available state before continuing."
type: bool
default: true
version_added: "2.5"

5
lib/ansible/modules/cloud/amazon/elasticache_snapshot.py
View file

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = """
---
module: elasticache_snapshot
short_description: Manage cache snapshots in Amazon ElastiCache.
short_description: Manage cache snapshots in Amazon ElastiCache
description:
- Manage cache snapshots in Amazon ElastiCache.
- Returns information about the specified snapshot.
@ -28,11 +28,12 @@ options:
name:
description:
- The name of the snapshot we want to create, copy, delete.
required: yes
required: true
type: str
state:
description:
- Actions that will create, destroy, or copy a snapshot.
required: true
choices: ['present', 'absent', 'copy']
type: str
replication_id:

27
lib/ansible/modules/cloud/amazon/elb_application_lb.py
View file

@ -33,54 +33,51 @@ author: "Rob White (@wimnat)"
options:
access_logs_enabled:
description:
- "Whether or not to enable access logs. When true, I(access_logs_s3_bucket) must be set."
required: false
- Whether or not to enable access logs.
- When set, I(access_logs_s3_bucket) must also be set.
type: bool
access_logs_s3_bucket:
description:
- The name of the S3 bucket for the access logs.
- Required if access logs in Amazon S3 are enabled.
- The bucket must exist in the same
region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.
required: false
- Required if access logs in Amazon S3 are enabled.
- When set, I(access_logs_enabled) must also be set.
type: str
access_logs_s3_prefix:
description:
- The prefix for the log location in the S3 bucket.
- If you don't specify a prefix, the access logs are stored in the root of the bucket.
- Cannot begin or end with a slash.
required: false
type: str
deletion_protection:
description:
- Indicates whether deletion protection for the ELB is enabled.
required: false
default: no
type: bool
http2:
description:
- Indicates whether to enable HTTP2 routing.
required: false
default: no
type: bool
version_added: 2.6
idle_timeout:
description:
- The number of seconds to wait before an idle connection is closed.
required: false
type: int
listeners:
description:
- A list of dicts containing listeners to attach to the ELB. See examples for detail of the dict required. Note that listener keys
are CamelCased.
required: false
type: list
suboptions:
Port:
description: The port on which the load balancer is listening.
required: true
type: int
Protocol:
description: The protocol for connections from clients to the load balancer.
required: true
type: str
Certificates:
description: The SSL server certificate.
@ -94,6 +91,7 @@ options:
type: str
DefaultActions:
description: The default actions for the listener.
required: true
type: list
suboptions:
Type:
@ -134,25 +132,23 @@ options:
description:
- If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then
tags will not be modified.
required: false
default: yes
type: bool
subnets:
description:
- A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from
at least two Availability Zones. Required if state=present.
required: false
at least two Availability Zones.
- Required if I(state=present).
type: list
security_groups:
description:
- A list of the names or IDs of the security groups to assign to the load balancer. Required if state=present.
required: false
- A list of the names or IDs of the security groups to assign to the load balancer.
- Required if I(state=present).
default: []
type: list
scheme:
description:
- Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.
required: false
default: internet-facing
choices: [ 'internet-facing', 'internal' ]
type: str
@ -165,7 +161,6 @@ options:
tags:
description:
- A dictionary of one or more tags to assign to the load balancer.
required: false
type: dict
wait:
description:

3
lib/ansible/modules/cloud/amazon/iam_server_certificate_info.py
View file

@ -16,7 +16,7 @@ DOCUMENTATION = '''
module: iam_server_certificate_info
short_description: Retrieve the information of a server certificate
description:
- Retrieve the attributes of a server certificate
- Retrieve the attributes of a server certificate.
- This module was called C(iam_server_certificate_facts) before Ansible 2.9. The usage did not change.
version_added: "2.2"
author: "Allen Sanabria (@linuxdynasty)"
@ -25,7 +25,6 @@ options:
name:
description:
- The name of the server certificate you are retrieving attributes for.
required: true
type: str
extends_documentation_fragment:
- aws

5
lib/ansible/modules/cloud/amazon/lambda_alias.py
View file

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
---
module: lambda_alias
short_description: Creates, updates or deletes AWS Lambda function aliases.
short_description: Creates, updates or deletes AWS Lambda function aliases
description:
- This module allows the management of AWS Lambda functions aliases via the Ansible
framework. It is idempotent and supports "Check" mode. Use module M(lambda) to manage the lambda function
@ -32,7 +32,6 @@ options:
state:
description:
- Describes the desired state.
required: true
default: "present"
choices: ["present", "absent"]
type: str
@ -45,13 +44,11 @@ options:
description:
description:
- A short, user-defined function alias description.
required: false
type: str
function_version:
description:
- Version associated with the Lambda function alias.
A value of 0 (or omitted parameter) sets the alias to the $LATEST version.
required: false
aliases: ['version']
type: int
requirements:

12
lib/ansible/modules/cloud/amazon/lambda_event.py
View file

@ -14,7 +14,7 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
---
module: lambda_event
short_description: Creates, updates or deletes AWS Lambda function event mappings.
short_description: Creates, updates or deletes AWS Lambda function event mappings
description:
- This module allows the management of AWS Lambda function event source mappings such as DynamoDB and Kinesis stream
events via the Ansible framework. These event source mappings are relevant only in the AWS Lambda pull model, where
@ -35,26 +35,24 @@ options:
state:
description:
- Describes the desired state.
required: true
default: "present"
choices: ["present", "absent"]
type: str
alias:
description:
- Name of the function alias. Mutually exclusive with I(version).
required: true
- Name of the function alias.
- Mutually exclusive with I(version).
type: str
version:
description:
- Version of the Lambda function. Mutually exclusive with I(alias).
required: false
- Version of the Lambda function.
- Mutually exclusive with I(alias).
type: int
event_source:
description:
- Source of the event that triggers the lambda function.
- For DynamoDB and Kinesis events, select C(stream)
- For SQS queues, select C(sqs)
required: false
default: stream
choices: ['stream', 'sqs']
type: str

1
lib/ansible/modules/cloud/amazon/lambda_info.py
View file

@ -26,7 +26,6 @@ options:
query:
description:
- Specifies the resource type for which to gather information. Leave blank to retrieve all information.
required: true
choices: [ "aliases", "all", "config", "mappings", "policy", "versions" ]
default: "all"
type: str

2
lib/ansible/modules/cloud/amazon/redshift_cross_region_snapshots.py
View file

@ -30,7 +30,6 @@ options:
state:
description:
- Create or remove the cross-region snapshot configuration.
required: true
choices: [ "present", "absent" ]
default: present
type: str
@ -50,7 +49,6 @@ options:
description:
- A grant for Amazon Redshift to use a master key in the I(destination_region).
- See U(http://boto3.readthedocs.io/en/latest/reference/services/redshift.html#Redshift.Client.create_snapshot_copy_grant)
required: false
aliases: [ "copy_grant" ]
type: str
snapshot_retention_period:

1
lib/ansible/modules/cloud/amazon/redshift_subnet_group.py
View file

@ -25,6 +25,7 @@ options:
state:
description:
- Specifies whether the subnet should be present or absent.
required: true
choices: ['present', 'absent' ]
type: str
group_name:

3
lib/ansible/modules/cloud/amazon/route53_health_check.py
View file

@ -24,7 +24,6 @@ options:
state:
description:
- Specifies the action to take.
required: true
choices: [ 'present', 'absent' ]
type: str
default: 'present'
@ -72,7 +71,6 @@ options:
- The number of seconds between the time that Amazon Route 53 gets a
response from your endpoint and the time that it sends the next
health-check request.
required: true
default: 30
choices: [ 10, 30 ]
type: int
@ -81,7 +79,6 @@ options:
- The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa.
required: true
default: 3
choices: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
type: int

22
lib/ansible/modules/cloud/amazon/s3_bucket_notification.py
View file

@ -31,8 +31,8 @@ author:
options:
event_name:
description:
- unique name for event notification on bucket
required: True
- Unique name for event notification on bucket.
required: true
type: str
lambda_function_arn:
description:
@ -41,25 +41,24 @@ options:
type: str
bucket_name:
description:
- S3 bucket name
required: True
- S3 bucket name.
required: true
type: str
state:
description:
- Describes the desired state.
required: true
default: "present"
choices: ["present", "absent"]
type: str
lambda_alias:
description:
- Name of the Lambda function alias. Mutually exclusive with C(lambda_version).
required: false
- Name of the Lambda function alias.
- Mutually exclusive with I(lambda_version).
type: str
lambda_version:
description:
- Version of the Lambda function. Mutually exclusive with C(lambda_alias).
required: false
- Version of the Lambda function.
- Mutually exclusive with I(lambda_alias).
type: int
events:
description:
@ -68,24 +67,23 @@ options:
and you can set up a prefix or suffix for an event. However, for each bucket,
individual events cannot have multiple configurations with overlapping prefixes or
suffixes that could match the same object key.
required: True
- Required when I(state=present).
choices: ['s3:ObjectCreated:*', 's3:ObjectCreated:Put', 's3:ObjectCreated:Post',
's3:ObjectCreated:Copy', 's3:ObjectCreated:CompleteMultipartUpload',
's3:ObjectRemoved:*', 's3:ObjectRemoved:Delete',
's3:ObjectRemoved:DeleteMarkerCreated', 's3:ObjectRestore:Post',
's3:ObjectRestore:Completed', 's3:ReducedRedundancyLostObject']
type: list
elements: str
prefix:
description:
- Optional prefix to limit the notifications to objects with keys that start with matching
characters.
required: false
type: str
suffix:
description:
- Optional suffix to limit the notifications to objects with keys that end with matching
characters.
required: false
type: str
requirements:
- boto3

31
test/sanity/ignore.txt
View file

@ -491,46 +491,15 @@ lib/ansible/modules/cloud/alicloud/ali_instance.py validate-modules:parameter-ty
lib/ansible/modules/cloud/alicloud/ali_instance_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/alicloud/ali_instance_info.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/alicloud/ali_instance_info.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/amazon/_lambda_facts.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_batch_job_definition.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_codebuild.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_config_aggregation_authorization.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_config_aggregator.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_config_delivery_channel.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_config_rule.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_direct_connect_gateway.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_direct_connect_link_aggregation_group.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_glue_connection.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_glue_job.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_netapp_cvs_active_directory.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/aws_waf_condition.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/cloudtrail.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/dms_endpoint.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/dms_replication_subnet_group.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_asg_lifecycle_hook.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_lc.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_placement_group.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_scaling_policy.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_tag.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/elasticache_snapshot.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/elb_application_lb.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/elb_network_lb.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/iam.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/iam_cert.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/iam_policy.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/iam_server_certificate_info.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/lambda_alias.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/lambda_event.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/lambda_info.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/redshift_cross_region_snapshots.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/redshift_subnet_group.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/route53_health_check.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/amazon/s3_bucket_notification.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/atomic/atomic_container.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/atomic/atomic_container.py validate-modules:doc-required-mismatch
lib/ansible/modules/cloud/atomic/atomic_container.py validate-modules:no-default-for-required-parameter