community.aws.elasticache_info module – Retrieve information for AWS ElastiCache clusters
Note
This module is part of the community.aws collection (version 3.6.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.elasticache_info
.
New in community.aws 1.0.0
Synopsis
Retrieve information from AWS ElastiCache clusters
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
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. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. 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. |
|
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. |
|
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. Choices:
|
|
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. |
|
The name of an ElastiCache cluster. |
|
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. |
|
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 |
|
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_session_token and session_token have been added in version 3.2.0. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
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 |
Description |
---|---|
List of ElastiCache clusters Returned: always |
|
Whether to automatically upgrade to minor versions Returned: always Sample: |
|
Date and time cluster was created Returned: always Sample: |
|
ID of the cache cluster Returned: always Sample: |
|
Status of ElastiCache cluster Returned: always Sample: |
|
Instance type of ElastiCache nodes Returned: always Sample: |
|
List of ElastiCache nodes in the cluster Returned: always |
|
Date and time node was created Returned: always Sample: |
|
ID of the cache node Returned: always Sample: |
|
Status of the cache node Returned: always Sample: |
|
Availability Zone in which the cache node was created Returned: always Sample: |
|
Connection details for the cache node Returned: always |
|
URL of the cache node endpoint Returned: always Sample: |
|
Port of the cache node endpoint Returned: always Sample: |
|
Status of the Cache Parameter Group Returned: always Sample: |
|
Contents of the Cache Parameter Group Returned: always |
|
Cache nodes which need to be rebooted for parameter changes to be applied Returned: always Sample: |
|
Name of the cache parameter group Returned: always Sample: |
|
Status of parameter updates Returned: always Sample: |
|
Security Groups used by the cache Returned: always Sample: |
|
ElastiCache Subnet Group used by the cache Returned: always Sample: |
|
URL of client download web page Returned: always Sample: |
|
Engine used by ElastiCache Returned: always Sample: |
|
Version of ElastiCache engine Returned: always Sample: |
|
Configuration of notifications Returned: if notifications are enabled |
|
ARN of notification destination topic Returned: if notifications are enabled Sample: |
|
Name of notification destination topic Returned: if notifications are enabled Sample: |
|
Number of Cache Nodes Returned: always Sample: |
|
Values that are pending modification Returned: always |
|
Preferred Availability Zone Returned: always Sample: |
|
Time slot for preferred maintenance window Returned: always Sample: |
|
Replication Group Id Returned: always Sample: |
|
List of Security Groups associated with ElastiCache Returned: always |
|
Security Group ID Returned: always Sample: |
|
Status of Security Group Returned: always Sample: |
|
Tags applied to the ElastiCache cluster Returned: always Sample: |