- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ec2_snapshot – creates a snapshot from an existing volume

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- creates an EC2 snapshot from an existing EBS volume

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6
- boto

## Parameters

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. aliases: ec2_access_key, access_key
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. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | 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.
description - |  | description to be applied to the snapshot
device_name - |  | device name of a mounted volume to be snapshotted
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.
instance_id - |  | instance that has the required volume to snapshot mounted
last_snapshot_min_age - | Default: 0 | If the volume's most recent snapshot has started less than `last_snapshot_min_age' minutes ago, a new snapshot will not be created.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
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. aliases: access_token
snapshot_id - |  | snapshot id to remove
snapshot_tags - |  | a hash/dictionary of tags to add to the snapshot
state - | Choices: absent present ← | whether to add or create a snapshot
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
volume_id - |  | volume from which to take the snapshot
wait boolean | Choices: no yes ← | wait for the snapshot to be ready
wait_timeout - | Default: 0 | how long before wait gives up, in seconds specify 0 to wait forever

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `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`
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- `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

## Examples

    # Simple snapshot of volume using volume_id
    - ec2_snapshot:
        volume_id: vol-abcdef12
        description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

    # Snapshot of volume mounted on device_name attached to instance_id
    - ec2_snapshot:
        instance_id: i-12345678
        device_name: /dev/sdb1
        description: snapshot of /data from DB123 taken 2013/11/28 12:18:32

    # Snapshot of volume with tagging
    - ec2_snapshot:
        instance_id: i-12345678
        device_name: /dev/sdb1
        snapshot_tags:
            frequency: hourly
            source: /data

    # Remove a snapshot
    - local_action:
        module: ec2_snapshot
        snapshot_id: snap-abcd1234
        state: absent

    # Create a snapshot only if the most recent one is older than 1 hour
    - local_action:
        module: ec2_snapshot
        volume_id: vol-abcdef12
        last_snapshot_min_age: 60

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Core Team. [core]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Will Thames (@willthames)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.