Update ec2_ami.py (#19636)
- Consistent capitalisation in the descriptions - Removed redundant 'optional' notes when this is covered by the Boolean `optional` column - Clarified `instance_id` description
This commit is contained in:
parent
ba9f6326f4
commit
7ba746dc1e
1 changed files with 12 additions and 11 deletions
|
@ -28,37 +28,38 @@ description:
|
||||||
options:
|
options:
|
||||||
instance_id:
|
instance_id:
|
||||||
description:
|
description:
|
||||||
- instance id of the image to create
|
- Instance ID to create the AMI from.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name of the new image to create
|
- The name of the new AMI.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
wait:
|
wait:
|
||||||
description:
|
description:
|
||||||
- wait for the AMI to be in state 'available' before returning.
|
- Wait for the AMI to be in state 'available' before returning.
|
||||||
required: false
|
required: false
|
||||||
default: "no"
|
default: "no"
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
wait_timeout:
|
wait_timeout:
|
||||||
description:
|
description:
|
||||||
- how long before wait gives up, in seconds
|
- How long before wait gives up, in seconds.
|
||||||
default: 300
|
default: 300
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- create or deregister/delete image
|
- Create or deregister/delete AMI.
|
||||||
required: false
|
required: false
|
||||||
default: 'present'
|
default: 'present'
|
||||||
|
choices: [ "absent", "present" ]
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- An optional human-readable string describing the contents and purpose of the AMI.
|
- Human-readable string describing the contents and purpose of the AMI.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
no_reboot:
|
no_reboot:
|
||||||
description:
|
description:
|
||||||
- An optional flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the responsibility of maintaining file system integrity is left to the owner of the instance. The default choice is "no".
|
- Flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the responsibility of maintaining file system integrity is left to the owner of the instance.
|
||||||
required: false
|
required: false
|
||||||
default: no
|
default: no
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
|
@ -70,25 +71,25 @@ options:
|
||||||
device_mapping:
|
device_mapping:
|
||||||
version_added: "2.0"
|
version_added: "2.0"
|
||||||
description:
|
description:
|
||||||
- An optional list of device hashes/dictionaries with custom configurations (same block-device-mapping parameters)
|
- List of device hashes/dictionaries with custom configurations (same block-device-mapping parameters)
|
||||||
- "Valid properties include: device_name, volume_type, size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type)"
|
- "Valid properties include: device_name, volume_type, size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type)"
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
delete_snapshot:
|
delete_snapshot:
|
||||||
description:
|
description:
|
||||||
- Whether or not to delete snapshots when deregistering AMI.
|
- Delete snapshots when deregistering the AMI.
|
||||||
required: false
|
required: false
|
||||||
default: "no"
|
default: "no"
|
||||||
choices: [ "yes", "no" ]
|
choices: [ "yes", "no" ]
|
||||||
tags:
|
tags:
|
||||||
description:
|
description:
|
||||||
- a dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'
|
- A dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
version_added: "2.0"
|
version_added: "2.0"
|
||||||
launch_permissions:
|
launch_permissions:
|
||||||
description:
|
description:
|
||||||
- Users and groups that should be able to launch the ami. Expects
|
- Users and groups that should be able to launch the AMI. Expects
|
||||||
dictionary with a key of user_ids and/or group_names. user_ids should
|
dictionary with a key of user_ids and/or group_names. user_ids should
|
||||||
be a list of account ids. group_name should be a list of groups, "all"
|
be a list of account ids. group_name should be a list of groups, "all"
|
||||||
is the only acceptable value currently.
|
is the only acceptable value currently.
|
||||||
|
|
Loading…
Reference in a new issue