community / community.aws / 3.4.0 / module / elasticache_info Retrieve information for AWS ElastiCache clusters | "added in version" 1.0.0 of community.aws" Authors: Will Thames (@willthames)community.aws.elasticache_info (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Retrieve 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: - 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. - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(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: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(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: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(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 communication with the AWS APIs. 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: 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