Fix non-matching defaults in docs (#1576)

Fix non-matching defaults in docs

Depends-On: #1579
SUMMARY
Fix various non-matching default values exposed by ansible/ansible#79267.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
various

Reviewed-by: Markus Bergholz <[email protected]>

Author: felixfontein

changelogs/fragments/1576-defaults.yml

@@ -0,0 +1,2 @@
+trivial:
+  - "Fixed ``default`` values in various modules so that documentation and argument spec coincide (https://github.com/ansible-collections/community.aws/pull/1576)."

plugins/modules/api_gateway.py

@@ -76,6 +76,7 @@
     description:
       - ENV variables for the stage. Define a dict of key values pairs for variables.
     type: dict
+    default: {}
   stage_canary_settings:
     description:
       - Canary settings for the deployment of the stage.
@@ -86,6 +87,7 @@
       - 'C(useStageCache): A Boolean flag to indicate whether the canary deployment uses the stage cache or not.'
       - See docs U(https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/apigateway.html#APIGateway.Client.create_stage)
     type: dict
+    default: {}
   tracing_enabled:
     description:
       - Specifies whether active tracing with X-ray is enabled for the API GW stage.

plugins/modules/autoscaling_launch_config.py

@@ -59,6 +59,7 @@
       - You can specify either security group names or IDs or a mix.
     type: list
     elements: str
+    default: []
   volumes:
     description:
       - A list dictionaries defining the volumes to create.

plugins/modules/batch_job_definition.py

@@ -78,6 +78,7 @@
         see U(https://docs.docker.com/engine/reference/builder/#cmd).
     type: list
     elements: str
+    default: []
   job_role_arn:
     description:
       - The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
@@ -104,6 +105,7 @@
             allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
     type: list
     elements: dict
+    default: []
   environment:
     description:
       - The environment variables to pass to a container. This parameter maps to Env in the Create a container section
@@ -117,6 +119,7 @@
           - The value of the key value pair. For environment variables, this is the value of the environment variable.
     type: list
     elements: dict
+    default: []
   mount_points:
     description:
       - The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container
@@ -134,6 +137,7 @@
           - The name of the volume to mount.
     type: list
     elements: dict
+    default: []
   readonly_root_filesystem:
     description:
       - When this parameter is true, the container is given read-only access to its root file system. This parameter
@@ -162,6 +166,7 @@
           - The soft limit for the ulimit type.
     type: list
     elements: dict
+    default: []
   user:
     description:
       - The user name to use inside the container. This parameter maps to User in the Create a container section of

plugins/modules/cloudformation_stack_set.py

@@ -139,6 +139,7 @@
     description:
     - Settings to change what is considered "failed" when running stack instance updates, and how many to do at a time.
     type: dict
+    default: {}
     suboptions:
       fail_count:
         description:

plugins/modules/cloudfront_distribution.py

@@ -72,6 +72,7 @@
         - Each alias must be unique across all distribution for the AWS account.
       type: list
       elements: str
+      default: []
 
     purge_aliases:
       description:

plugins/modules/codecommit_repository.py

@@ -31,6 +31,7 @@
     aliases:
       - comment
     type: str
+    default: ''
   state:
     description:
       - Specifies the state of repository.

plugins/modules/data_pipeline.py

@@ -39,6 +39,7 @@
   objects:
     type: list
     elements: dict
+    default: []
     description:
       - A list of pipeline object definitions, each of which is a dict that takes the keys I(id), I(name) and I(fields).
     suboptions:
@@ -77,6 +78,7 @@
       - A list of parameter objects (dicts) in the pipeline definition.
     type: list
     elements: dict
+    default: []
     suboptions:
       id:
         description:
@@ -99,6 +101,7 @@
       - A list of parameter values (dicts) in the pipeline definition.
     type: list
     elements: dict
+    default: []
     suboptions:
       id:
         description: The ID of the parameter value
@@ -121,6 +124,7 @@
     description:
       - A dict of key:value pair(s) to add to the pipeline.
     type: dict
+    default: {}
     aliases: ['resource_tags']
 '''
 

plugins/modules/ec2_ami_copy.py

@@ -34,6 +34,7 @@
     description:
       - An optional human-readable string describing the contents and purpose of the new AMI.
     type: str
+    default: ''
   encrypted:
     description:
       - Whether or not the destination snapshots of the copied AMI should be encrypted.

plugins/modules/ec2_customer_gateway_info.py

@@ -20,11 +20,13 @@
       - A dict of filters to apply. Each dict item consists of a filter key and a filter value.
         See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCustomerGateways.html) for possible filters.
     type: dict
+    default: {}
   customer_gateway_ids:
     description:
       - Get details of a specific customer gateways using customer gateway ID/IDs. This value should be provided as a list.
     type: list
     elements: str
+    default: []
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2