ec2_snapshot: document wait, wait_timeout params
Document the wait and wait_timeout params for ec2_snapshot. This is important because snapshots can take a long time to complete, and the module defaults to wait=yes.
This commit is contained in:
parent
7f611468a8
commit
142fd9b06d
1 changed files with 14 additions and 1 deletions
|
@ -48,7 +48,20 @@ options:
|
||||||
- a hash/dictionary of tags to add to the snapshot
|
- a hash/dictionary of tags to add to the snapshot
|
||||||
required: false
|
required: false
|
||||||
version_added: "1.6"
|
version_added: "1.6"
|
||||||
|
wait:
|
||||||
|
description:
|
||||||
|
- wait for the snapshot to be ready
|
||||||
|
choices: ['yes', 'no']
|
||||||
|
required: false
|
||||||
|
default: yes
|
||||||
|
version_added: "1.5.1"
|
||||||
|
wait_timeout:
|
||||||
|
description:
|
||||||
|
- how long before wait gives up, in seconds
|
||||||
|
- specify 0 to wait forever
|
||||||
|
required: false
|
||||||
|
default: 0
|
||||||
|
version_added: "1.5.1"
|
||||||
author: Will Thames
|
author: Will Thames
|
||||||
extends_documentation_fragment: aws
|
extends_documentation_fragment: aws
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue