Fix non-matching defaults in docs (ansible-collections#1226)

Fix non-matching defaults in docs SUMMARY Fix various non-matching default values exposed by ansible/ansible#79267. ISSUE TYPE Docs Pull Request COMPONENT NAME various Reviewed-by: Alina Buzachis <None>
abikouo · Nov 1, 2022 · 9b569d3 · 9b569d3
1 parent b35fbc8
commit 9b569d3
Show file tree

Hide file tree

Showing 31 changed files with 45 additions and 3 deletions.
diff --git a/changelogs/fragments/1226-defaults.yml b/changelogs/fragments/1226-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/amazon.aws/pull/1226)."
diff --git a/plugins/modules/autoscaling_group.py b/plugins/modules/autoscaling_group.py
@@ -193,6 +193,7 @@
         matching the current launch configuration.
     type: list
     elements: str
+    default: []
   detach_instances:
     description:
       - Removes one or more instances from the specified AutoScalingGroup.
@@ -201,6 +202,7 @@
       - If there are target groups attached to the AutoScalingGroup, the instances are also deregistered from the target groups.
     type: list
     elements: str
+    default: []
     version_added: 3.2.0
     version_added_collection: community.aws
   decrement_desired_capacity:
@@ -233,6 +235,7 @@
       - When I(propagate_at_launch) is true the tags will be propagated to the Instances created.
     type: list
     elements: dict
+    default: []
   purge_tags:
     description:
       - If C(true), existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter.

diff --git a/plugins/modules/cloudtrail_info.py b/plugins/modules/cloudtrail_info.py
@@ -18,6 +18,7 @@
   trail_names:
     type: list
     elements: str
+    default: []
     description:
       - Specifies a list of trail names, trail ARNs, or both, of the trails to describe.
       - If an empty list is specified, information for the trail in the current region is returned.

diff --git a/plugins/modules/cloudwatch_metric_alarm.py b/plugins/modules/cloudwatch_metric_alarm.py
@@ -57,6 +57,7 @@
         required: false
         version_added: "5.1.0"
         elements: dict
+        default: []
         suboptions:
             id:
                 description:
@@ -222,18 +223,21 @@
         required: false
         type: list
         elements: str
+        default: []
     insufficient_data_actions:
         description:
           - A list of the names of action(s) to take when the alarm is in the C(insufficient_data) status.
         required: false
         type: list
         elements: str
+        default: []
     ok_actions:
         description:
           - A list of the names of action(s) to take when the alarm is in the C(ok) status, denoted as Amazon Resource Name(s).
         required: false
         type: list
         elements: str
+        default: []
     treat_missing_data:
         description:
           - Sets how the alarm handles missing data points.

diff --git a/plugins/modules/cloudwatchevent_rule.py b/plugins/modules/cloudwatchevent_rule.py
@@ -66,6 +66,7 @@
   targets:
     type: list
     elements: dict
+    default: []
     description:
       - A list of targets to add to or update for the rule.
     suboptions:

diff --git a/plugins/modules/ec2_ami.py b/plugins/modules/ec2_ami.py
@@ -60,6 +60,7 @@
     description:
       - Human-readable string describing the contents and purpose of the AMI.
     type: str
+    default: ''
   no_reboot:
     description:
       - Flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the

diff --git a/plugins/modules/ec2_ami_info.py b/plugins/modules/ec2_ami_info.py
@@ -21,25 +21,29 @@
     aliases: [image_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_DescribeImages.html) for possible filters.
       - Filter names and values are case sensitive.
     type: dict
+    default: {}
   owners:
     description:
       - Filter the images by the owner. Valid options are an AWS account ID, self,
         or an AWS owner alias ( amazon | aws-marketplace | microsoft ).
     aliases: [owner]
     type: list
     elements: str
+    default: []
   executable_users:
     description:
       - Filter images by users with explicit launch permissions. Valid options are an AWS account ID, self, or all (public AMIs).
     aliases: [executable_user]
     type: list
     elements: str
+    default: []
   describe_image_attributes:
     description:
       - Describe attributes (like launchPermission) of the images found.

