You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

elasticache_snapshot - Manage cache snapshots in Amazon Elasticache.¶

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

Manage cache snapshots in Amazon Elasticache.
Returns information about the specified snapshot.

Requirements (on host that executes module)¶

boto3

botocore

Options ¶

parameter	required	default	choices	comments
bucket	no			The s3 bucket to which the snapshot is exported
cluster_id	no			The name of an existing cache cluster in the replication group to make the snapshot.
name	yes			The name of the snapshot we want to create, copy, delete
replication_id	no			The name of the existing replication group to make the snapshot.
state	no		present absent copy	Actions that will create, destroy, or copy a snapshot.
target	no			The name of a snapshot copy

Examples ¶

# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
---
- hosts: localhost
  connection: local
  tasks:
    - name: 'Create a snapshot'
      elasticache_snapshot:
        name: 'test-snapshot'
        state: 'present'
        cluster_id: '{{ cluster }}'
        replication_id: '{{ replication }}'

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
changed	if a snapshot has been created, deleted, or copied	always	bool	{'changed': True}
response_metadata	response metadata about the snapshot	always	dict	{'retry_attempts': 0, 'http_status_code': 200, 'http_headers': {'date': 'Tue, 07 Feb 2017 16:43:04 GMT', 'x-amzn-requestid': '7f436dea-ed54-11e6-a04c-ab2372a1f14d', 'content-length': 1490, 'content-type': 'text/xml'}, 'request_id': '7f436dea-ed54-11e6-a04c-ab2372a1f14d'}
snapshot	snapshot data	always	dict	{'engine': 'redis', 'cache_cluster_create_time': datetime.datetime(2017, 2, 1, 17, 43, 58, 261000, tzinfo=UTC+00:00), 'cache_cluster_id': 'test-please-delete', 'snapshot_name': 'deletesnapshot', 'node_snapshots': {'cache_size': None, 'cache_node_id': 1, 'cache_node_create_time': datetime.datetime(2017, 2, 1, 17, 43, 58, 261000, tzinfo=UTC+00:00)}, 'preferred_availability_zone': 'us-east-1d', 'auto_minor_version_upgrade': True, 'cache_subnet_group_name': 'default', 'port': 11211, 'num_cache_nodes': 1, 'snapshot_window': '10:00-11:00', 'engine_version': '3.2.4', 'cache_parameter_group_name': 'default.redis3.2', 'snapshot_retention_limit': 0, 'preferred_maintenance_window': 'wed:03:00-wed:04:00', 'cache_node_type': 'cache.m1.small', 'vpc_id': 'vpc-c248fda4', 'snapshot_source': 'manual', 'snapshot_status': 'creating'}

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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