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]>
ansible-collections · Nov 2, 2022 · 15568f0 · 15568f0
1 parent cea2ab5
commit 15568f0
Show file tree

Hide file tree

Showing 32 changed files with 66 additions and 0 deletions.
diff --git a/changelogs/fragments/1576-defaults.yml b/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)."
diff --git a/plugins/modules/api_gateway.py b/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.

diff --git a/plugins/modules/autoscaling_launch_config.py b/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.

diff --git a/plugins/modules/batch_job_definition.py b/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

diff --git a/plugins/modules/cloudformation_stack_set.py b/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:

diff --git a/plugins/modules/cloudfront_distribution.py b/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:

diff --git a/plugins/modules/codecommit_repository.py b/plugins/modules/codecommit_repository.py
@@ -31,6 +31,7 @@
     aliases:
       - comment
     type: str
+    default: ''
   state:
     description:
       - Specifies the state of repository.

diff --git a/plugins/modules/data_pipeline.py b/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']
 '''
 

diff --git a/plugins/modules/ec2_ami_copy.py b/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.

diff --git a/plugins/modules/ec2_customer_gateway_info.py b/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

diff --git a/plugins/modules/ec2_snapshot_copy.py b/plugins/modules/ec2_snapshot_copy.py
@@ -29,6 +29,7 @@
     description:
       - An optional human-readable string describing purpose of the new Snapshot.
     type: str
+    default: ''
   encrypted:
     description:
       - Whether or not the destination Snapshot should be encrypted.

diff --git a/plugins/modules/ec2_transit_gateway_info.py b/plugins/modules/ec2_transit_gateway_info.py
@@ -21,11 +21,13 @@
     aliases: [transit_gateway_id]
     type: list
     elements: str
+    default: []
   filters:
     description:
       - 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_DescribeTransitGateways.html) for filters.
     type: dict
+    default: {}
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2

diff --git a/plugins/modules/ec2_vpc_nacl.py b/plugins/modules/ec2_vpc_nacl.py
@@ -40,6 +40,7 @@
     required: false
     type: list
     elements: str
+    default: []
   egress:
     description:
       - A list of rules for outgoing traffic. Each rule must be specified as a list.

diff --git a/plugins/modules/ec2_vpc_peering_info.py b/plugins/modules/ec2_vpc_peering_info.py
@@ -24,6 +24,7 @@
         See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html)
         for possible filters.
     type: dict
+    default: {}
 author: Karen Cheng (@Etherdaemon)
 extends_documentation_fragment:
 - amazon.aws.aws

diff --git a/plugins/modules/ec2_vpc_vgw_info.py b/plugins/modules/ec2_vpc_vgw_info.py
@@ -19,6 +19,7 @@
       - 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_DescribeVpnGateways.html) for possible filters.
     type: dict
+    default: {}
   vpn_gateway_ids:
     description:
       - Get details of a specific Virtual Gateway ID.

diff --git a/plugins/modules/ec2_vpc_vpn.py b/plugins/modules/ec2_vpc_vpn.py
@@ -61,6 +61,7 @@
     required: false
     type: list
     elements: dict
+    default: []
     suboptions:
         TunnelInsideCidr:
             type: str
@@ -110,11 +111,13 @@
         description:
           - The customer gateway id as a string or a list of those strings.
     type: dict
+    default: {}
   routes:
     description:
       - Routes to add to the connection.
     type: list
     elements: str
+    default: []
   purge_routes:
     description:
       - Whether or not to delete VPN connections routes that are not specified in the task.

diff --git a/plugins/modules/ec2_vpc_vpn_info.py b/plugins/modules/ec2_vpc_vpn_info.py
@@ -21,12 +21,14 @@
         See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html) for possible filters.
     required: false
     type: dict
+    default: {}
   vpn_connection_ids:
     description:
       - Get details of a specific VPN connections using vpn connection ID/IDs. This value should be provided as a list.
     required: false
     type: list
     elements: str
+    default: []
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2

diff --git a/plugins/modules/ecs_service.py b/plugins/modules/ecs_service.py
@@ -57,6 +57,7 @@
         required: false
         type: list
         elements: dict
+        default: []
     desired_count:
         description:
           - The count of how many instances of the service.
@@ -68,13 +69,15 @@
           - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
         required: false
         type: str
+        default: ''
     role:
         description:
           - The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer
             on your behalf.
           - This parameter is only required if you are using a load balancer with your service in a network mode other than C(awsvpc).
         required: false
         type: str
+        default: ''
     delay:
         description:
           - The time to wait before checking that the service is available.
@@ -99,6 +102,7 @@
         required: false
         version_added: 4.1.0
         type: dict
+        default: {}
         suboptions:
           type:
             type: str
@@ -110,6 +114,7 @@
           - Format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>}
         required: false
         type: dict
+        default: {}
         suboptions:
           maximum_percent:
             type: int
@@ -134,6 +139,7 @@
         required: false
         type: list
         elements: dict
+        default: []
         suboptions:
           type:
             description: The type of constraint.
@@ -148,6 +154,7 @@
         required: false
         type: list
         elements: dict
+        default: []
         suboptions:
           type:
             description: The type of placement strategy.
@@ -193,6 +200,7 @@
         required: false
         type: list
         elements: dict
+        default: []
         suboptions:
             capacity_provider:
                 description:
@@ -223,6 +231,7 @@
           - Describes service discovery registries this service will register with.
         type: list
         elements: dict
+        default: []
         required: false
         suboptions:
             container_name:

diff --git a/plugins/modules/ecs_taskdefinition.py b/plugins/modules/ecs_taskdefinition.py
@@ -508,11 +508,13 @@
               the permissions that are specified in this role.
         required: false
         type: str
+        default: ''
     execution_role_arn:
         description:
             - The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
         required: false
         type: str
+        default: ''
     volumes:
         description:
             - A list of names of volumes to be attached.

diff --git a/plugins/modules/efs.py b/plugins/modules/efs.py
@@ -59,6 +59,7 @@
                This data may be modified for existing EFS using state 'present' and new list of mount targets."
         type: list
         elements: dict
+        default: []
         suboptions:
             subnet_id:
                 required: true

diff --git a/plugins/modules/efs_info.py b/plugins/modules/efs_info.py
@@ -30,12 +30,14 @@
       description:
       - List of tags of Amazon EFS. Should be defined as dictionary.
       type: dict
+      default: {}
     targets:
       description:
       - List of targets on which to filter the returned results.
       - Result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address.
       type: list
       elements: str
+      default: []
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2

diff --git a/plugins/modules/eks_fargate_profile.py b/plugins/modules/eks_fargate_profile.py
@@ -48,6 +48,7 @@
       labels:
         description: A dictionary of labels used in fargate profile.
         type: dict
+        default: {}
   state:
     description: Create or delete the Fargate Profile.
     choices:

diff --git a/plugins/modules/elasticache.py b/plugins/modules/elasticache.py
@@ -39,6 +39,7 @@
     description:
       - The version number of the cache engine.
     type: str
+    default: ''
   node_type:
     description:
       - The compute and memory capacity of the nodes in the cache cluster.
@@ -61,22 +62,26 @@
         for the specified engine will be used.
     aliases: [ 'parameter_group' ]
     type: str
+    default: ''
   cache_subnet_group:
     description:
       - The subnet group name to associate with. Only use if inside a VPC.
       - Required if inside a VPC.
     type: str
+    default: ''
   security_group_ids:
     description:
       - A list of VPC security group IDs to associate with this cache cluster. Only use if inside a VPC.
     type: list
     elements: str
+    default: []
   cache_security_groups:
     description:
       - A list of cache security group names to associate with this cache cluster.
       - Don't use if your Cache is inside a VPC. In that case use I(security_group_ids) instead!
     type: list
     elements: str
+    default: []
   zone:
     description:
       - The EC2 Availability Zone in which the cache cluster will be created.

diff --git a/plugins/modules/elasticache_parameter_group.py b/plugins/modules/elasticache_parameter_group.py
@@ -36,6 +36,7 @@
     description:
       - A user-specified description for the cache parameter group.
     type: str
+    default: ''
   state:
     description:
       - Idempotent actions that will create/modify, destroy, or reset a cache parameter group as needed.

diff --git a/plugins/modules/elb_classic_lb_info.py b/plugins/modules/elb_classic_lb_info.py
@@ -33,6 +33,7 @@
       - List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.
     type: list
     elements: str
+    default: []
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2