diff --git a/plugins/modules/ec2_eni.py b/plugins/modules/ec2_eni.py
@@ -46,6 +46,7 @@
       - Ignored when I(state=absent).
     type: list
     elements: str
+    default: []
   state:
     description:
       - Create or delete ENI.

diff --git a/plugins/modules/ec2_instance.py b/plugins/modules/ec2_instance.py
@@ -25,6 +25,7 @@
       - Mutually exclusive with I(exact_count).
     type: list
     elements: str
+    default: []
   state:
     description:
       - Goal state for the instances.
@@ -143,6 +144,7 @@
       - Mutually exclusive with I(security_group).
     type: list
     elements: str
+    default: []
   security_group:
     description:
       - A security group ID or name.

diff --git a/plugins/modules/ec2_instance_info.py b/plugins/modules/ec2_instance_info.py
@@ -23,6 +23,7 @@
     required: false
     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

diff --git a/plugins/modules/ec2_snapshot.py b/plugins/modules/ec2_snapshot.py
@@ -41,6 +41,7 @@
         snapshot.
     type: dict
     required: false
+    default: {}
   wait:
     description:
       - Wait for the snapshot to be ready.

diff --git a/plugins/modules/ec2_spot_instance.py b/plugins/modules/ec2_spot_instance.py
@@ -130,6 +130,7 @@
           - One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
         type: list
         elements: dict
+        default: []
         suboptions:
           associate_public_ip_address:
             description:
@@ -279,7 +280,6 @@
   spot_instance_request_ids:
     description:
       - List of strings with IDs of spot requests to be cancelled
-    default: []
     type: list
     elements: str
 extends_documentation_fragment:

diff --git a/plugins/modules/ec2_spot_instance_info.py b/plugins/modules/ec2_spot_instance_info.py
@@ -30,6 +30,7 @@
     required: false
     type: list
     elements: str
+    default: []
 
 extends_documentation_fragment:
 - amazon.aws.aws

diff --git a/plugins/modules/ec2_vol_info.py b/plugins/modules/ec2_vol_info.py
@@ -17,6 +17,7 @@
 options:
   filters:
     type: dict
+    default: {}
     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_DescribeVolumes.html) for possible filters.

diff --git a/plugins/modules/ec2_vpc_dhcp_option_info.py b/plugins/modules/ec2_vpc_dhcp_option_info.py
@@ -20,6 +20,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_DescribeDhcpOptions.html) for possible filters.
     type: dict
+    default: {}
   dhcp_options_ids:
     description:
       - Get details of specific DHCP option IDs.

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

diff --git a/plugins/modules/ec2_vpc_endpoint_service_info.py b/plugins/modules/ec2_vpc_endpoint_service_info.py
@@ -19,6 +19,7 @@
         See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpointServices.html)
         for possible filters.
     type: dict
+    default: {}
   service_names:
     description:
       - A list of service names which can be used to narrow the search results.

diff --git a/plugins/modules/ec2_vpc_igw_info.py b/plugins/modules/ec2_vpc_igw_info.py
@@ -20,6 +20,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_DescribeInternetGateways.html) for possible filters.
     type: dict
+    default: {}
   internet_gateway_ids:
     description:
       - Get details of specific Internet Gateway ID. Provide this value as a list.

diff --git a/plugins/modules/ec2_vpc_nat_gateway_info.py b/plugins/modules/ec2_vpc_nat_gateway_info.py
@@ -18,12 +18,14 @@
       - List of specific nat gateway IDs to fetch details for.
     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_DescribeNatGateways.html)
         for possible filters.
     type: dict
+    default: {}
 author: Karen Cheng (@Etherdaemon)
 extends_documentation_fragment:
 - amazon.aws.aws

diff --git a/plugins/modules/ec2_vpc_net_info.py b/plugins/modules/ec2_vpc_net_info.py
@@ -20,11 +20,13 @@
       - A list of VPC IDs that exist in your account.
     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_DescribeVpcs.html) for possible filters.
     type: dict
