amazon.aws.ec2_snapshot module – Creates a snapshot from an existing volume
Note
This module is part of the amazon.aws collection (version 7.6.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_snapshot.
New in amazon.aws 1.0.0
Synopsis
Creates an EC2 snapshot from an existing EBS volume.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.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:
|
|
Description to be applied to the snapshot. |
|
Device name of a mounted volume to be snapshotted. |
|
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 |
|
The group to be added or removed. The possible value is Mutually exclusive with user_ids. Choices:
|
|
Instance that has the required volume to snapshot mounted. |
|
If the volume’s most recent snapshot has started less than last_snapshot_min_age minutes ago, a new snapshot will not be created. Default: |
|
If set to Choices:
|
|
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. |
|
Whether unspecified group names or user IDs should be removed from the snapshot createVolumePermission. Must set modify_create_vol_permission to 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 to remove. |
|
A dictionary of tags to add to the snapshot. If the volume has a Default: |
|
Whether to add or create a snapshot. Choices:
|
|
The account user IDs to be added or removed. If createVolumePermission on snapshot is currently set to Public i.e. group_names=all, providing user_ids will not make createVolumePermission Private unless create_volume_permission is set to Mutually exclusive with group_names. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Volume from which to take the snapshot. |
|
Wait for the snapshot to be ready. Choices:
|
|
How long before wait gives up, in seconds. Default: |
Notes
Note
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 snapshot of volume using volume_id
- amazon.aws.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
- amazon.aws.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
- amazon.aws.ec2_snapshot:
instance_id: i-12345678
device_name: /dev/sdb1
snapshot_tags:
frequency: hourly
source: /data
# Remove a snapshot
- amazon.aws.ec2_snapshot:
snapshot_id: snap-abcd1234
state: absent
# Create a snapshot only if the most recent one is older than 1 hour
- amazon.aws.ec2_snapshot:
volume_id: vol-abcdef12
last_snapshot_min_age: 60
- name: Reset snapshot createVolumePermission (change permission to "Private")
amazon.aws.ec2_snapshot:
snapshot_id: snap-06a6f641234567890
modify_create_vol_permission: true
purge_create_vol_permission: true
- name: Modify snapshot createVolmePermission to add user IDs (specify purge_create_vol_permission=true to change permssion to "Private")
amazon.aws.ec2_snapshot:
snapshot_id: snap-06a6f641234567890
modify_create_vol_permission: true
user_ids:
- '123456789012'
- '098765432109'
- name: Modify snapshot createVolmePermission - remove all except specified user_ids
amazon.aws.ec2_snapshot:
snapshot_id: snap-06a6f641234567890
modify_create_vol_permission: true
purge_create_vol_permission: true
user_ids:
- '123456789012'
- name: Replace (purge existing) snapshot createVolmePermission annd add user IDs
amazon.aws.ec2_snapshot:
snapshot_id: snap-06a6f641234567890
modify_create_vol_permission: true
purge_create_vol_permission: true
user_ids:
- '111111111111'
- name: Modify snapshot createVolmePermission - make createVolumePermission "Public"
amazon.aws.ec2_snapshot:
snapshot_id: snap-06a6f641234567890
modify_create_vol_permission: true
purge_create_vol_permission: true
group_names:
- all
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The ID of the snapshot. Each snapshot receives a unique identifier when it is created. Returned: always Sample: |
|
Any tags assigned to the snapshot. Returned: always Sample: |
|
The ID of the volume that was used to create the snapshot. Returned: always Sample: |
|
The size of the volume, in GiB. Returned: always Sample: |