From 97b2ef6545dd454d4c26ed1e5a0f72f82c6a6205 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 2 Nov 2022 11:49:57 +0100 Subject: [PATCH] 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 --- api_gateway.py | 2 ++ autoscaling_launch_config.py | 1 + batch_job_definition.py | 5 +++++ cloudformation_stack_set.py | 1 + cloudfront_distribution.py | 1 + codecommit_repository.py | 1 + data_pipeline.py | 4 ++++ ec2_ami_copy.py | 1 + ec2_customer_gateway_info.py | 2 ++ ec2_snapshot_copy.py | 1 + ec2_transit_gateway_info.py | 2 ++ ec2_vpc_nacl.py | 1 + ec2_vpc_peering_info.py | 1 + ec2_vpc_vgw_info.py | 1 + ec2_vpc_vpn.py | 3 +++ ec2_vpc_vpn_info.py | 2 ++ ecs_service.py | 9 +++++++++ ecs_taskdefinition.py | 2 ++ efs.py | 1 + efs_info.py | 2 ++ eks_fargate_profile.py | 1 + elasticache.py | 5 +++++ elasticache_parameter_group.py | 1 + elb_classic_lb_info.py | 1 + iam_group.py | 2 ++ lightsail.py | 1 + msk_config.py | 2 ++ s3_bucket_notification.py | 4 ++++ s3_metrics_configuration.py | 1 + s3_sync.py | 2 ++ secretsmanager_secret.py | 1 + 31 files changed, 64 insertions(+) diff --git a/api_gateway.py b/api_gateway.py index 6627c762bd9..a084bf93eff 100644 --- a/api_gateway.py +++ b/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/autoscaling_launch_config.py b/autoscaling_launch_config.py index 59972a10e4b..1b13d1027d3 100644 --- a/autoscaling_launch_config.py +++ b/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/batch_job_definition.py b/batch_job_definition.py index 2af9093609e..0e5020da8a8 100644 --- a/batch_job_definition.py +++ b/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/cloudformation_stack_set.py b/cloudformation_stack_set.py index 2bb0befc0a4..3abf9734a32 100644 --- a/cloudformation_stack_set.py +++ b/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/cloudfront_distribution.py b/cloudfront_distribution.py index eff7971847c..12a6231f399 100644 --- a/cloudfront_distribution.py +++ b/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/codecommit_repository.py b/codecommit_repository.py index 5e05de9a61f..fce4d15d6e9 100644 --- a/codecommit_repository.py +++ b/codecommit_repository.py @@ -31,6 +31,7 @@ aliases: - comment type: str + default: '' state: description: - Specifies the state of repository. diff --git a/data_pipeline.py b/data_pipeline.py index d354a3c4e22..fc441c10cc7 100644 --- a/data_pipeline.py +++ b/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/ec2_ami_copy.py b/ec2_ami_copy.py index d88983f8452..15a69163d30 100644 --- a/ec2_ami_copy.py +++ b/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/ec2_customer_gateway_info.py b/ec2_customer_gateway_info.py index f6d15464089..429ba20839b 100644 --- a/ec2_customer_gateway_info.py +++ b/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/ec2_snapshot_copy.py b/ec2_snapshot_copy.py index 57de4e43bdc..455a7c6b85c 100644 --- a/ec2_snapshot_copy.py +++ b/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/ec2_transit_gateway_info.py b/ec2_transit_gateway_info.py index 8ee0705f8f0..5ce3dc6a46a 100644 --- a/ec2_transit_gateway_info.py +++ b/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/ec2_vpc_nacl.py b/ec2_vpc_nacl.py index 85f8d8baa92..e11df3de532 100644 --- a/ec2_vpc_nacl.py +++ b/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/ec2_vpc_peering_info.py b/ec2_vpc_peering_info.py index 3996596aec1..680fa3b68ba 100644 --- a/ec2_vpc_peering_info.py +++ b/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/ec2_vpc_vgw_info.py b/ec2_vpc_vgw_info.py index 3f07a735390..fcb520cf054 100644 --- a/ec2_vpc_vgw_info.py +++ b/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/ec2_vpc_vpn.py b/ec2_vpc_vpn.py index 462c662e51a..77a994aaab1 100644 --- a/ec2_vpc_vpn.py +++ b/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/ec2_vpc_vpn_info.py b/ec2_vpc_vpn_info.py index 94a6dcc9a91..c7a71f15451 100644 --- a/ec2_vpc_vpn_info.py +++ b/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/ecs_service.py b/ecs_service.py index 90785ee20c7..93abbe75a7b 100644 --- a/ecs_service.py +++ b/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,6 +69,7 @@ - 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 @@ -75,6 +77,7 @@ - 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":, "minimum_healthy_percent":} 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/ecs_taskdefinition.py b/ecs_taskdefinition.py index 6a994919855..246c9373933 100644 --- a/ecs_taskdefinition.py +++ b/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/efs.py b/efs.py index 7f855c6db2f..de1d563fb04 100644 --- a/efs.py +++ b/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/efs_info.py b/efs_info.py index eb1d23224d5..5ef436f3c91 100644 --- a/efs_info.py +++ b/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/eks_fargate_profile.py b/eks_fargate_profile.py index 0e6fabc0844..d78cbbe2d10 100644 --- a/eks_fargate_profile.py +++ b/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/elasticache.py b/elasticache.py index 75aedb9a301..454baafe3ec 100644 --- a/elasticache.py +++ b/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/elasticache_parameter_group.py b/elasticache_parameter_group.py index 24738eb1121..71ea159a14a 100644 --- a/elasticache_parameter_group.py +++ b/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/elb_classic_lb_info.py b/elb_classic_lb_info.py index 4b28fafd388..4cbeb95890d 100644 --- a/elb_classic_lb_info.py +++ b/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 diff --git a/iam_group.py b/iam_group.py index 0bc19d002ee..31987ef1de4 100644 --- a/iam_group.py +++ b/iam_group.py @@ -41,6 +41,7 @@ required: false type: list elements: str + default: [] aliases: ['managed_policy'] users: description: @@ -48,6 +49,7 @@ required: false type: list elements: str + default: [] state: description: - Create or remove the IAM group. diff --git a/lightsail.py b/lightsail.py index c01954a06b9..5e403515412 100644 --- a/lightsail.py +++ b/lightsail.py @@ -49,6 +49,7 @@ description: - Launch script that can configure the instance with additional data. type: str + default: '' key_pair_name: description: - Name of the key pair to use with the instance. diff --git a/msk_config.py b/msk_config.py index 2a51414aa67..812eba16dee 100644 --- a/msk_config.py +++ b/msk_config.py @@ -31,9 +31,11 @@ description: description: The description of the configuration. type: str + default: '' config: description: Contents of the server.properties file. type: dict + default: {} aliases: ['configuration'] kafka_versions: description: diff --git a/s3_bucket_notification.py b/s3_bucket_notification.py index 8df48fa56ed..645ca698974 100644 --- a/s3_bucket_notification.py +++ b/s3_bucket_notification.py @@ -74,6 +74,7 @@ - Version of the Lambda function. - Mutually exclusive with I(lambda_alias). type: int + default: 0 events: description: - Events that will be triggering a notification. You can select multiple events to send @@ -89,16 +90,19 @@ 's3:ObjectRestore:Completed', 's3:ReducedRedundancyLostObject'] type: list elements: str + default: [] prefix: description: - Optional prefix to limit the notifications to objects with keys that start with matching characters. type: str + default: '' suffix: description: - Optional suffix to limit the notifications to objects with keys that end with matching characters. type: str + default: '' extends_documentation_fragment: - amazon.aws.aws - amazon.aws.ec2 diff --git a/s3_metrics_configuration.py b/s3_metrics_configuration.py index 97eee52daed..dff5668212c 100644 --- a/s3_metrics_configuration.py +++ b/s3_metrics_configuration.py @@ -40,6 +40,7 @@ required: false aliases: ['filter_tag'] type: dict + default: {} state: description: - "Create or delete metrics configuration" diff --git a/s3_sync.py b/s3_sync.py index 686f7cee488..80e3db0bd89 100644 --- a/s3_sync.py +++ b/s3_sync.py @@ -53,6 +53,7 @@ - In addition to file path, prepend s3 path with this prefix. Module will add slash at end of prefix if necessary. required: false type: str + default: '' file_root: description: - File/directory path for synchronization. This is a local path. @@ -102,6 +103,7 @@ - Directives are separated by commas. required: false type: str + default: '' storage_class: description: - Storage class to be associated to each object added to the S3 bucket. diff --git a/secretsmanager_secret.py b/secretsmanager_secret.py index 453135e2412..c4c434e3252 100644 --- a/secretsmanager_secret.py +++ b/secretsmanager_secret.py @@ -40,6 +40,7 @@ description: - Specifies a user-provided description of the secret. type: str + default: '' kms_key_id: description: - Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be