ANSIBLE.ELASTICACHE(3)          ANSIBLE MODULES         ANSIBLE.ELASTICACHE(3)



NAME
       elasticache - Manage cache clusters in Amazon Elasticache. - Returns
       information about the specified cache cluster.

DESCRIPTION
       Manage cache clusters in Amazon Elasticache.

OPTIONS
       aws_access_key
              AWS access key. If not set then the value of the AWS_ACCESS_KEY
              environment variable is used. (default: None)

       aws_secret_key
              AWS secret key. If not set then the value of the AWS_SECRET_KEY
              environment variable is used. (default: None)

       cache_engine_version
              The version number of the cache engine (default: 1.4.14)

       cache_port
              The port number on which each of the cache nodes will accept
              connections (default: 11211)

       cache_security_groups
              A list of cache security group names to associate with this
              cache cluster (default: ['default'])

       engine Name of the cache engine to be used (memcached or redis)
              (default: memcached)

       hard_modify
              Whether to destroy and recreate an existing cache cluster if
              necessary in order to modify its state Choices: yes,no.

       name   The cache cluster identifier(required)

       node_type
              The compute and memory capacity of the nodes in the cache
              cluster (default: cache.m1.small)

       num_nodes
              The initial number of cache nodes that the cache cluster will
              have

       region The AWS region to use. If not specified then the value of the
              EC2_REGION environment variable, if any, is used.

       state  absent or present are idempotent actions that will create or
              destroy a cache cluster as needed. rebooted will reboot the
              cluster, resulting in a momentary outage.  Choices:
              present,absent,rebooted.(required)

       wait   Wait for cache cluster result before returning Choices: yes,no.
              (default: yes

       zone   The EC2 Availability Zone in which the cache cluster will be
              created (default: None).

EXAMPLES
       # Note: None of these examples set aws_access_key, aws_secret_key, or region.
       # It is assumed that their matching environment variables are set.

       # Basic example
       - local_action:
           module: elasticache
           name: "test-please-delete"
           state: present
           engine: memcached
           cache_engine_version: 1.4.14
           node_type: cache.m1.small
           num_nodes: 1
           cache_port: 11211
           cache_security_groups:
             - default
           zone: us-east-1d


       # Ensure cache cluster is gone
       - local_action:
           module: elasticache
           name: "test-please-delete"
           state: absent

       # Reboot cache cluster
       - local_action:
           module: elasticache
           name: "test-please-delete"
           state: rebooted




AUTHOR
       Jim Dalton

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#elasticache



1.4.5                             2014-02-12            ANSIBLE.ELASTICACHE(3)
