ansible.builtin.elasticache_parameter_group (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Manage cache security groups in Amazon Elasticache.

Returns information about the specified cache cluster.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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'

Inputs

    
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

values:
    default: None
    description:
    - A user-specified list of parameters to reset or modify for the cache parameter group.
    required: false

description:
    description:
    - A user-specified description for the cache parameter group.

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: true

Outputs

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