amazon.aws.ec2_vol module – Create and attach a volume, return volume ID and device map
Note
This module is part of the amazon.aws collection (version 5.5.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.ec2_vol.
New in amazon.aws 1.0.0
Synopsis
Creates an EBS volume and optionally attaches it to an instance.
If both instance and name are given and the instance has a device at the device name, then no volume is created and no attachment is made.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
When set to Choices:
|
|
Device ID to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf for Windows. |
|
Enable encryption at rest for this volume. Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Volume ID if you wish to attach an existing volume (requires instance) or remove an existing volume. |
|
Instance ID if you wish to attach the volume. Set to |
|
The provisioned IOPs you want to associate with this volume (integer). |
|
Specify the ID of the KMS key to use. |
|
The volume won’t be modified unless this key is Choices:
|
|
If set to When you create a new volume, Multi-Attach is disabled by default. This parameter is supported with io1 and io2 volumes only. Choices:
|
|
Volume Name tag if you wish to attach an existing volume (requires instance). |
|
The Amazon Resource Name (ARN) of the Outpost. If set, allows to create volume in an Outpost. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Snapshot ID on which to base the volume. |
|
Whether to ensure the volume is present or absent. state=list was deprecated in release 1.1.0 and is no longer available with release 4.0.0. The Choices:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
Volume throughput in MB/s. This parameter is only valid for gp3 volumes. Valid range is from 125 to 1000. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Size of volume (in GiB) to create. |
|
Type of EBS volume;
Choices:
|
|
Zone in which to create the volume, if unset uses the zone the instance is in (if set). |
Notes
Note
Support for purge_tags was added in release 1.5.0.
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# 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: true
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.
- amazon.aws.ec2:
keypair: "{{ keypair }}"
image: "{{ image }}"
zone: YYYYYY
id: my_instance
wait: true
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
# Create new volume using SSD storage
- amazon.aws.ec2_vol:
instance: XXXXXX
volume_size: 50
volume_type: gp2
device_name: /dev/xvdf
# Create new volume with multi-attach enabled
- amazon.aws.ec2_vol:
zone: XXXXXX
multi_attach: true
volume_size: 4
volume_type: io1
iops: 102
# 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: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
device name of attached volume Returned: when success Sample: |
|
a dictionary containing detailed attributes of the volume Returned: when success Sample: |
|
the id of volume Returned: when success Sample: |
|
the volume type Returned: when success Sample: |