W3cubDocs

/Ansible

community.aws.elasticache_info – Retrieve information for AWS ElastiCache clusters

Note

This plugin is part of the community.aws collection (version 1.5.0).

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 community.aws.

To use it in a playbook, specify: community.aws.elasticache_info.

New in version 1.0.0: of community.aws

Synopsis

  • Retrieve information from AWS ElastiCache clusters
  • This module was called elasticache_facts before Ansible 2.9. The usage did not change.

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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    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.
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.

aliases: aws_endpoint_url, endpoint_url
name
string
The name of an ElastiCache cluster.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
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.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
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_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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

- name: obtain all ElastiCache information
  community.aws.elasticache_info:

- name: obtain all information for a single ElastiCache cluster
  community.aws.elasticache_info:
    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
boolean
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
integer
always
Port of the cache node endpoint

Sample:
6379
parameter_group_status
string
always
Status of the Cache Parameter Group

Sample:
in-sync
cache_parameter_group
complex
always
Contents of the Cache Parameter Group
cache_node_ids_to_reboot
list / elements=string
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 / elements=string
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
integer
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'}


Authors

  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/elasticache_info_module.html