+    default: {}
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2

diff --git a/plugins/modules/ec2_vpc_route_table.py b/plugins/modules/ec2_vpc_route_table.py
@@ -66,6 +66,7 @@
       - Routes are required for present states.
     type: list
     elements: dict
+    default: []
   state:
     description: Create or destroy the VPC route table.
     default: present

diff --git a/plugins/modules/ec2_vpc_subnet.py b/plugins/modules/ec2_vpc_subnet.py
@@ -33,12 +33,14 @@
       - The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range.
       - Required if I(assign_instances_ipv6=true)
     type: str
+    default: ''
   outpost_arn:
     description:
       - The Amazon Resource Name (ARN) of the Outpost.
       - If set, allows to create subnet in an Outpost.
       - If I(outpost_arn) is set, I(az) must also be specified.
     type: str
+    default: ''
   state:
     description:
       - Create or remove the subnet.
@@ -72,6 +74,8 @@
       - Ignored unless I(wait=True).
     default: 300
     type: int
+  tags:
+    default: {}
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2

diff --git a/plugins/modules/ec2_vpc_subnet_info.py b/plugins/modules/ec2_vpc_subnet_info.py
@@ -21,11 +21,13 @@
     aliases: ['subnet_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_DescribeSubnets.html) for possible filters.
     type: dict
+    default: {}
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2

diff --git a/plugins/modules/iam_user.py b/plugins/modules/iam_user.py
@@ -62,6 +62,7 @@
     required: false
     type: list
     elements: str
+    default: []
     aliases: ['managed_policy']
   state:
     description:

diff --git a/plugins/modules/kms_key.py b/plugins/modules/kms_key.py
@@ -89,6 +89,7 @@
       - 'U(https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kms.html#KMS.Client.create_grant)'
     type: list
     elements: dict
+    default: []
     suboptions:
         grantee_principal:
             description: The full ARN of the principal being granted permissions.

diff --git a/plugins/modules/lambda.py b/plugins/modules/lambda.py
@@ -68,6 +68,7 @@
     description:
       - A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.
     type: str
+    default: ''
   timeout:
     description:
       - The function maximum execution time in seconds after which Lambda should terminate the function.

diff --git a/plugins/modules/lambda_alias.py b/plugins/modules/lambda_alias.py
@@ -48,6 +48,7 @@
          A value of 0 (or omitted parameter) sets the alias to the $LATEST version.
     aliases: ['version']
     type: int
+    default: 0
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2

diff --git a/plugins/modules/lambda_event.py b/plugins/modules/lambda_event.py
@@ -45,6 +45,7 @@
       - Version of the Lambda function.
       - Mutually exclusive with I(alias).
     type: int
+    default: 0
   event_source:
     description:
       - Source of the event that triggers the lambda function.

diff --git a/plugins/modules/rds_cluster.py b/plugins/modules/rds_cluster.py
@@ -85,7 +85,6 @@
         description:
           - The target backtrack window, in seconds. To disable backtracking, set this value to C(0).
           - If specified, this value must be set to a number from C(0) to C(259,200) (72 hours).
-        default: 0
         type: int
     backup_retention_period:
         description:

diff --git a/plugins/modules/rds_option_group_info.py b/plugins/modules/rds_option_group_info.py
@@ -27,7 +27,6 @@
         description:
             - If this parameter is specified, the response includes only records beyond the marker, up to the value specified by I(max_records).
             - Allowed values are between C(20) and C(100).
-        default: ''
         required: false
         type: str
     max_records:

diff --git a/plugins/modules/s3_object.py b/plugins/modules/s3_object.py
@@ -63,6 +63,7 @@
       - Specifies the key to start with when using list mode. Object keys are returned in
         alphabetical order, starting with key after the marker in order.
     type: str
+    default: ''
   max_keys:
     description:
       - Max number of results to return when I(mode=list), set this if you want to retrieve fewer
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		trivial:
		- "Fixed ``default`` values in various modules so that documentation and argument spec coincide (https://github.com/ansible-collections/amazon.aws/pull/1226)."