New in version 2.3.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| description | no | A user-specified description for the cache parameter group. | ||
| group_family | no |
| The name of the cache parameter group family that the cache parameter group can be used with. Required when creating a cache parameter group. | |
| name | yes | A user-specified name for the cache parameter group. | ||
| state | yes |
| Idempotent actions that will create/modify, destroy, or reset a cache parameter group as needed. | |
| values | no | None | A user-specified dictionary of parameters to reset or modify for the cache parameter group. |
# Note: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.
---
- hosts: localhost
connection: local
tasks:
- name: 'Create a test parameter group'
elasticache_parameter_group:
name: 'test-param-group'
group_family: 'redis3.2'
description: 'This is a cache parameter group'
state: 'present'
- name: 'Modify a test parameter group'
elasticache_parameter_group:
name: 'test-param-group'
values:
activerehashing: yes
client-output-buffer-limit-normal-hard-limit: 4
state: 'present'
- name: 'Reset all modifiable parameters for the test parameter group'
elasticache_parameter_group:
name: 'test-param-group'
state: reset
- name: 'Delete a test parameter group'
elasticache_parameter_group:
name: 'test-param-group'
state: 'absent'
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| elasticache | cache parameter group information and response metadata | always | dict | {'cache_parameter_group': {'cache_parameter_group_family': 'redis3.2', 'description': 'initial description', 'cache_parameter_group_name': 'test-please-delete'}, 'response_metadata': {'retry_attempts': 0, 'http_status_code': 200, 'http_headers': {'date': 'Mon, 06 Feb 2017 22:14:08 GMT', 'x-amzn-requestid': '947291f9-ecb9-11e6-85bd-3baa4eca2cc1', 'content-length': '562', 'content-type': 'text/xml'}, 'request_id': '947291f9-ecb9-11e6-85bd-3baa4eca2cc1'}} |
| changed | if the cache parameter group has changed | always | bool | {'changed': True} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/elasticache_parameter_group_module.html