Class: Ansible::Ruby::Modules::Elasticache

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cache_engine_version ⇒ String?

Returns The version number of the cache engine.

Returns:

  • (String, nil) —

    The version number of the cache engine



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 25

attribute :cache_engine_version

#cache_parameter_group ⇒ Object?

Returns The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.

Returns:

  • (Object, nil) —

    The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 41

attribute :cache_parameter_group

#cache_port ⇒ Integer?

Returns The port number on which each of the cache nodes will accept connections.

Returns:

  • (Integer, nil) —

    The port number on which each of the cache nodes will accept connections



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 37

attribute :cache_port

#cache_security_groups ⇒ Array<String>, ...

Returns A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc.

Returns:

  • (Array<String>, String, nil) —

    A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 50

attribute :cache_security_groups

#cache_subnet_group ⇒ Object?

Returns The subnet group name to associate with. Only use if inside a vpc. Required if inside a vpc.

Returns:

  • (Object, nil) —

    The subnet group name to associate with. Only use if inside a vpc. Required if inside a vpc



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 44

attribute :cache_subnet_group

#engine ⇒ :redis, ...

Returns Name of the cache engine to be used.

Returns:

  • (:redis, :memcached, nil) —

    Name of the cache engine to be used.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 21

attribute :engine

#hard_modify ⇒ :yes, ...

Returns Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state.

Returns:

  • (:yes, :no, nil) —

    Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 62

attribute :hard_modify

#name ⇒ String

Returns The cache cluster identifier.

Returns:

  • (String) —

    The cache cluster identifier



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 17

attribute :name

#node_type ⇒ String?

Returns The compute and memory capacity of the nodes in the cache cluster.

Returns:

  • (String, nil) —

    The compute and memory capacity of the nodes in the cache cluster



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 29

attribute :node_type

#num_nodes ⇒ Integer?

Returns The initial number of cache nodes that the cache cluster will have. Required when state=present.

Returns:

  • (Integer, nil) —

    The initial number of cache nodes that the cache cluster will have. Required when state=present.



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 33

attribute :num_nodes

#security_group_ids ⇒ Object?

Returns A list of vpc security group names to associate with this cache cluster. Only use if inside a vpc.

Returns:

  • (Object, nil) —

    A list of vpc security group names to associate with this cache cluster. Only use if inside a vpc



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 47

attribute :security_group_ids

#state ⇒ :present, ...

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

Returns:

  • (:present, :absent, :rebooted) —

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



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 13

attribute :state

#wait ⇒ :yes, ...

Returns Wait for cache cluster result before returning.

Returns:

  • (:yes, :no, nil) —

    Wait for cache cluster result before returning



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 58

attribute :wait

#zone ⇒ String?

Returns The EC2 Availability Zone in which the cache cluster will be created.

Returns:

  • (String, nil) —

    The EC2 Availability Zone in which the cache cluster will be created



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elasticache.rb', line 54

attribute :zone