Try SpotterRetrieve information for AWS ElastiCache clusters
| "added in version" 1.0.0 of community.aws"
Authors: Will Thames (@willthames)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0Retrieve information from AWS ElastiCache clusters.
- 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
name:
description:
- The name of an ElastiCache cluster.
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
elasticache_clusters:
contains:
arn:
description: ARN of the cache cluster.
returned: always
sample: arn:aws:elasticache:us-east-1:123456789012:cluster:ansible-test
type: str
auto_minor_version_upgrade:
description: Whether to automatically upgrade to minor versions.
returned: always
sample: true
type: bool
cache_cluster_create_time:
description: Date and time cluster was created.
returned: always
sample: '2017-09-15T05:43:46.038000+00:00'
type: str
cache_cluster_id:
description: ID of the cache cluster.
returned: always
sample: abcd-1234-001
type: str
cache_cluster_status:
description: Status of ElastiCache cluster.
returned: always
sample: available
type: str
cache_node_type:
description: Instance type of ElastiCache nodes.
returned: always
sample: cache.t2.micro
type: str
cache_nodes:
contains:
cache_node_create_time:
description: Date and time node was created.
returned: always
sample: '2017-09-15T05:43:46.038000+00:00'
type: str
cache_node_id:
description: ID of the cache node.
returned: always
sample: '0001'
type: str
cache_node_status:
description: Status of the cache node.
returned: always
sample: available
type: str
customer_availability_zone:
description: Availability Zone in which the cache node was created.
returned: always
sample: ap-southeast-2b
type: str
endpoint:
contains:
address:
description: URL of the cache node endpoint.
returned: always
sample: abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com
type: str
port:
description: Port of the cache node endpoint.
returned: always
sample: 6379
type: int
description: Connection details for the cache node.
returned: always
type: dict
parameter_group_status:
description: Status of the Cache Parameter Group.
returned: always
sample: in-sync
type: str
description: List of ElastiCache nodes in the cluster.
elements: dict
returned: always
type: list
cache_parameter_group:
contains:
cache_node_ids_to_reboot:
description: Cache nodes which need to be rebooted for parameter changes
to be applied.
elements: str
returned: always
sample: []
type: list
cache_parameter_group_name:
description: Name of the cache parameter group.
returned: always
sample: default.redis3.2
type: str
parameter_apply_status:
description: Status of parameter updates.
returned: always
sample: in-sync
type: str
description: Contents of the Cache Parameter Group.
returned: always
type: dict
cache_security_groups:
description: Security Groups used by the cache.
elements: str
returned: always
sample:
- sg-abcd1234
type: list
cache_subnet_group_name:
description: ElastiCache Subnet Group used by the cache.
returned: always
sample: abcd-subnet-group
type: str
client_download_landing_page:
description: URL of client download web page.
returned: always
sample: 'https://console.aws.amazon.com/elasticache/home#client-download:'
type: str
engine:
description: Engine used by ElastiCache.
returned: always
sample: redis
type: str
engine_version:
description: Version of ElastiCache engine.
returned: always
sample: 3.2.4
type: str
notification_configuration:
contains:
topic_arn:
description: ARN of notification destination topic.
returned: if notifications are enabled
sample: arn:aws:sns:*:123456789012:my_topic
type: str
topic_name:
description: Name of notification destination topic.
returned: if notifications are enabled
sample: MyTopic
type: str
description: Configuration of notifications.
returned: if notifications are enabled
type: dict
num_cache_nodes:
description: Number of Cache Nodes.
returned: always
sample: 1
type: int
pending_modified_values:
description: Values that are pending modification.
returned: always
type: dict
preferred_availability_zone:
description: Preferred Availability Zone.
returned: always
sample: ap-southeast-2b
type: str
preferred_maintenance_window:
description: Time slot for preferred maintenance window.
returned: always
sample: sat:12:00-sat:13:00
type: str
replication_group:
contains:
arn:
description: The ARN (Amazon Resource Name) of the replication group.
returned: always
type: str
at_rest_encryption_enabled:
description: A flag that enables encryption at-rest when set to true.
returned: always
type: bool
auth_token_enabled:
description: A flag that enables using an AuthToken (password) when issuing
Redis commands.
returned: always
type: bool
automatic_failover:
description: Indicates the status of automatic failover for this Redis replication
group.
returned: always
sample: enabled
type: str
cache_node_type:
description: The name of the compute and memory capacity node type for each
node in the replication group.
returned: always
sample: cache.t3.medium
type: str
cluster_enabled:
description: A flag indicating whether or not this replication group is
cluster enabled.
returned: always
type: bool
description:
description: The user supplied description of the replication group.
returned: always
type: str
global_replication_group_info:
contains:
global_replication_group_id:
description: The name of the Global datastore.
returned: always
type: str
global_replication_group_member_role:
description: The role of the replication group in a Global datastore.
Can be primary or secondary.
returned: always
type: str
description: The name of the Global datastore and role of this replication
group in the Global datastore.
returned: always
type: dict
kms_key_id:
description: The ID of the KMS key used to encrypt the disk in the cluster.
returned: always
type: str
member_clusters:
description: The names of all the cache clusters that are part of this replication
group.
elements: str
returned: always
type: list
multi_az:
description: A flag indicating if you have Multi-AZ enabled to enhance fault
tolerance.
returned: always
sample: enabled
type: str
node_groups:
contains:
node_group_id:
description: The identifier for the node group (shard).
returned: always
type: str
node_group_members:
contains:
cache_cluster_id:
description: The ID of the cluster to which the node belongs.
returned: always
type: str
cache_node_id:
description: The ID of the node within its cluster.
returned: always
type: str
current_role:
description: The role that is currently assigned to the node - primary
or replica.
returned: always
sample: primary
type: str
preferred_availability_zone:
description: The name of the Availability Zone in which the node
is located.
returned: always
type: str
read_endpoint:
contains:
address:
description: The DNS hostname of the cache node.
returned: always
type: str
port:
description: The port number that the cache engine is listening
on.
returned: always
sample: 6379
type: int
description: The information required for client programs to connect
to a node for read operations.
elements: dict
returned: always
type: list
description: A list containing information about individual nodes within
the node group (shard).
elements: dict
returned: always
type: list
primary_endpoint:
contains:
address:
description: The DNS hostname of the cache node.
returned: always
type: str
port:
description: The port number that the cache engine is listening
on.
returned: always
sample: 6379
type: int
description: The endpoint of the primary node in this node group (shard).
elements: dict
returned: always
type: list
reader_endpoint:
contains:
address:
description: The DNS hostname of the cache node.
returned: always
type: str
port:
description: The port number that the cache engine is listening
on.
returned: always
sample: 6379
type: int
description: The endpoint of the cache node.
returned: always
type: dict
status:
description: The current state of this replication group - C(creating),
C(available), C(modifying), C(deleting).
returned: always
sample: available
type: str
description: A list of node groups in this replication group.
elements: dict
returned: always
type: list
pending_modified_values:
description: A group of settings to be applied to the replication group,
either immediately or during the next maintenance window.
returned: always
type: dict
replication_group_id:
description: Replication Group Id.
returned: always
sample: replication-001
type: str
snapshot_retention_limit:
description: The number of days for which ElastiCache retains automatic
cluster snapshots before deleting them.
returned: always
type: int
snapshot_window:
description: The daily time range (in UTC) during which ElastiCache begins
taking a daily snapshot of your node group (shard).
returned: always
sample: 07:00-09:00
type: str
snapshotting_cluster_id:
description: The cluster ID that is used as the daily snapshot source for
the replication group.
returned: always
type: str
status:
description: The current state of this replication group - C(creating),
C(available), C(modifying), C(deleting), C(create-failed), C(snapshotting)
returned: always
type: str
transit_encryption_enabled:
description: A flag that enables in-transit encryption when set to C(true).
returned: always
type: bool
description: Informations about the associated replication group.
returned: if replication is enabled
type: dict
version_added: 4.1.0
version_added_collection: community.aws
replication_group_id:
description: Replication Group Id.
returned: if replication is enabled
sample: replication-001
type: str
security_groups:
contains:
security_group_id:
description: Security Group ID
returned: always
sample: sg-abcd1234
type: str
status:
description: Status of Security Group
returned: always
sample: active
type: str
description: List of Security Groups associated with ElastiCache.
elements: dict
returned: always
type: list
tags:
description: Tags applied to the ElastiCache cluster
returned: always
sample:
Application: web
Environment: test
type: dict
description: List of ElastiCache clusters.
elements: dict
returned: always
type: list