mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -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
|
@ -25,29 +25,21 @@ options:
|
|||
description:
|
||||
- "Name of the s3 bucket"
|
||||
required: true
|
||||
default: null
|
||||
error_key:
|
||||
description:
|
||||
- "The object key name to use when a 4XX class error occurs. To remove an error key, set to None."
|
||||
required: false
|
||||
default: null
|
||||
redirect_all_requests:
|
||||
description:
|
||||
- "Describes the redirect behavior for every request to this s3 bucket website endpoint"
|
||||
required: false
|
||||
default: null
|
||||
region:
|
||||
description:
|
||||
- >
|
||||
AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked,
|
||||
followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the
|
||||
S3 Location: US Standard.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- "Add or remove s3 website configuration"
|
||||
required: false
|
||||
default: present
|
||||
choices: [ 'present', 'absent' ]
|
||||
suffix:
|
||||
|
@ -56,7 +48,6 @@ options:
|
|||
Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to
|
||||
samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not include a slash
|
||||
character.
|
||||
required: false
|
||||
default: index.html
|
||||
|
||||
extends_documentation_fragment:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue