mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-02 06:19:10 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -38,19 +38,19 @@ options:
|
|||
purge_listeners:
|
||||
description:
|
||||
- Purge existing listeners on ELB that are not found in listeners
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
instance_ids:
|
||||
description:
|
||||
- List of instance ids to attach to this ELB
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
purge_instance_ids:
|
||||
description:
|
||||
- Purge existing instance ids on ELB that are not found in instance_ids
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
zones:
|
||||
description:
|
||||
|
@ -59,43 +59,31 @@ options:
|
|||
purge_zones:
|
||||
description:
|
||||
- Purge existing availability zones on ELB that are not found in zones
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
security_group_ids:
|
||||
description:
|
||||
- A list of security groups to apply to the elb
|
||||
required: false
|
||||
default: None
|
||||
version_added: "1.6"
|
||||
security_group_names:
|
||||
description:
|
||||
- A list of security group names to apply to the elb
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.0"
|
||||
health_check:
|
||||
description:
|
||||
- An associative array of health check configuration settings (see example)
|
||||
required: false
|
||||
default: None
|
||||
access_logs:
|
||||
description:
|
||||
- An associative array of access logs configuration settings (see example)
|
||||
required: false
|
||||
default: None
|
||||
version_added: "2.0"
|
||||
subnets:
|
||||
description:
|
||||
- A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
|
||||
required: false
|
||||
default: None
|
||||
aliases: []
|
||||
version_added: "1.7"
|
||||
purge_subnets:
|
||||
description:
|
||||
- Purge existing subnet on ELB that are not found in subnets
|
||||
required: false
|
||||
default: false
|
||||
default: 'no'
|
||||
version_added: "1.7"
|
||||
scheme:
|
||||
description:
|
||||
|
@ -103,60 +91,48 @@ options:
|
|||
If you choose to update your scheme with a different value the ELB will be destroyed and
|
||||
recreated. To update scheme you must use the option wait.
|
||||
choices: ["internal", "internet-facing"]
|
||||
required: false
|
||||
default: 'internet-facing'
|
||||
version_added: "1.7"
|
||||
validate_certs:
|
||||
description:
|
||||
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: ["yes", "no"]
|
||||
aliases: []
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "1.5"
|
||||
connection_draining_timeout:
|
||||
description:
|
||||
- Wait a specified timeout allowing connections to drain before terminating an instance
|
||||
required: false
|
||||
aliases: []
|
||||
version_added: "1.8"
|
||||
idle_timeout:
|
||||
description:
|
||||
- ELB connections from clients and to servers are timed out after this amount of time
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
cross_az_load_balancing:
|
||||
description:
|
||||
- Distribute load across all configured Availability Zones
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
aliases: []
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.8"
|
||||
stickiness:
|
||||
description:
|
||||
- An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example )
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
wait:
|
||||
description:
|
||||
- When specified, Ansible will check the status of the load balancer to ensure it has been successfully
|
||||
removed from AWS.
|
||||
required: false
|
||||
default: no
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
wait_timeout:
|
||||
description:
|
||||
- Used in conjunction with wait. Number of seconds to wait for the elb to be terminated.
|
||||
A maximum of 600 seconds (10 minutes) is allowed.
|
||||
required: false
|
||||
default: 60
|
||||
version_added: "2.1"
|
||||
tags:
|
||||
description:
|
||||
- An associative array of tags. To delete all tags, supply an empty dict.
|
||||
required: false
|
||||
version_added: "2.1"
|
||||
|
||||
extends_documentation_fragment:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue