community.aws.elasticache_info module – Retrieve information for AWS ElastiCache clusters
Note
This module is part of the community.aws collection (version 8.0.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.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:
|
|
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 name of an ElastiCache cluster. |
|
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. |
|
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 |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
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
- 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 |
|
ARN of the cache cluster. Returned: always Sample: |
|
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: |
|
Informations about the associated replication group. Returned: if replication is enabled |
|
The ARN (Amazon Resource Name) of the replication group. Returned: always |
|
A flag that enables encryption at-rest when set to true. Returned: always |
|
A flag that enables using an AuthToken (password) when issuing Redis commands. Returned: always |
|
Indicates the status of automatic failover for this Redis replication group. Returned: always Sample: |
|
The name of the compute and memory capacity node type for each node in the replication group. Returned: always Sample: |
|
A flag indicating whether or not this replication group is cluster enabled. Returned: always |
|
The user supplied description of the replication group. Returned: always |
|
The name of the Global datastore and role of this replication group in the Global datastore. Returned: always |
|
The name of the Global datastore. Returned: always |
|
The role of the replication group in a Global datastore. Can be primary or secondary. Returned: always |
|
The ID of the KMS key used to encrypt the disk in the cluster. Returned: always |
|
The names of all the cache clusters that are part of this replication group. Returned: always |
|
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. Returned: always Sample: |
|
A list of node groups in this replication group. Returned: always |
|
The identifier for the node group (shard). Returned: always |
|
A list containing information about individual nodes within the node group (shard). Returned: always |
|
The ID of the cluster to which the node belongs. Returned: always |
|
The ID of the node within its cluster. Returned: always |
|
The role that is currently assigned to the node - primary or replica. Returned: always Sample: |
|
The name of the Availability Zone in which the node is located. Returned: always |
|
The information required for client programs to connect to a node for read operations. Returned: always |
|
The DNS hostname of the cache node. Returned: always |
|
The port number that the cache engine is listening on. Returned: always Sample: |
|
The endpoint of the primary node in this node group (shard). Returned: always |
|
The DNS hostname of the cache node. Returned: always |
|
The port number that the cache engine is listening on. Returned: always Sample: |
|
The endpoint of the cache node. Returned: always |
|
The DNS hostname of the cache node. Returned: always |
|
The port number that the cache engine is listening on. Returned: always Sample: |
|
The current state of this replication group - Returned: always Sample: |
|
A group of settings to be applied to the replication group, either immediately or during the next maintenance window. Returned: always |
|
Replication Group Id. Returned: always Sample: |
|
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. Returned: always |
|
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Returned: always Sample: |
|
The cluster ID that is used as the daily snapshot source for the replication group. Returned: always |
|
The current state of this replication group - Returned: always |
|
A flag that enables in-transit encryption when set to Returned: always |
|
Replication Group Id. Returned: if replication is enabled 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: |