ansible / ansible.builtin / v2.6.20 / module / elasticache_parameter_group Manage cache security groups in Amazon Elasticache. | "added in version" 2.3 of ansible.builtin" Authors: Sloane Hertel (@s-hertel) preview | supported by communityansible.builtin.elasticache_parameter_group (v2.6.20) — module
pip
Install with pip install ansible==2.6.20
Manage cache security groups in Amazon Elasticache.
Returns information about the specified cache cluster.
# 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'
name: description: - A user-specified name for the cache parameter group. required: true state: choices: - present - absent - reset description: - Idempotent actions that will create/modify, destroy, or reset a cache parameter group as needed. required: true 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 values: description: - A user-specified dictionary of parameters to reset or modify for the cache parameter group. profile: aliases: - aws_profile description: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. 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). type: dict description: description: - A user-specified description for the cache parameter group. endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_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 group_family: choices: - memcached1.4 - redis2.6 - redis2.8 - redis3.2 description: - The name of the cache parameter group family that the cache parameter group can be used with. Required when creating a cache parameter group. aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - '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. - The I(aws_access_key) and I(profile) options are mutually exclusive. 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. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - 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. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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
changed: description: if the cache parameter group has changed returned: always sample: changed: true type: bool elasticache: description: cache parameter group information and response metadata returned: always sample: cache_parameter_group: cache_parameter_group_family: redis3.2 cache_parameter_group_name: test-please-delete description: initial description response_metadata: http_headers: content-length: '562' content-type: text/xml date: Mon, 06 Feb 2017 22:14:08 GMT x-amzn-requestid: 947291f9-ecb9-11e6-85bd-3baa4eca2cc1 http_status_code: 200 request_id: 947291f9-ecb9-11e6-85bd-3baa4eca2cc1 retry_attempts: 0 type: dict