elasticache_facts - Retrieve facts for AWS Elasticache clusters
New in version 2.5.
Synopsis
- Retrieve facts from AWS Elasticache clusters
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 |
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 |
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 |
|
| ec2_url |
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.
|
|
| name |
The name of an Elasticache cluster
|
|
| profile
(added in 1.6)
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
| region |
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)
|
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 |
|
| validate_certs
bool
(added in 1.5)
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Notes
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples
- name: obtain all Elasticache facts
elasticache_facts:
- name: obtain all facts for a single Elasticache cluster
elasticache_facts:
name: test_elasticache
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
| elasticache_clusters
complex
|
always |
List of elasticache clusters
|
|||
| auto_minor_version_upgrade
bool
|
always |
Whether to automatically upgrade to minor versions
Sample:
True
|
|||
| cache_cluster_create_time
string
|
always |
Date and time cluster was created
Sample:
2017-09-15T05:43:46.038000+00:00
|
|||
| cache_cluster_id
string
|
always |
ID of the cache cluster
Sample:
abcd-1234-001
|
|||
| cache_cluster_status
string
|
always |
Status of Elasticache cluster
Sample:
available
|
|||
| cache_node_type
string
|
always |
Instance type of Elasticache nodes
Sample:
cache.t2.micro
|
|||
| cache_nodes
complex
|
always |
List of Elasticache nodes in the cluster
|
|||
| cache_node_create_time
string
|
always |
Date and time node was created
Sample:
2017-09-15T05:43:46.038000+00:00
|
|||
| cache_node_id
string
|
always |
ID of the cache node
Sample:
0001
|
|||
| cache_node_status
string
|
always |
Status of the cache node
Sample:
available
|
|||
| customer_availability_zone
string
|
always |
Availability Zone in which the cache node was created
Sample:
ap-southeast-2b
|
|||
| endpoint
complex
|
always |
Connection details for the cache node
|
|||
| address
string
|
always |
URL of the cache node endpoint
Sample:
abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com
|
|||
| port
int
|
always |
Port of the cache node endpoint
Sample:
6379
|
|||
| parameter_grou_status
string
|
always |
Status of the Cache Parameter Group
Sample:
in-sync
|
|||
| cache_parameter_group
complex
|
always |
Contents of the Cache Parameter GGroup
|
|||
| cache_node_ids_to_reboot
list
|
always |
Cache nodes which need to be rebooted for parameter changes to be applied
|
|||
| cache_parameter_group_name
string
|
always |
Name of the cache parameter group
Sample:
default.redis3.2
|
|||
| parameter_apply_status
string
|
always |
Status of parameter updates
Sample:
in-sync
|
|||
| cache_security_groups
list
|
always |
Security Groups used by the cache
Sample:
['sg-abcd1234']
|
|||
| cache_subnet_group_name
string
|
always |
Elasticache Subnet Group used by the cache
Sample:
abcd-subnet-group
|
|||
| client_download_landing_page
string
|
always |
URL of client download web page
Sample:
https://console.aws.amazon.com/elasticache/home#client-download:
|
|||
| engine
string
|
always |
Engine used by elasticache
Sample:
redis
|
|||
| engine_version
string
|
always |
Version of elasticache engine
Sample:
3.2.4
|
|||
| notification_configuration
complex
|
if notifications are enabled |
Configuration of notifications
|
|||
| topic_arn
string
|
if notifications are enabled |
ARN of notification destination topic
Sample:
arn:aws:sns:*:123456789012:my_topic
|
|||
| topic_name
string
|
if notifications are enabled |
Name of notification destination topic
Sample:
MyTopic
|
|||
| num_cache_nodes
int
|
always |
Number of Cache Nodes
Sample:
1
|
|||
| pending_modified_values
complex
|
always |
Values that are pending modification
|
|||
| preferred_availability_zone
string
|
always |
Preferred Availability Zone
Sample:
ap-southeast-2b
|
|||
| preferred_maintenance_window
string
|
always |
Time slot for preferred maintenance window
Sample:
sat:12:00-sat:13:00
|
|||
| replication_group_id
string
|
always |
Replication Group Id
Sample:
replication-001
|
|||
| security_groups
complex
|
always |
List of Security Groups associated with Elasticache
|
|||
| security_group_id
string
|
always |
Security Group ID
Sample:
sg-abcd1234
|
|||
| status
string
|
always |
Status of Security Group
Sample:
active
|
|||
| tags
complex
|
always |
Tags applied to the elasticache cluster
Sample:
{'Application': 'web', 'Environment': 'test'}
|
|||
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Will Thames (@willthames)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/elasticache_facts_module.html