Documentation

ec2_snapshot - creates a snapshot from an existing volume

New in version 1.5.

Synopsis

creates an EC2 snapshot from an existing EBS volume

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
 no
    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
    		 no
      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
      description
      		 no
        description to be applied to the snapshot
        device_name
        		 no
          device name of a mounted volume to be snapshotted
          ec2_url
          		 no
            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
            		 no
              instance that has the required volume to snapshot mounted
              last_snapshot_min_age
              (added in 2.0)
              		 no
                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
                (added in 1.6)
                		 no
                  uses a boto profile. Only works with boto >= 2.24.0
                  region
                  		 no
                    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
                    (added in 1.6)
                    		 no
                      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
                      (added in 1.9)
                      		 no
                        snapshot id to remove
                        snapshot_tags
                        (added in 1.6)
                        		 no
                          a hash/dictionary of tags to add to the snapshot
                          state
                          (added in 1.9)
                          		 no present
                          • absent
                          • present
                          whether to add or create a snapshot
                          validate_certs
                          (added in 1.5)
                          		 no yes
                          • yes
                          • no
                          When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                          volume_id
                          		 no
                            volume from which to take the snapshot
                            wait
                            (added in 1.5.1)
                            		 no True
                            • yes
                            • no
                            wait for the snapshot to be ready
                            wait_timeout
                            (added in 1.5.1)
                            		 no
                              how long before wait gives up, in seconds
                              specify 0 to wait forever

                              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

                              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

                              Note

                              Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                              Note

                              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

                              This is a Core Module

                              For more information on what this means please read Core Modules

                              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.