Parameter |
Choices/Defaults |
Comments |
aws_access_key
|
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
|
aws_secret_key
|
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
|
delete_on_termination
bool
(added in 2.1) |
|
When set to "yes", the volume will be deleted upon instance termination.
|
device_name
|
|
device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows.
|
ec2_url
|
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
|
encrypted
(added in 1.8) |
Default:
"no"
|
Enable encryption at rest for this volume.
|
id
(added in 1.6) |
|
volume id if you wish to attach an existing volume (requires instance) or remove an existing volume
|
instance
|
|
instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.
|
iops
(added in 1.3) |
Default:
100
|
the provisioned IOPs you want to associate with this volume (integer).
|
kms_key_id
(added in 2.3) |
|
Specify the id of the KMS key to use.
|
name
(added in 1.6) |
|
volume Name tag if you wish to attach an existing volume (requires instance)
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
|
snapshot
(added in 1.5) |
|
snapshot ID on which to base the volume
|
state
(added in 1.6) |
Choices:
- absent
present ←
- list
|
whether to ensure the volume is present or absent, or to list existing volumes (The list option was added in version 1.8).
|
tags
(added in 2.3) |
Default:
{}
|
tag:value pairs to add to the volume after creation
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
volume_size
|
|
size of volume (in GB) to create.
|
volume_type
(added in 1.9) |
Default:
"standard"
|
Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). "Standard" is the old EBS default and continues to remain the Ansible default for backwards compatibility.
|
zone
|
|
zone in which to create the volume, if unset uses the zone the instance is in (if set)
aliases: aws_zone, ec2_zone
|