Note
This plugin is part of the amazon.aws collection (version 1.3.0).
To install it use: ansible-galaxy collection install amazon.aws
.
To use it in a playbook, specify: amazon.aws.ec2_vol
.
New in version 1.0.0: of amazon.aws
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key string | 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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key | |
aws_ca_bundle path | The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. | |
aws_config dictionary | A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. | |
aws_secret_key string | 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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key | |
debug_botocore_endpoint_logs boolean |
| Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. |
delete_on_termination boolean |
| When set to true , the volume will be deleted upon instance termination. |
device_name string | Device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows. | |
ec2_url string | 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. aliases: aws_endpoint_url, endpoint_url | |
encrypted boolean |
| Enable encryption at rest for this volume. |
id string | Volume id if you wish to attach an existing volume (requires instance) or remove an existing volume | |
instance string | Instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach. | |
iops integer | The provisioned IOPs you want to associate with this volume (integer). By default AWS will set this to 100. | |
kms_key_id string | Specify the id of the KMS key to use. | |
name string | Volume Name tag if you wish to attach an existing volume (requires instance) | |
profile string | Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile | |
region string | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
security_token string | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token | |
snapshot string | Snapshot ID on which to base the volume. | |
state string |
| Whether to ensure the volume is present or absent. The use of state=list to interrogate the volume has been deprecated and will be removed after 2022-06-01. The 'list' functionality has been moved to a dedicated module amazon.aws.ec2_vol_info. |
tags dictionary | Default: {} | tag:value pairs to add to the volume after creation. |
validate_certs boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
volume_size integer | Size of volume (in GiB) to create. | |
volume_type string |
| 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 string | Zone in which to create the volume, if unset uses the zone the instance is in (if set). aliases: availability_zone, aws_zone, ec2_zone |
Note
AWS_URL
or EC2_URL
, AWS_PROFILE
or AWS_DEFAULT_PROFILE
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
, AWS_CA_BUNDLE
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# Simple attachment action - amazon.aws.ec2_vol: instance: XXXXXX volume_size: 5 device_name: sdd region: us-west-2 # Example using custom iops params - amazon.aws.ec2_vol: instance: XXXXXX volume_size: 5 iops: 100 device_name: sdd region: us-west-2 # Example using snapshot id - amazon.aws.ec2_vol: instance: XXXXXX snapshot: "{{ snapshot }}" # Playbook example combined with instance launch - amazon.aws.ec2: keypair: "{{ keypair }}" image: "{{ image }}" wait: yes count: 3 register: ec2 - amazon.aws.ec2_vol: instance: "{{ item.id }}" volume_size: 5 loop: "{{ ec2.instances }}" register: ec2_vol # Example: Launch an instance and then add a volume if not already attached # * Volume will be created with the given name if not already created. # * Nothing will happen if the volume is already attached. # * Requires Ansible 2.0 - amazon.aws.ec2: keypair: "{{ keypair }}" image: "{{ image }}" zone: YYYYYY id: my_instance wait: yes count: 1 register: ec2 - amazon.aws.ec2_vol: instance: "{{ item.id }}" name: my_existing_volume_Name_tag device_name: /dev/xvdf loop: "{{ ec2.instances }}" register: ec2_vol # Remove a volume - amazon.aws.ec2_vol: id: vol-XXXXXXXX state: absent # Detach a volume (since 1.9) - amazon.aws.ec2_vol: id: vol-XXXXXXXX instance: None region: us-west-2 # List volumes for an instance - amazon.aws.ec2_vol: instance: i-XXXXXX state: list region: us-west-2 # Create new volume using SSD storage - amazon.aws.ec2_vol: instance: XXXXXX volume_size: 50 volume_type: gp2 device_name: /dev/xvdf # Attach an existing volume to instance. The volume will be deleted upon instance termination. - amazon.aws.ec2_vol: instance: XXXXXX id: XXXXXX device_name: /dev/sdf delete_on_termination: yes
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
device string | when success | device name of attached volume Sample: /def/sdf |
volume string | when success | a dictionary containing detailed attributes of the volume Sample: {'attachment_set': {'attach_time': '2015-10-23T00:22:29.000Z', 'deleteOnTermination': 'false', 'device': '/dev/sdf', 'instance_id': 'i-8356263c', 'status': 'attached'}, 'create_time': '2015-10-21T14:36:08.870Z', 'encrypted': False, 'id': 'vol-35b333d9', 'iops': None, 'size': 1, 'snapshot_id': '', 'status': 'in-use', 'tags': {'env': 'dev'}, 'type': 'standard', 'zone': 'us-east-1b'} |
volume_id string | when success | the id of volume Sample: vol-35b333d9 |
volume_type string | when success | the volume type Sample: standard |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/amazon/aws/ec2_vol_module.html