mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-30 04:49:09 -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
|
@ -28,14 +28,12 @@ options:
|
|||
disable_rollback:
|
||||
description:
|
||||
- If a stacks fails to form, rollback will remove the stack
|
||||
required: false
|
||||
default: "false"
|
||||
choices: [ "true", "false" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
template_parameters:
|
||||
description:
|
||||
- a list of hashes of all the template variables for the stack. The value can be a string or a dict.
|
||||
Dict can be used to set additional template parameter attributes like UsePreviousValue (see example)
|
||||
required: false
|
||||
- A list of hashes of all the template variables for the stack. The value can be a string or a dict.
|
||||
- Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).
|
||||
default: {}
|
||||
state:
|
||||
description:
|
||||
|
@ -43,7 +41,6 @@ options:
|
|||
If state is "absent", stack will be removed.
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
required: false
|
||||
template:
|
||||
description:
|
||||
- The local path of the cloudformation template.
|
||||
|
@ -52,26 +49,18 @@ options:
|
|||
- If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url'
|
||||
must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template',
|
||||
'template_body' nor 'template_url' are specified, the previous template will be reused.
|
||||
required: false
|
||||
default: null
|
||||
notification_arns:
|
||||
description:
|
||||
- The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
stack_policy:
|
||||
description:
|
||||
- the path of the cloudformation stack policy. A policy cannot be removed once placed, but it can be modified.
|
||||
(for instance, [allow all updates](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051)
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.9"
|
||||
tags:
|
||||
description:
|
||||
- Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.4"
|
||||
template_url:
|
||||
description:
|
||||
|
@ -80,7 +69,6 @@ options:
|
|||
- If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url'
|
||||
must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template',
|
||||
'template_body' nor 'template_url' are specified, the previous template will be reused.
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
create_changeset:
|
||||
description:
|
||||
|
@ -88,16 +76,13 @@ options:
|
|||
See the AWS Change Sets docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html).
|
||||
WARNING: if the stack does not exist, it will be created without changeset. If the state is absent, the stack will be deleted immediately with no
|
||||
changeset."
|
||||
required: false
|
||||
default: false
|
||||
default: 'no'
|
||||
version_added: "2.4"
|
||||
changeset_name:
|
||||
description:
|
||||
- Name given to the changeset when creating a changeset, only used when create_changeset is true. By default a name prefixed with Ansible-STACKNAME
|
||||
is generated based on input parameters.
|
||||
See the AWS Change Sets docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html)
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
template_format:
|
||||
description:
|
||||
|
@ -105,14 +90,11 @@ options:
|
|||
This parameter is ignored since Ansible 2.3.
|
||||
default: json
|
||||
choices: [ json, yaml ]
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
role_arn:
|
||||
description:
|
||||
- The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation Service Role
|
||||
docs U(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html)
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.3"
|
||||
termination_protection:
|
||||
description:
|
||||
|
@ -124,7 +106,6 @@ options:
|
|||
- If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url'
|
||||
must be specified (but only one of them). If 'state' ispresent, the stack does exist, and neither 'template',
|
||||
'template_body' nor 'template_url' are specified, the previous template will be reused.
|
||||
required: false
|
||||
version_added: "2.5"
|
||||
|
||||
author: "James S. Martin (@jsmartin)"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue