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:==1.1.0
collections:
- name: community.aws
version: 1.1.0Retrieve information from AWS ElastiCache clusters
This module was called C(elasticache_facts) before Ansible 2.9. The usage did not change.
- 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.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
elasticache_clusters:
contains:
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: complex
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
returned: always
type: complex
cache_parameter_group:
contains:
cache_node_ids_to_reboot:
description: Cache nodes which need to be rebooted for parameter changes
to be applied
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: complex
cache_security_groups:
description: Security Groups used by the cache
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: complex
num_cache_nodes:
description: Number of Cache Nodes
returned: always
sample: 1
type: int
pending_modified_values:
contains: {}
description: Values that are pending modification
returned: always
type: complex
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_id:
description: Replication Group Id
returned: always
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
returned: always
type: complex
tags:
contains: {}
description: Tags applied to the ElastiCache cluster
returned: always
sample:
Application: web
Environment: test
type: complex
description: List of ElastiCache clusters
returned: always
type: complex