

.. _Amazon ElastiCache Product Features and Details: http://aws.amazon.com/elasticache/details
.. _CreateCacheSubnetGroup: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html
.. _Using Cost Allocation Tags in Amazon ElastiCache: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html
.. _http\://aws.amazon.com/contact-us/elasticache-node-limit-request: http://aws.amazon.com/contact-us/elasticache-node-limit-request
.. _Cache Node Type-Specific Parameters for Redis: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific
.. _Cache Node Considerations for Memcached: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html
.. _Cache Node Type-Specific Parameters for Memcached: http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific
.. _http\://aws.amazon.com/contact-us/elasticache-node-limit-request/: http://aws.amazon.com/contact-us/elasticache-node-limit-request/


***********
ElastiCache
***********

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: ElastiCache.Client

  A low-level client representing Amazon ElastiCache::

    
    import boto3
    
    client = boto3.client('elasticache')

  
  These are the available methods:
  
  *   :py:meth:`add_tags_to_resource`

  
  *   :py:meth:`authorize_cache_security_group_ingress`

  
  *   :py:meth:`can_paginate`

  
  *   :py:meth:`copy_snapshot`

  
  *   :py:meth:`create_cache_cluster`

  
  *   :py:meth:`create_cache_parameter_group`

  
  *   :py:meth:`create_cache_security_group`

  
  *   :py:meth:`create_cache_subnet_group`

  
  *   :py:meth:`create_replication_group`

  
  *   :py:meth:`create_snapshot`

  
  *   :py:meth:`delete_cache_cluster`

  
  *   :py:meth:`delete_cache_parameter_group`

  
  *   :py:meth:`delete_cache_security_group`

  
  *   :py:meth:`delete_cache_subnet_group`

  
  *   :py:meth:`delete_replication_group`

  
  *   :py:meth:`delete_snapshot`

  
  *   :py:meth:`describe_cache_clusters`

  
  *   :py:meth:`describe_cache_engine_versions`

  
  *   :py:meth:`describe_cache_parameter_groups`

  
  *   :py:meth:`describe_cache_parameters`

  
  *   :py:meth:`describe_cache_security_groups`

  
  *   :py:meth:`describe_cache_subnet_groups`

  
  *   :py:meth:`describe_engine_default_parameters`

  
  *   :py:meth:`describe_events`

  
  *   :py:meth:`describe_replication_groups`

  
  *   :py:meth:`describe_reserved_cache_nodes`

  
  *   :py:meth:`describe_reserved_cache_nodes_offerings`

  
  *   :py:meth:`describe_snapshots`

  
  *   :py:meth:`generate_presigned_url`

  
  *   :py:meth:`get_paginator`

  
  *   :py:meth:`get_waiter`

  
  *   :py:meth:`list_tags_for_resource`

  
  *   :py:meth:`modify_cache_cluster`

  
  *   :py:meth:`modify_cache_parameter_group`

  
  *   :py:meth:`modify_cache_subnet_group`

  
  *   :py:meth:`modify_replication_group`

  
  *   :py:meth:`purchase_reserved_cache_nodes_offering`

  
  *   :py:meth:`reboot_cache_cluster`

  
  *   :py:meth:`remove_tags_from_resource`

  
  *   :py:meth:`reset_cache_parameter_group`

  
  *   :py:meth:`revoke_cache_security_group_ingress`

  

  .. py:method:: add_tags_to_resource(**kwargs)

    

    The *AddTagsToResource* action adds up to 10 cost allocation tags to the named resource. A *cost allocation tag* is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs.

     

    When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see `Using Cost Allocation Tags in Amazon ElastiCache`_ .

    

    **Request Syntax** 
    ::

      response = client.add_tags_to_resource(
          ResourceName='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      )
    :type ResourceName: string
    :param ResourceName: **[REQUIRED]** 

      The name of the resource to which the tags are to be added, for example ``arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster`` .

      

    
    :type Tags: list
    :param Tags: **[REQUIRED]** 

      A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

      

    
      - *(dict) --* 

        A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

        

      
        - **Key** *(string) --* 

          The key for the tag.

          

        
        - **Value** *(string) --* 

          The tag's value. May not be null.

          

        
      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output from the *AddTagsToResource* , *ListTagsOnResource* , and *RemoveTagsFromResource* actions.

        
        

        - **TagList** *(list) --* 

          A list of cost allocation tags as key-value pairs. 

          
          

          - *(dict) --* 

            A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

            
            

            - **Key** *(string) --* 

              The key for the tag.

              
            

            - **Value** *(string) --* 

              The tag's value. May not be null.

              
        
      
    

  .. py:method:: authorize_cache_security_group_ingress(**kwargs)

    

    The *AuthorizeCacheSecurityGroupIngress* action allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

     

    .. note::

      You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region. 

    

    **Request Syntax** 
    ::

      response = client.authorize_cache_security_group_ingress(
          CacheSecurityGroupName='string',
          EC2SecurityGroupName='string',
          EC2SecurityGroupOwnerId='string'
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: **[REQUIRED]** 

      The cache security group which will allow network ingress.

      

    
    :type EC2SecurityGroupName: string
    :param EC2SecurityGroupName: **[REQUIRED]** 

      The Amazon EC2 security group to be authorized for ingress to the cache security group.

      

    
    :type EC2SecurityGroupOwnerId: string
    :param EC2SecurityGroupOwnerId: **[REQUIRED]** 

      The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSecurityGroup': {
                'OwnerId': 'string',
                'CacheSecurityGroupName': 'string',
                'Description': 'string',
                'EC2SecurityGroups': [
                    {
                        'Status': 'string',
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string'
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *AuthorizeCacheSecurityGroupIngress*  
         
        *  *CreateCacheSecurityGroup*  
         
        *  *RevokeCacheSecurityGroupIngress*  
         

        
        

        - **CacheSecurityGroup** *(dict) --* 

          Represents the output of one of the following actions:

           

           
          *  *AuthorizeCacheSecurityGroupIngress*  
           
          *  *CreateCacheSecurityGroup*  
           
          *  *RevokeCacheSecurityGroupIngress*  
           

          
          

          - **OwnerId** *(string) --* 

            The AWS account ID of the cache security group owner.

            
          

          - **CacheSecurityGroupName** *(string) --* 

            The name of the cache security group.

            
          

          - **Description** *(string) --* 

            The description of the cache security group.

            
          

          - **EC2SecurityGroups** *(list) --* 

            A list of Amazon EC2 security groups that are associated with this cache security group.

            
            

            - *(dict) --* 

              Provides ownership and status information for an Amazon EC2 security group.

              
              

              - **Status** *(string) --* 

                The status of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupName** *(string) --* 

                The name of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupOwnerId** *(string) --* 

                The AWS account ID of the Amazon EC2 security group owner.

                
          
        
      
    

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: copy_snapshot(**kwargs)

    

    The *CopySnapshot* action makes a copy of an existing snapshot.

    

    **Request Syntax** 
    ::

      response = client.copy_snapshot(
          SourceSnapshotName='string',
          TargetSnapshotName='string'
      )
    :type SourceSnapshotName: string
    :param SourceSnapshotName: **[REQUIRED]** 

      The name of an existing snapshot from which to copy.

      

    
    :type TargetSnapshotName: string
    :param TargetSnapshotName: **[REQUIRED]** 

      A name for the copied snapshot.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Snapshot': {
                'SnapshotName': 'string',
                'CacheClusterId': 'string',
                'SnapshotStatus': 'string',
                'SnapshotSource': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'TopicArn': 'string',
                'Port': 123,
                'CacheParameterGroupName': 'string',
                'CacheSubnetGroupName': 'string',
                'VpcId': 'string',
                'AutoMinorVersionUpgrade': True|False,
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string',
                'NodeSnapshots': [
                    {
                        'CacheNodeId': 'string',
                        'CacheSize': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'SnapshotCreateTime': datetime(2015, 1, 1)
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

        
        

        - **Snapshot** *(dict) --* 

          Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

          
          

          - **SnapshotName** *(string) --* 

            The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

            
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the source cache cluster.

            
          

          - **SnapshotStatus** *(string) --* 

            The status of the snapshot. Valid values: ``creating`` | ``available`` | ``restoring`` | ``copying`` | ``deleting`` .

            
          

          - **SnapshotSource** *(string) --* 

            Indicates whether the snapshot is from an automatic backup (``automated`` ) or was created manually (``manual`` ).

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the source cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) used by the source cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used by the source cache cluster.

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the source cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the source cache cluster is located.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the source cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **TopicArn** *(string) --* 

            The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

            
          

          - **Port** *(integer) --* 

            The port number used by each cache nodes in the source cache cluster.

            
          

          - **CacheParameterGroupName** *(string) --* 

            The cache parameter group that is associated with the source cache cluster.

            
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the source cache cluster.

            
          

          - **VpcId** *(string) --* 

            The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

            
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

             

            For manual snapshots, this field reflects the *SnapshotRetentionLimit* for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the *DeleteSnapshot* action. 

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

            
          

          - **NodeSnapshots** *(list) --* 

            A list of the cache nodes in the source cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node in a snapshot of a cache cluster.

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier for the node in the source cache cluster.

                
              

              - **CacheSize** *(string) --* 

                The size of the cache on the source cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created in the source cache cluster.

                
              

              - **SnapshotCreateTime** *(datetime) --* 

                The date and time when the source node's metadata and cache data set was obtained for the snapshot.

                
          
        
      
    

  .. py:method:: create_cache_cluster(**kwargs)

    

    The *CreateCacheCluster* action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

    

    **Request Syntax** 
    ::

      response = client.create_cache_cluster(
          CacheClusterId='string',
          ReplicationGroupId='string',
          AZMode='single-az'|'cross-az',
          PreferredAvailabilityZone='string',
          PreferredAvailabilityZones=[
              'string',
          ],
          NumCacheNodes=123,
          CacheNodeType='string',
          Engine='string',
          EngineVersion='string',
          CacheParameterGroupName='string',
          CacheSubnetGroupName='string',
          CacheSecurityGroupNames=[
              'string',
          ],
          SecurityGroupIds=[
              'string',
          ],
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ],
          SnapshotArns=[
              'string',
          ],
          SnapshotName='string',
          PreferredMaintenanceWindow='string',
          Port=123,
          NotificationTopicArn='string',
          AutoMinorVersionUpgrade=True|False,
          SnapshotRetentionLimit=123,
          SnapshotWindow='string'
      )
    :type CacheClusterId: string
    :param CacheClusterId: **[REQUIRED]** 

      The node group identifier. This parameter is stored as a lowercase string.

       

      Constraints:

       

       
      * A name must contain from 1 to 20 alphanumeric characters or hyphens.
       
      * The first character must be a letter.
       
      * A name cannot end with a hyphen or contain two consecutive hyphens.
       

      

    
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.

       

      If the specified replication group is Multi-AZ enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

      

    
    :type AZMode: string
    :param AZMode: 

      Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

       

      This parameter is only supported for Memcached cache clusters.

       

      If the ``AZMode`` and ``PreferredAvailabilityZones`` are not specified, ElastiCache assumes ``single-az`` mode.

      

    
    :type PreferredAvailabilityZone: string
    :param PreferredAvailabilityZone: 

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

       

      All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use ``PreferredAvailabilityZones`` .

       

      Default: System chosen Availability Zone.

      

    
    :type PreferredAvailabilityZones: list
    :param PreferredAvailabilityZones: 

      A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

       

      This option is only supported on Memcached.

       

      .. note::

         

        If you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

         

        The number of Availability Zones listed must equal the value of ``NumCacheNodes`` .

         

       

      If you want all the nodes in the same Availability Zone, use ``PreferredAvailabilityZone`` instead, or repeat the Availability Zone multiple times in the list.

       

      Default: System chosen Availability Zones.

       

      Example: One Memcached node in each of three different Availability Zones: ``PreferredAvailabilityZones.member.1=us-west-2aPreferredAvailabilityZones.member.2=us-west-2bPreferredAvailabilityZones.member.3=us-west-2c`` 

       

      Example: All three Memcached nodes in one Availability Zone: ``PreferredAvailabilityZones.member.1=us-west-2aPreferredAvailabilityZones.member.2=us-west-2aPreferredAvailabilityZones.member.3=us-west-2a`` 

      

    
      - *(string) --* 

      
  
    :type NumCacheNodes: integer
    :param NumCacheNodes: 

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

       

      For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

       

      If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at `http\://aws.amazon.com/contact-us/elasticache-node-limit-request/`_ .

      

    
    :type CacheNodeType: string
    :param CacheNodeType: 

      The compute and memory capacity of the nodes in the node group.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Engine: string
    :param Engine: 

      The name of the cache engine to be used for this cache cluster.

       

      Valid values for this parameter are:

       

      ``memcached`` | ``redis`` 

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the *DescribeCacheEngineVersions* action.

      

    
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

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

      

    
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: 

      The name of the subnet group to be used for the cache cluster.

       

      Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

      

    
    :type CacheSecurityGroupNames: list
    :param CacheSecurityGroupNames: 

      A list of security group names to associate with this cache cluster.

       

      Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).

      

    
      - *(string) --* 

      
  
    :type SecurityGroupIds: list
    :param SecurityGroupIds: 

      One or more VPC security groups associated with the cache cluster.

       

      Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

      

    
      - *(string) --* 

      
  
    :type Tags: list
    :param Tags: 

      A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

      

    
      - *(dict) --* 

        A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

        

      
        - **Key** *(string) --* 

          The key for the tag.

          

        
        - **Value** *(string) --* 

          The tag's value. May not be null.

          

        
      
  
    :type SnapshotArns: list
    :param SnapshotArns: 

      A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

       

      Example of an Amazon S3 ARN: ``arn:aws:s3:::my_bucket/snapshot1.rdb`` 

      

    
      - *(string) --* 

      
  
    :type SnapshotName: string
    :param SnapshotName: 

      The name of a snapshot from which to restore data into the new node group. The snapshot status changes to ``restoring`` while the new node group is being created.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

      

    
    :type PreferredMaintenanceWindow: string
    :param PreferredMaintenanceWindow: 

      Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

       

       
      * ``sun`` 
       
      * ``mon`` 
       
      * ``tue`` 
       
      * ``wed`` 
       
      * ``thu`` 
       
      * ``fri`` 
       
      * ``sat`` 
       

       

      Example: ``sun:05:00-sun:09:00`` 

      

    
    :type Port: integer
    :param Port: 

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

      

    
    :type NotificationTopicArn: string
    :param NotificationTopicArn: 

      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

       

      .. note::

        The Amazon SNS topic owner must be the same as the cache cluster owner.

      

    
    :type AutoMinorVersionUpgrade: boolean
    :param AutoMinorVersionUpgrade: 

      This parameter is currently disabled.

      

    
    :type SnapshotRetentionLimit: integer
    :param SnapshotRetentionLimit: 

      The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set ``SnapshotRetentionLimit`` to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

       

      Default: 0 (i.e., automatic backups are disabled for this cache cluster).

      

    
    :type SnapshotWindow: string
    :param SnapshotWindow: 

      The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

       

      Example: ``05:00-09:00`` 

       

      If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheCluster': {
                'CacheClusterId': 'string',
                'ConfigurationEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ClientDownloadLandingPage': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'CacheClusterStatus': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'PendingModifiedValues': {
                    'NumCacheNodes': 123,
                    'CacheNodeIdsToRemove': [
                        'string',
                    ],
                    'EngineVersion': 'string'
                },
                'NotificationConfiguration': {
                    'TopicArn': 'string',
                    'TopicStatus': 'string'
                },
                'CacheSecurityGroups': [
                    {
                        'CacheSecurityGroupName': 'string',
                        'Status': 'string'
                    },
                ],
                'CacheParameterGroup': {
                    'CacheParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string',
                    'CacheNodeIdsToReboot': [
                        'string',
                    ]
                },
                'CacheSubnetGroupName': 'string',
                'CacheNodes': [
                    {
                        'CacheNodeId': 'string',
                        'CacheNodeStatus': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'Endpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'ParameterGroupStatus': 'string',
                        'SourceCacheNodeId': 'string',
                        'CustomerAvailabilityZone': 'string'
                    },
                ],
                'AutoMinorVersionUpgrade': True|False,
                'SecurityGroups': [
                    {
                        'SecurityGroupId': 'string',
                        'Status': 'string'
                    },
                ],
                'ReplicationGroupId': 'string',
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific cache cluster.

        
        

        - **CacheCluster** *(dict) --* 

          Contains all of the attributes of a specific cache cluster.

          
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

            
          

          - **ConfigurationEndpoint** *(dict) --* 

            Represents the information required for client programs to connect to a cache node.

            
            

            - **Address** *(string) --* 

              The DNS hostname of the cache node.

              
            

            - **Port** *(integer) --* 

              The port number that the cache engine is listening on.

              
        
          

          - **ClientDownloadLandingPage** *(string) --* 

            The URL of the web page where you can download the latest ElastiCache client library.

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used in this cache cluster.

            
          

          - **CacheClusterStatus** *(string) --* 

            The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

            
            

            - **NumCacheNodes** *(integer) --* 

              The new number of cache nodes for the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **CacheNodeIdsToRemove** *(list) --* 

              A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
            

            - **EngineVersion** *(string) --* 

              The new cache engine version that the cache cluster will run.

              
        
          

          - **NotificationConfiguration** *(dict) --* 

            Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

            
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the topic.

              
            

            - **TopicStatus** *(string) --* 

              The current state of the topic.

              
        
          

          - **CacheSecurityGroups** *(list) --* 

            A list of cache security group elements, composed of name and status sub-elements.

            
            

            - *(dict) --* 

              Represents a cache cluster's status within a particular cache security group.

              
              

              - **CacheSecurityGroupName** *(string) --* 

                The name of the cache security group.

                
              

              - **Status** *(string) --* 

                The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **CacheParameterGroup** *(dict) --* 

            The status of the cache parameter group.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **ParameterApplyStatus** *(string) --* 

              The status of parameter updates.

              
            

            - **CacheNodeIdsToReboot** *(list) --* 

              A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
        
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the cache cluster.

            
          

          - **CacheNodes** *(list) --* 

            A list of cache nodes that are members of the cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                
              

              - **CacheNodeStatus** *(string) --* 

                The current state of this cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created.

                
              

              - **Endpoint** *(dict) --* 

                The hostname for connecting to this cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **ParameterGroupStatus** *(string) --* 

                The status of the parameter group applied to this cache node.

                
              

              - **SourceCacheNodeId** *(string) --* 

                The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                
              

              - **CustomerAvailabilityZone** *(string) --* 

                The Availability Zone where this node was created and now resides.

                
          
        
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SecurityGroups** *(list) --* 

            A list of VPC Security Groups associated with the cache cluster.

            
            

            - *(dict) --* 

              Represents a single cache security group and its status.

              
              

              - **SecurityGroupId** *(string) --* 

                The identifier of the cache security group.

                
              

              - **Status** *(string) --* 

                The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **ReplicationGroupId** *(string) --* 

            The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

             

            Example: ``05:00-09:00`` 

            
      
    

  .. py:method:: create_cache_parameter_group(**kwargs)

    

    The *CreateCacheParameterGroup* action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.

    

    **Request Syntax** 
    ::

      response = client.create_cache_parameter_group(
          CacheParameterGroupName='string',
          CacheParameterGroupFamily='string',
          Description='string'
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      A user-specified name for the cache parameter group.

      

    
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: **[REQUIRED]** 

      The name of the cache parameter group family the cache parameter group can be used with.

       

      Valid values are: ``memcached1.4`` | ``redis2.6`` | ``redis2.8`` 

      

    
    :type Description: string
    :param Description: **[REQUIRED]** 

      A user-specified description for the cache parameter group.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheParameterGroup': {
                'CacheParameterGroupName': 'string',
                'CacheParameterGroupFamily': 'string',
                'Description': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *CreateCacheParameterGroup* action.

        
        

        - **CacheParameterGroup** *(dict) --* 

          Represents the output of a *CreateCacheParameterGroup* action.

          
          

          - **CacheParameterGroupName** *(string) --* 

            The name of the cache parameter group.

            
          

          - **CacheParameterGroupFamily** *(string) --* 

            The name of the cache parameter group family that this cache parameter group is compatible with.

            
          

          - **Description** *(string) --* 

            The description for this cache parameter group.

            
      
    

  .. py:method:: create_cache_security_group(**kwargs)

    

    The *CreateCacheSecurityGroup* action creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

     

    Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see `CreateCacheSubnetGroup`_ .

    

    **Request Syntax** 
    ::

      response = client.create_cache_security_group(
          CacheSecurityGroupName='string',
          Description='string'
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: **[REQUIRED]** 

      A name for the cache security group. This value is stored as a lowercase string.

       

      Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".

       

      Example: ``mysecuritygroup`` 

      

    
    :type Description: string
    :param Description: **[REQUIRED]** 

      A description for the cache security group.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSecurityGroup': {
                'OwnerId': 'string',
                'CacheSecurityGroupName': 'string',
                'Description': 'string',
                'EC2SecurityGroups': [
                    {
                        'Status': 'string',
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string'
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *AuthorizeCacheSecurityGroupIngress*  
         
        *  *CreateCacheSecurityGroup*  
         
        *  *RevokeCacheSecurityGroupIngress*  
         

        
        

        - **CacheSecurityGroup** *(dict) --* 

          Represents the output of one of the following actions:

           

           
          *  *AuthorizeCacheSecurityGroupIngress*  
           
          *  *CreateCacheSecurityGroup*  
           
          *  *RevokeCacheSecurityGroupIngress*  
           

          
          

          - **OwnerId** *(string) --* 

            The AWS account ID of the cache security group owner.

            
          

          - **CacheSecurityGroupName** *(string) --* 

            The name of the cache security group.

            
          

          - **Description** *(string) --* 

            The description of the cache security group.

            
          

          - **EC2SecurityGroups** *(list) --* 

            A list of Amazon EC2 security groups that are associated with this cache security group.

            
            

            - *(dict) --* 

              Provides ownership and status information for an Amazon EC2 security group.

              
              

              - **Status** *(string) --* 

                The status of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupName** *(string) --* 

                The name of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupOwnerId** *(string) --* 

                The AWS account ID of the Amazon EC2 security group owner.

                
          
        
      
    

  .. py:method:: create_cache_subnet_group(**kwargs)

    

    The *CreateCacheSubnetGroup* action creates a new cache subnet group.

     

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

    

    **Request Syntax** 
    ::

      response = client.create_cache_subnet_group(
          CacheSubnetGroupName='string',
          CacheSubnetGroupDescription='string',
          SubnetIds=[
              'string',
          ]
      )
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: **[REQUIRED]** 

      A name for the cache subnet group. This value is stored as a lowercase string.

       

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

       

      Example: ``mysubnetgroup`` 

      

    
    :type CacheSubnetGroupDescription: string
    :param CacheSubnetGroupDescription: **[REQUIRED]** 

      A description for the cache subnet group.

      

    
    :type SubnetIds: list
    :param SubnetIds: **[REQUIRED]** 

      A list of VPC subnet IDs for the cache subnet group.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSubnetGroup': {
                'CacheSubnetGroupName': 'string',
                'CacheSubnetGroupDescription': 'string',
                'VpcId': 'string',
                'Subnets': [
                    {
                        'SubnetIdentifier': 'string',
                        'SubnetAvailabilityZone': {
                            'Name': 'string'
                        }
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *CreateCacheSubnetGroup*  
         
        *  *ModifyCacheSubnetGroup*  
         

        
        

        - **CacheSubnetGroup** *(dict) --* 

          Represents the output of one of the following actions:

           

           
          *  *CreateCacheSubnetGroup*  
           
          *  *ModifyCacheSubnetGroup*  
           

          
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group.

            
          

          - **CacheSubnetGroupDescription** *(string) --* 

            The description of the cache subnet group.

            
          

          - **VpcId** *(string) --* 

            The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

            
          

          - **Subnets** *(list) --* 

            A list of subnets associated with the cache subnet group.

            
            

            - *(dict) --* 

              Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

              
              

              - **SubnetIdentifier** *(string) --* 

                The unique identifier for the subnet.

                
              

              - **SubnetAvailabilityZone** *(dict) --* 

                The Availability Zone associated with the subnet.

                
                

                - **Name** *(string) --* 

                  The name of the Availability Zone.

                  
            
          
        
      
    

  .. py:method:: create_replication_group(**kwargs)

    

    The *CreateReplicationGroup* action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.

     

    When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

     

    **Note:** This action is valid only for Redis.

    

    **Request Syntax** 
    ::

      response = client.create_replication_group(
          ReplicationGroupId='string',
          ReplicationGroupDescription='string',
          PrimaryClusterId='string',
          AutomaticFailoverEnabled=True|False,
          NumCacheClusters=123,
          PreferredCacheClusterAZs=[
              'string',
          ],
          CacheNodeType='string',
          Engine='string',
          EngineVersion='string',
          CacheParameterGroupName='string',
          CacheSubnetGroupName='string',
          CacheSecurityGroupNames=[
              'string',
          ],
          SecurityGroupIds=[
              'string',
          ],
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ],
          SnapshotArns=[
              'string',
          ],
          SnapshotName='string',
          PreferredMaintenanceWindow='string',
          Port=123,
          NotificationTopicArn='string',
          AutoMinorVersionUpgrade=True|False,
          SnapshotRetentionLimit=123,
          SnapshotWindow='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: **[REQUIRED]** 

      The replication group identifier. This parameter is stored as a lowercase string.

       

      Constraints:

       

       
      * A name must contain from 1 to 20 alphanumeric characters or hyphens.
       
      * The first character must be a letter.
       
      * A name cannot end with a hyphen or contain two consecutive hyphens.
       

      

    
    :type ReplicationGroupDescription: string
    :param ReplicationGroupDescription: **[REQUIRED]** 

      A user-created description for the replication group.

      

    
    :type PrimaryClusterId: string
    :param PrimaryClusterId: 

      The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of *available* .

       

      This parameter is not required if *NumCacheClusters* is specified.

      

    
    :type AutomaticFailoverEnabled: boolean
    :param AutomaticFailoverEnabled: 

      Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.

       

      If ``true`` , Multi-AZ is enabled for this replication group. If ``false`` , Multi-AZ is disabled for this replication group.

       

      Default: false

       

      .. note::

        

        ElastiCache Multi-AZ replication groups is not supported on:

         

         
        * Redis versions earlier than 2.8.6.
         
        * T1 and T2 cache node types.
         

         

      

    
    :type NumCacheClusters: integer
    :param NumCacheClusters: 

      The number of cache clusters this replication group will initially have.

       

      If *Multi-AZ* is ``enabled`` , the value of this parameter must be at least 2.

       

      The maximum permitted value for *NumCacheClusters* is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at `http\://aws.amazon.com/contact-us/elasticache-node-limit-request`_ .

      

    
    :type PreferredCacheClusterAZs: list
    :param PreferredCacheClusterAZs: 

      A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.

       

      .. note::

        If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache clusters in availability zones associated with the subnets in the selected subnet group. 

        The number of availability zones listed must equal the value of *NumCacheClusters* .

        

       

      Default: system chosen availability zones.

       

      Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c

      

    
      - *(string) --* 

      
  
    :type CacheNodeType: string
    :param CacheNodeType: 

      The compute and memory capacity of the nodes in the node group.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Engine: string
    :param Engine: 

      The name of the cache engine to be used for the cache clusters in this replication group.

       

      Default: redis

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the *DescribeCacheEngineVersions* action.

      

    
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

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

      

    
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: 

      The name of the cache subnet group to be used for the replication group.

      

    
    :type CacheSecurityGroupNames: list
    :param CacheSecurityGroupNames: 

      A list of cache security group names to associate with this replication group.

      

    
      - *(string) --* 

      
  
    :type SecurityGroupIds: list
    :param SecurityGroupIds: 

      One or more Amazon VPC security groups associated with this replication group.

       

      Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).

      

    
      - *(string) --* 

      
  
    :type Tags: list
    :param Tags: 

      A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

      

    
      - *(dict) --* 

        A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

        

      
        - **Key** *(string) --* 

          The key for the tag.

          

        
        - **Value** *(string) --* 

          The tag's value. May not be null.

          

        
      
  
    :type SnapshotArns: list
    :param SnapshotArns: 

      A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

       

      Example of an Amazon S3 ARN: ``arn:aws:s3:::my_bucket/snapshot1.rdb`` 

      

    
      - *(string) --* 

      
  
    :type SnapshotName: string
    :param SnapshotName: 

      The name of a snapshot from which to restore data into the new node group. The snapshot status changes to ``restoring`` while the new node group is being created.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

      

    
    :type PreferredMaintenanceWindow: string
    :param PreferredMaintenanceWindow: 

      Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

       

       
      * ``sun`` 
       
      * ``mon`` 
       
      * ``tue`` 
       
      * ``wed`` 
       
      * ``thu`` 
       
      * ``fri`` 
       
      * ``sat`` 
       

       

      Example: ``sun:05:00-sun:09:00`` 

      

    
    :type Port: integer
    :param Port: 

      The port number on which each member of the replication group will accept connections.

      

    
    :type NotificationTopicArn: string
    :param NotificationTopicArn: 

      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

       

      .. note::

        The Amazon SNS topic owner must be the same as the cache cluster owner.

      

    
    :type AutoMinorVersionUpgrade: boolean
    :param AutoMinorVersionUpgrade: 

      This parameter is currently disabled.

      

    
    :type SnapshotRetentionLimit: integer
    :param SnapshotRetentionLimit: 

      The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set ``SnapshotRetentionLimit`` to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

       

      Default: 0 (i.e., automatic backups are disabled for this cache cluster).

      

    
    :type SnapshotWindow: string
    :param SnapshotWindow: 

      The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

       

      Example: ``05:00-09:00`` 

       

      If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

       

      **Note:** This parameter is only valid if the ``Engine`` parameter is ``redis`` .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReplicationGroup': {
                'ReplicationGroupId': 'string',
                'Description': 'string',
                'Status': 'string',
                'PendingModifiedValues': {
                    'PrimaryClusterId': 'string',
                    'AutomaticFailoverStatus': 'enabled'|'disabled'
                },
                'MemberClusters': [
                    'string',
                ],
                'NodeGroups': [
                    {
                        'NodeGroupId': 'string',
                        'Status': 'string',
                        'PrimaryEndpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'NodeGroupMembers': [
                            {
                                'CacheClusterId': 'string',
                                'CacheNodeId': 'string',
                                'ReadEndpoint': {
                                    'Address': 'string',
                                    'Port': 123
                                },
                                'PreferredAvailabilityZone': 'string',
                                'CurrentRole': 'string'
                            },
                        ]
                    },
                ],
                'SnapshottingClusterId': 'string',
                'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific replication group.

        
        

        - **ReplicationGroup** *(dict) --* 

          Contains all of the attributes of a specific replication group.

          
          

          - **ReplicationGroupId** *(string) --* 

            The identifier for the replication group.

            
          

          - **Description** *(string) --* 

            The description of the replication group.

            
          

          - **Status** *(string) --* 

            The current state of this replication group - *creating* , *available* , etc.

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

            
            

            - **PrimaryClusterId** *(string) --* 

              The primary cluster ID which will be applied immediately (if ``--apply-immediately`` was specified), or during the next maintenance window.

              
            

            - **AutomaticFailoverStatus** *(string) --* 

              Indicates the status of Multi-AZ for this replication group.

               

              .. note::

                

                ElastiCache Multi-AZ replication groups are not supported on:

                 

                 
                * Redis versions earlier than 2.8.6.
                 
                * T1 and T2 cache node types.
                 

                 

              
        
          

          - **MemberClusters** *(list) --* 

            The names of all the cache clusters that are part of this replication group.

            
            

            - *(string) --* 
        
          

          - **NodeGroups** *(list) --* 

            A single element list with information about the nodes in the replication group.

            
            

            - *(dict) --* 

              Represents a collection of cache nodes in a replication group.

              
              

              - **NodeGroupId** *(string) --* 

                The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

                
              

              - **Status** *(string) --* 

                The current state of this replication group - *creating* , *available* , etc.

                
              

              - **PrimaryEndpoint** *(dict) --* 

                Represents the information required for client programs to connect to a cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **NodeGroupMembers** *(list) --* 

                A list containing information about individual nodes within the node group.

                
                

                - *(dict) --* 

                  Represents a single node within a node group.

                  
                  

                  - **CacheClusterId** *(string) --* 

                    The ID of the cache cluster to which the node belongs.

                    
                  

                  - **CacheNodeId** *(string) --* 

                    The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                    
                  

                  - **ReadEndpoint** *(dict) --* 

                    Represents the information required for client programs to connect to a cache node.

                    
                    

                    - **Address** *(string) --* 

                      The DNS hostname of the cache node.

                      
                    

                    - **Port** *(integer) --* 

                      The port number that the cache engine is listening on.

                      
                
                  

                  - **PreferredAvailabilityZone** *(string) --* 

                    The name of the Availability Zone in which the node is located.

                    
                  

                  - **CurrentRole** *(string) --* 

                    The role that is currently assigned to the node - *primary* or *replica* .

                    
              
            
          
        
          

          - **SnapshottingClusterId** *(string) --* 

            The cache cluster ID that is used as the daily snapshot source for the replication group.

            
          

          - **AutomaticFailover** *(string) --* 

            Indicates the status of Multi-AZ for this replication group.

             

            .. note::

              

              ElastiCache Multi-AZ replication groups are not supported on:

               

               
              * Redis versions earlier than 2.8.6.
               
              * T1 and T2 cache node types.
               

               

            
      
    

  .. py:method:: create_snapshot(**kwargs)

    

    The *CreateSnapshot* action creates a copy of an entire cache cluster at a specific moment in time.

    

    **Request Syntax** 
    ::

      response = client.create_snapshot(
          CacheClusterId='string',
          SnapshotName='string'
      )
    :type CacheClusterId: string
    :param CacheClusterId: **[REQUIRED]** 

      The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.

      

    
    :type SnapshotName: string
    :param SnapshotName: **[REQUIRED]** 

      A name for the snapshot being created.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Snapshot': {
                'SnapshotName': 'string',
                'CacheClusterId': 'string',
                'SnapshotStatus': 'string',
                'SnapshotSource': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'TopicArn': 'string',
                'Port': 123,
                'CacheParameterGroupName': 'string',
                'CacheSubnetGroupName': 'string',
                'VpcId': 'string',
                'AutoMinorVersionUpgrade': True|False,
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string',
                'NodeSnapshots': [
                    {
                        'CacheNodeId': 'string',
                        'CacheSize': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'SnapshotCreateTime': datetime(2015, 1, 1)
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

        
        

        - **Snapshot** *(dict) --* 

          Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

          
          

          - **SnapshotName** *(string) --* 

            The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

            
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the source cache cluster.

            
          

          - **SnapshotStatus** *(string) --* 

            The status of the snapshot. Valid values: ``creating`` | ``available`` | ``restoring`` | ``copying`` | ``deleting`` .

            
          

          - **SnapshotSource** *(string) --* 

            Indicates whether the snapshot is from an automatic backup (``automated`` ) or was created manually (``manual`` ).

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the source cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) used by the source cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used by the source cache cluster.

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the source cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the source cache cluster is located.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the source cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **TopicArn** *(string) --* 

            The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

            
          

          - **Port** *(integer) --* 

            The port number used by each cache nodes in the source cache cluster.

            
          

          - **CacheParameterGroupName** *(string) --* 

            The cache parameter group that is associated with the source cache cluster.

            
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the source cache cluster.

            
          

          - **VpcId** *(string) --* 

            The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

            
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

             

            For manual snapshots, this field reflects the *SnapshotRetentionLimit* for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the *DeleteSnapshot* action. 

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

            
          

          - **NodeSnapshots** *(list) --* 

            A list of the cache nodes in the source cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node in a snapshot of a cache cluster.

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier for the node in the source cache cluster.

                
              

              - **CacheSize** *(string) --* 

                The size of the cache on the source cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created in the source cache cluster.

                
              

              - **SnapshotCreateTime** *(datetime) --* 

                The date and time when the source node's metadata and cache data set was obtained for the snapshot.

                
          
        
      
    

  .. py:method:: delete_cache_cluster(**kwargs)

    

    The *DeleteCacheCluster* action deletes a previously provisioned cache cluster. *DeleteCacheCluster* deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.

     

    This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.

    

    **Request Syntax** 
    ::

      response = client.delete_cache_cluster(
          CacheClusterId='string',
          FinalSnapshotIdentifier='string'
      )
    :type CacheClusterId: string
    :param CacheClusterId: **[REQUIRED]** 

      The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

      

    
    :type FinalSnapshotIdentifier: string
    :param FinalSnapshotIdentifier: 

      The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheCluster': {
                'CacheClusterId': 'string',
                'ConfigurationEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ClientDownloadLandingPage': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'CacheClusterStatus': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'PendingModifiedValues': {
                    'NumCacheNodes': 123,
                    'CacheNodeIdsToRemove': [
                        'string',
                    ],
                    'EngineVersion': 'string'
                },
                'NotificationConfiguration': {
                    'TopicArn': 'string',
                    'TopicStatus': 'string'
                },
                'CacheSecurityGroups': [
                    {
                        'CacheSecurityGroupName': 'string',
                        'Status': 'string'
                    },
                ],
                'CacheParameterGroup': {
                    'CacheParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string',
                    'CacheNodeIdsToReboot': [
                        'string',
                    ]
                },
                'CacheSubnetGroupName': 'string',
                'CacheNodes': [
                    {
                        'CacheNodeId': 'string',
                        'CacheNodeStatus': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'Endpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'ParameterGroupStatus': 'string',
                        'SourceCacheNodeId': 'string',
                        'CustomerAvailabilityZone': 'string'
                    },
                ],
                'AutoMinorVersionUpgrade': True|False,
                'SecurityGroups': [
                    {
                        'SecurityGroupId': 'string',
                        'Status': 'string'
                    },
                ],
                'ReplicationGroupId': 'string',
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific cache cluster.

        
        

        - **CacheCluster** *(dict) --* 

          Contains all of the attributes of a specific cache cluster.

          
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

            
          

          - **ConfigurationEndpoint** *(dict) --* 

            Represents the information required for client programs to connect to a cache node.

            
            

            - **Address** *(string) --* 

              The DNS hostname of the cache node.

              
            

            - **Port** *(integer) --* 

              The port number that the cache engine is listening on.

              
        
          

          - **ClientDownloadLandingPage** *(string) --* 

            The URL of the web page where you can download the latest ElastiCache client library.

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used in this cache cluster.

            
          

          - **CacheClusterStatus** *(string) --* 

            The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

            
            

            - **NumCacheNodes** *(integer) --* 

              The new number of cache nodes for the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **CacheNodeIdsToRemove** *(list) --* 

              A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
            

            - **EngineVersion** *(string) --* 

              The new cache engine version that the cache cluster will run.

              
        
          

          - **NotificationConfiguration** *(dict) --* 

            Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

            
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the topic.

              
            

            - **TopicStatus** *(string) --* 

              The current state of the topic.

              
        
          

          - **CacheSecurityGroups** *(list) --* 

            A list of cache security group elements, composed of name and status sub-elements.

            
            

            - *(dict) --* 

              Represents a cache cluster's status within a particular cache security group.

              
              

              - **CacheSecurityGroupName** *(string) --* 

                The name of the cache security group.

                
              

              - **Status** *(string) --* 

                The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **CacheParameterGroup** *(dict) --* 

            The status of the cache parameter group.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **ParameterApplyStatus** *(string) --* 

              The status of parameter updates.

              
            

            - **CacheNodeIdsToReboot** *(list) --* 

              A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
        
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the cache cluster.

            
          

          - **CacheNodes** *(list) --* 

            A list of cache nodes that are members of the cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                
              

              - **CacheNodeStatus** *(string) --* 

                The current state of this cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created.

                
              

              - **Endpoint** *(dict) --* 

                The hostname for connecting to this cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **ParameterGroupStatus** *(string) --* 

                The status of the parameter group applied to this cache node.

                
              

              - **SourceCacheNodeId** *(string) --* 

                The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                
              

              - **CustomerAvailabilityZone** *(string) --* 

                The Availability Zone where this node was created and now resides.

                
          
        
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SecurityGroups** *(list) --* 

            A list of VPC Security Groups associated with the cache cluster.

            
            

            - *(dict) --* 

              Represents a single cache security group and its status.

              
              

              - **SecurityGroupId** *(string) --* 

                The identifier of the cache security group.

                
              

              - **Status** *(string) --* 

                The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **ReplicationGroupId** *(string) --* 

            The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

             

            Example: ``05:00-09:00`` 

            
      
    

  .. py:method:: delete_cache_parameter_group(**kwargs)

    

    The *DeleteCacheParameterGroup* action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

    

    **Request Syntax** 
    ::

      response = client.delete_cache_parameter_group(
          CacheParameterGroupName='string'
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      The name of the cache parameter group to delete.

       

      .. note::

        The specified cache security group must not be associated with any cache clusters.

      

    
    
    :returns: None

  .. py:method:: delete_cache_security_group(**kwargs)

    

    The *DeleteCacheSecurityGroup* action deletes a cache security group.

     

    .. note::

      You cannot delete a cache security group if it is associated with any cache clusters.

    

    **Request Syntax** 
    ::

      response = client.delete_cache_security_group(
          CacheSecurityGroupName='string'
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: **[REQUIRED]** 

      The name of the cache security group to delete.

       

      .. note::

        You cannot delete the default security group.

      

    
    
    :returns: None

  .. py:method:: delete_cache_subnet_group(**kwargs)

    

    The *DeleteCacheSubnetGroup* action deletes a cache subnet group.

     

    .. note::

      You cannot delete a cache subnet group if it is associated with any cache clusters.

    

    **Request Syntax** 
    ::

      response = client.delete_cache_subnet_group(
          CacheSubnetGroupName='string'
      )
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: **[REQUIRED]** 

      The name of the cache subnet group to delete.

       

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

      

    
    
    :returns: None

  .. py:method:: delete_replication_group(**kwargs)

    

    The *DeleteReplicationGroup* action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.

     

    When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.

    

    **Request Syntax** 
    ::

      response = client.delete_replication_group(
          ReplicationGroupId='string',
          RetainPrimaryCluster=True|False,
          FinalSnapshotIdentifier='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: **[REQUIRED]** 

      The identifier for the cluster to be deleted. This parameter is not case sensitive.

      

    
    :type RetainPrimaryCluster: boolean
    :param RetainPrimaryCluster: 

      If set to *true* , all of the read replicas will be deleted, but the primary node will be retained.

      

    
    :type FinalSnapshotIdentifier: string
    :param FinalSnapshotIdentifier: 

      The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReplicationGroup': {
                'ReplicationGroupId': 'string',
                'Description': 'string',
                'Status': 'string',
                'PendingModifiedValues': {
                    'PrimaryClusterId': 'string',
                    'AutomaticFailoverStatus': 'enabled'|'disabled'
                },
                'MemberClusters': [
                    'string',
                ],
                'NodeGroups': [
                    {
                        'NodeGroupId': 'string',
                        'Status': 'string',
                        'PrimaryEndpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'NodeGroupMembers': [
                            {
                                'CacheClusterId': 'string',
                                'CacheNodeId': 'string',
                                'ReadEndpoint': {
                                    'Address': 'string',
                                    'Port': 123
                                },
                                'PreferredAvailabilityZone': 'string',
                                'CurrentRole': 'string'
                            },
                        ]
                    },
                ],
                'SnapshottingClusterId': 'string',
                'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific replication group.

        
        

        - **ReplicationGroup** *(dict) --* 

          Contains all of the attributes of a specific replication group.

          
          

          - **ReplicationGroupId** *(string) --* 

            The identifier for the replication group.

            
          

          - **Description** *(string) --* 

            The description of the replication group.

            
          

          - **Status** *(string) --* 

            The current state of this replication group - *creating* , *available* , etc.

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

            
            

            - **PrimaryClusterId** *(string) --* 

              The primary cluster ID which will be applied immediately (if ``--apply-immediately`` was specified), or during the next maintenance window.

              
            

            - **AutomaticFailoverStatus** *(string) --* 

              Indicates the status of Multi-AZ for this replication group.

               

              .. note::

                

                ElastiCache Multi-AZ replication groups are not supported on:

                 

                 
                * Redis versions earlier than 2.8.6.
                 
                * T1 and T2 cache node types.
                 

                 

              
        
          

          - **MemberClusters** *(list) --* 

            The names of all the cache clusters that are part of this replication group.

            
            

            - *(string) --* 
        
          

          - **NodeGroups** *(list) --* 

            A single element list with information about the nodes in the replication group.

            
            

            - *(dict) --* 

              Represents a collection of cache nodes in a replication group.

              
              

              - **NodeGroupId** *(string) --* 

                The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

                
              

              - **Status** *(string) --* 

                The current state of this replication group - *creating* , *available* , etc.

                
              

              - **PrimaryEndpoint** *(dict) --* 

                Represents the information required for client programs to connect to a cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **NodeGroupMembers** *(list) --* 

                A list containing information about individual nodes within the node group.

                
                

                - *(dict) --* 

                  Represents a single node within a node group.

                  
                  

                  - **CacheClusterId** *(string) --* 

                    The ID of the cache cluster to which the node belongs.

                    
                  

                  - **CacheNodeId** *(string) --* 

                    The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                    
                  

                  - **ReadEndpoint** *(dict) --* 

                    Represents the information required for client programs to connect to a cache node.

                    
                    

                    - **Address** *(string) --* 

                      The DNS hostname of the cache node.

                      
                    

                    - **Port** *(integer) --* 

                      The port number that the cache engine is listening on.

                      
                
                  

                  - **PreferredAvailabilityZone** *(string) --* 

                    The name of the Availability Zone in which the node is located.

                    
                  

                  - **CurrentRole** *(string) --* 

                    The role that is currently assigned to the node - *primary* or *replica* .

                    
              
            
          
        
          

          - **SnapshottingClusterId** *(string) --* 

            The cache cluster ID that is used as the daily snapshot source for the replication group.

            
          

          - **AutomaticFailover** *(string) --* 

            Indicates the status of Multi-AZ for this replication group.

             

            .. note::

              

              ElastiCache Multi-AZ replication groups are not supported on:

               

               
              * Redis versions earlier than 2.8.6.
               
              * T1 and T2 cache node types.
               

               

            
      
    

  .. py:method:: delete_snapshot(**kwargs)

    

    The *DeleteSnapshot* action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action.

    

    **Request Syntax** 
    ::

      response = client.delete_snapshot(
          SnapshotName='string'
      )
    :type SnapshotName: string
    :param SnapshotName: **[REQUIRED]** 

      The name of the snapshot to be deleted.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Snapshot': {
                'SnapshotName': 'string',
                'CacheClusterId': 'string',
                'SnapshotStatus': 'string',
                'SnapshotSource': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'TopicArn': 'string',
                'Port': 123,
                'CacheParameterGroupName': 'string',
                'CacheSubnetGroupName': 'string',
                'VpcId': 'string',
                'AutoMinorVersionUpgrade': True|False,
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string',
                'NodeSnapshots': [
                    {
                        'CacheNodeId': 'string',
                        'CacheSize': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'SnapshotCreateTime': datetime(2015, 1, 1)
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

        
        

        - **Snapshot** *(dict) --* 

          Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

          
          

          - **SnapshotName** *(string) --* 

            The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

            
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the source cache cluster.

            
          

          - **SnapshotStatus** *(string) --* 

            The status of the snapshot. Valid values: ``creating`` | ``available`` | ``restoring`` | ``copying`` | ``deleting`` .

            
          

          - **SnapshotSource** *(string) --* 

            Indicates whether the snapshot is from an automatic backup (``automated`` ) or was created manually (``manual`` ).

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the source cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) used by the source cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used by the source cache cluster.

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the source cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the source cache cluster is located.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the source cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **TopicArn** *(string) --* 

            The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

            
          

          - **Port** *(integer) --* 

            The port number used by each cache nodes in the source cache cluster.

            
          

          - **CacheParameterGroupName** *(string) --* 

            The cache parameter group that is associated with the source cache cluster.

            
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the source cache cluster.

            
          

          - **VpcId** *(string) --* 

            The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

            
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

             

            For manual snapshots, this field reflects the *SnapshotRetentionLimit* for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the *DeleteSnapshot* action. 

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

            
          

          - **NodeSnapshots** *(list) --* 

            A list of the cache nodes in the source cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node in a snapshot of a cache cluster.

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier for the node in the source cache cluster.

                
              

              - **CacheSize** *(string) --* 

                The size of the cache on the source cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created in the source cache cluster.

                
              

              - **SnapshotCreateTime** *(datetime) --* 

                The date and time when the source node's metadata and cache data set was obtained for the snapshot.

                
          
        
      
    

  .. py:method:: describe_cache_clusters(**kwargs)

    

    The *DescribeCacheClusters* action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

     

    By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional *ShowDetails* flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

     

    If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

     

    If the cluster is in the DELETING state, only cluster level information will be displayed.

     

    If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is *available* , the cluster is ready for use.

     

    If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_clusters(
          CacheClusterId='string',
          MaxRecords=123,
          Marker='string',
          ShowCacheNodeInfo=True|False
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    :type ShowCacheNodeInfo: boolean
    :param ShowCacheNodeInfo: 

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'CacheClusters': [
                {
                    'CacheClusterId': 'string',
                    'ConfigurationEndpoint': {
                        'Address': 'string',
                        'Port': 123
                    },
                    'ClientDownloadLandingPage': 'string',
                    'CacheNodeType': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'CacheClusterStatus': 'string',
                    'NumCacheNodes': 123,
                    'PreferredAvailabilityZone': 'string',
                    'CacheClusterCreateTime': datetime(2015, 1, 1),
                    'PreferredMaintenanceWindow': 'string',
                    'PendingModifiedValues': {
                        'NumCacheNodes': 123,
                        'CacheNodeIdsToRemove': [
                            'string',
                        ],
                        'EngineVersion': 'string'
                    },
                    'NotificationConfiguration': {
                        'TopicArn': 'string',
                        'TopicStatus': 'string'
                    },
                    'CacheSecurityGroups': [
                        {
                            'CacheSecurityGroupName': 'string',
                            'Status': 'string'
                        },
                    ],
                    'CacheParameterGroup': {
                        'CacheParameterGroupName': 'string',
                        'ParameterApplyStatus': 'string',
                        'CacheNodeIdsToReboot': [
                            'string',
                        ]
                    },
                    'CacheSubnetGroupName': 'string',
                    'CacheNodes': [
                        {
                            'CacheNodeId': 'string',
                            'CacheNodeStatus': 'string',
                            'CacheNodeCreateTime': datetime(2015, 1, 1),
                            'Endpoint': {
                                'Address': 'string',
                                'Port': 123
                            },
                            'ParameterGroupStatus': 'string',
                            'SourceCacheNodeId': 'string',
                            'CustomerAvailabilityZone': 'string'
                        },
                    ],
                    'AutoMinorVersionUpgrade': True|False,
                    'SecurityGroups': [
                        {
                            'SecurityGroupId': 'string',
                            'Status': 'string'
                        },
                    ],
                    'ReplicationGroupId': 'string',
                    'SnapshotRetentionLimit': 123,
                    'SnapshotWindow': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheClusters* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **CacheClusters** *(list) --* 

          A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

          
          

          - *(dict) --* 

            Contains all of the attributes of a specific cache cluster.

            
            

            - **CacheClusterId** *(string) --* 

              The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

              
            

            - **ConfigurationEndpoint** *(dict) --* 

              Represents the information required for client programs to connect to a cache node.

              
              

              - **Address** *(string) --* 

                The DNS hostname of the cache node.

                
              

              - **Port** *(integer) --* 

                The port number that the cache engine is listening on.

                
          
            

            - **ClientDownloadLandingPage** *(string) --* 

              The URL of the web page where you can download the latest ElastiCache client library.

              
            

            - **CacheNodeType** *(string) --* 

              The name of the compute and memory capacity node type for the cache cluster.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Engine** *(string) --* 

              The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

              
            

            - **EngineVersion** *(string) --* 

              The version of the cache engine version that is used in this cache cluster.

              
            

            - **CacheClusterStatus** *(string) --* 

              The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

              
            

            - **NumCacheNodes** *(integer) --* 

              The number of cache nodes in the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **PreferredAvailabilityZone** *(string) --* 

              The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

              
            

            - **CacheClusterCreateTime** *(datetime) --* 

              The date and time when the cache cluster was created.

              
            

            - **PreferredMaintenanceWindow** *(string) --* 

              Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

               

               
              * ``sun`` 
               
              * ``mon`` 
               
              * ``tue`` 
               
              * ``wed`` 
               
              * ``thu`` 
               
              * ``fri`` 
               
              * ``sat`` 
               

               

              Example: ``sun:05:00-sun:09:00`` 

              
            

            - **PendingModifiedValues** *(dict) --* 

              A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

              
              

              - **NumCacheNodes** *(integer) --* 

                The new number of cache nodes for the cache cluster.

                 

                For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

                
              

              - **CacheNodeIdsToRemove** *(list) --* 

                A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                
                

                - *(string) --* 
            
              

              - **EngineVersion** *(string) --* 

                The new cache engine version that the cache cluster will run.

                
          
            

            - **NotificationConfiguration** *(dict) --* 

              Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

              
              

              - **TopicArn** *(string) --* 

                The Amazon Resource Name (ARN) that identifies the topic.

                
              

              - **TopicStatus** *(string) --* 

                The current state of the topic.

                
          
            

            - **CacheSecurityGroups** *(list) --* 

              A list of cache security group elements, composed of name and status sub-elements.

              
              

              - *(dict) --* 

                Represents a cache cluster's status within a particular cache security group.

                
                

                - **CacheSecurityGroupName** *(string) --* 

                  The name of the cache security group.

                  
                

                - **Status** *(string) --* 

                  The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                  
            
          
            

            - **CacheParameterGroup** *(dict) --* 

              The status of the cache parameter group.

              
              

              - **CacheParameterGroupName** *(string) --* 

                The name of the cache parameter group.

                
              

              - **ParameterApplyStatus** *(string) --* 

                The status of parameter updates.

                
              

              - **CacheNodeIdsToReboot** *(list) --* 

                A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

                
                

                - *(string) --* 
            
          
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group associated with the cache cluster.

              
            

            - **CacheNodes** *(list) --* 

              A list of cache nodes that are members of the cache cluster.

              
              

              - *(dict) --* 

                Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

                 

                Valid node types are as follows:

                 

                 
                * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
                 
                * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
                 

                
                 
                * Compute optimized: ``cache.c1.xlarge`` 
                 
                * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
                 
                * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
                 

                
                 

                 

                **Notes:** 

                 

                 
                * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
                 
                * Redis backup/restore is not supported for t2 instances.
                 
                * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
                 

                 

                For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

                
                

                - **CacheNodeId** *(string) --* 

                  The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                  
                

                - **CacheNodeStatus** *(string) --* 

                  The current state of this cache node.

                  
                

                - **CacheNodeCreateTime** *(datetime) --* 

                  The date and time when the cache node was created.

                  
                

                - **Endpoint** *(dict) --* 

                  The hostname for connecting to this cache node.

                  
                  

                  - **Address** *(string) --* 

                    The DNS hostname of the cache node.

                    
                  

                  - **Port** *(integer) --* 

                    The port number that the cache engine is listening on.

                    
              
                

                - **ParameterGroupStatus** *(string) --* 

                  The status of the parameter group applied to this cache node.

                  
                

                - **SourceCacheNodeId** *(string) --* 

                  The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                  
                

                - **CustomerAvailabilityZone** *(string) --* 

                  The Availability Zone where this node was created and now resides.

                  
            
          
            

            - **AutoMinorVersionUpgrade** *(boolean) --* 

              This parameter is currently disabled.

              
            

            - **SecurityGroups** *(list) --* 

              A list of VPC Security Groups associated with the cache cluster.

              
              

              - *(dict) --* 

                Represents a single cache security group and its status.

                
                

                - **SecurityGroupId** *(string) --* 

                  The identifier of the cache security group.

                  
                

                - **Status** *(string) --* 

                  The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                  
            
          
            

            - **ReplicationGroupId** *(string) --* 

              The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

              
            

            - **SnapshotRetentionLimit** *(integer) --* 

              The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

               

              **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

              
            

            - **SnapshotWindow** *(string) --* 

              The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

               

              Example: ``05:00-09:00`` 

              
        
      
    

  .. py:method:: describe_cache_engine_versions(**kwargs)

    

    The *DescribeCacheEngineVersions* action returns a list of the available cache engines and their versions.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_engine_versions(
          Engine='string',
          EngineVersion='string',
          CacheParameterGroupFamily='string',
          MaxRecords=123,
          Marker='string',
          DefaultOnly=True|False
      )
    :type Engine: string
    :param Engine: 

      The cache engine to return. Valid values: ``memcached`` | ``redis`` 

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The cache engine version to return.

       

      Example: ``1.4.14`` 

      

    
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: 

      The name of a specific cache parameter group family to return details for.

       

      Constraints:

       

       
      * Must be 1 to 255 alphanumeric characters
       
      * First character must be a letter
       
      * Cannot end with a hyphen or contain two consecutive hyphens
       

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    :type DefaultOnly: boolean
    :param DefaultOnly: 

      If *true* , specifies that only the default version of the specified engine or engine and major version combination is to be returned.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'CacheEngineVersions': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'CacheEngineDescription': 'string',
                    'CacheEngineVersionDescription': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a  DescribeCacheEngineVersions action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **CacheEngineVersions** *(list) --* 

          A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

          
          

          - *(dict) --* 

            Provides all of the details about a particular cache engine version.

            
            

            - **Engine** *(string) --* 

              The name of the cache engine.

              
            

            - **EngineVersion** *(string) --* 

              The version number of the cache engine.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family associated with this cache engine.

              
            

            - **CacheEngineDescription** *(string) --* 

              The description of the cache engine.

              
            

            - **CacheEngineVersionDescription** *(string) --* 

              The description of the cache engine version.

              
        
      
    

  .. py:method:: describe_cache_parameter_groups(**kwargs)

    

    The *DescribeCacheParameterGroups* action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_parameter_groups(
          CacheParameterGroupName='string',
          MaxRecords=123,
          Marker='string'
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

      The name of a specific cache parameter group to return details for.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'CacheParameterGroups': [
                {
                    'CacheParameterGroupName': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'Description': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheParameterGroups* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **CacheParameterGroups** *(list) --* 

          A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

          
          

          - *(dict) --* 

            Represents the output of a *CreateCacheParameterGroup* action.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family that this cache parameter group is compatible with.

              
            

            - **Description** *(string) --* 

              The description for this cache parameter group.

              
        
      
    

  .. py:method:: describe_cache_parameters(**kwargs)

    

    The *DescribeCacheParameters* action returns the detailed parameter list for a particular cache parameter group.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_parameters(
          CacheParameterGroupName='string',
          Source='string',
          MaxRecords=123,
          Marker='string'
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      The name of a specific cache parameter group to return details for.

      

    
    :type Source: string
    :param Source: 

      The parameter types to return.

       

      Valid values: ``user`` | ``system`` | ``engine-default`` 

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'Parameters': [
                {
                    'ParameterName': 'string',
                    'ParameterValue': 'string',
                    'Description': 'string',
                    'Source': 'string',
                    'DataType': 'string',
                    'AllowedValues': 'string',
                    'IsModifiable': True|False,
                    'MinimumEngineVersion': 'string'
                },
            ],
            'CacheNodeTypeSpecificParameters': [
                {
                    'ParameterName': 'string',
                    'Description': 'string',
                    'Source': 'string',
                    'DataType': 'string',
                    'AllowedValues': 'string',
                    'IsModifiable': True|False,
                    'MinimumEngineVersion': 'string',
                    'CacheNodeTypeSpecificValues': [
                        {
                            'CacheNodeType': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheParameters* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **Parameters** *(list) --* 

          A list of  Parameter instances.

          
          

          - *(dict) --* 

            Describes an individual setting that controls some aspect of ElastiCache behavior.

            
            

            - **ParameterName** *(string) --* 

              The name of the parameter.

              
            

            - **ParameterValue** *(string) --* 

              The value of the parameter.

              
            

            - **Description** *(string) --* 

              A description of the parameter.

              
            

            - **Source** *(string) --* 

              The source of the parameter.

              
            

            - **DataType** *(string) --* 

              The valid data type for the parameter.

              
            

            - **AllowedValues** *(string) --* 

              The valid range of values for the parameter.

              
            

            - **IsModifiable** *(boolean) --* 

              Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The earliest cache engine version to which the parameter can apply.

              
        
      
        

        - **CacheNodeTypeSpecificParameters** *(list) --* 

          A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

          
          

          - *(dict) --* 

            A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a *cache.m1.large* cache node type would have a larger *maxmemory* value than a *cache.m1.small* type.

            
            

            - **ParameterName** *(string) --* 

              The name of the parameter.

              
            

            - **Description** *(string) --* 

              A description of the parameter.

              
            

            - **Source** *(string) --* 

              The source of the parameter value.

              
            

            - **DataType** *(string) --* 

              The valid data type for the parameter.

              
            

            - **AllowedValues** *(string) --* 

              The valid range of values for the parameter.

              
            

            - **IsModifiable** *(boolean) --* 

              Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The earliest cache engine version to which the parameter can apply.

              
            

            - **CacheNodeTypeSpecificValues** *(list) --* 

              A list of cache node types and their corresponding values for this parameter.

              
              

              - *(dict) --* 

                A value that applies only to a certain cache node type.

                
                

                - **CacheNodeType** *(string) --* 

                  The cache node type for which this value applies.

                  
                

                - **Value** *(string) --* 

                  The value for the cache node type.

                  
            
          
        
      
    

  .. py:method:: describe_cache_security_groups(**kwargs)

    

    The *DescribeCacheSecurityGroups* action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_security_groups(
          CacheSecurityGroupName='string',
          MaxRecords=123,
          Marker='string'
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: 

      The name of the cache security group to return details for.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'CacheSecurityGroups': [
                {
                    'OwnerId': 'string',
                    'CacheSecurityGroupName': 'string',
                    'Description': 'string',
                    'EC2SecurityGroups': [
                        {
                            'Status': 'string',
                            'EC2SecurityGroupName': 'string',
                            'EC2SecurityGroupOwnerId': 'string'
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheSecurityGroups* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **CacheSecurityGroups** *(list) --* 

          A list of cache security groups. Each element in the list contains detailed information about one group.

          
          

          - *(dict) --* 

            Represents the output of one of the following actions:

             

             
            *  *AuthorizeCacheSecurityGroupIngress*  
             
            *  *CreateCacheSecurityGroup*  
             
            *  *RevokeCacheSecurityGroupIngress*  
             

            
            

            - **OwnerId** *(string) --* 

              The AWS account ID of the cache security group owner.

              
            

            - **CacheSecurityGroupName** *(string) --* 

              The name of the cache security group.

              
            

            - **Description** *(string) --* 

              The description of the cache security group.

              
            

            - **EC2SecurityGroups** *(list) --* 

              A list of Amazon EC2 security groups that are associated with this cache security group.

              
              

              - *(dict) --* 

                Provides ownership and status information for an Amazon EC2 security group.

                
                

                - **Status** *(string) --* 

                  The status of the Amazon EC2 security group.

                  
                

                - **EC2SecurityGroupName** *(string) --* 

                  The name of the Amazon EC2 security group.

                  
                

                - **EC2SecurityGroupOwnerId** *(string) --* 

                  The AWS account ID of the Amazon EC2 security group owner.

                  
            
          
        
      
    

  .. py:method:: describe_cache_subnet_groups(**kwargs)

    

    The *DescribeCacheSubnetGroups* action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

    

    **Request Syntax** 
    ::

      response = client.describe_cache_subnet_groups(
          CacheSubnetGroupName='string',
          MaxRecords=123,
          Marker='string'
      )
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: 

      The name of the cache subnet group to return details for.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'CacheSubnetGroups': [
                {
                    'CacheSubnetGroupName': 'string',
                    'CacheSubnetGroupDescription': 'string',
                    'VpcId': 'string',
                    'Subnets': [
                        {
                            'SubnetIdentifier': 'string',
                            'SubnetAvailabilityZone': {
                                'Name': 'string'
                            }
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheSubnetGroups* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **CacheSubnetGroups** *(list) --* 

          A list of cache subnet groups. Each element in the list contains detailed information about one group.

          
          

          - *(dict) --* 

            Represents the output of one of the following actions:

             

             
            *  *CreateCacheSubnetGroup*  
             
            *  *ModifyCacheSubnetGroup*  
             

            
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group.

              
            

            - **CacheSubnetGroupDescription** *(string) --* 

              The description of the cache subnet group.

              
            

            - **VpcId** *(string) --* 

              The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

              
            

            - **Subnets** *(list) --* 

              A list of subnets associated with the cache subnet group.

              
              

              - *(dict) --* 

                Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

                
                

                - **SubnetIdentifier** *(string) --* 

                  The unique identifier for the subnet.

                  
                

                - **SubnetAvailabilityZone** *(dict) --* 

                  The Availability Zone associated with the subnet.

                  
                  

                  - **Name** *(string) --* 

                    The name of the Availability Zone.

                    
              
            
          
        
      
    

  .. py:method:: describe_engine_default_parameters(**kwargs)

    

    The *DescribeEngineDefaultParameters* action returns the default engine and system parameter information for the specified cache engine.

    

    **Request Syntax** 
    ::

      response = client.describe_engine_default_parameters(
          CacheParameterGroupFamily='string',
          MaxRecords=123,
          Marker='string'
      )
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: **[REQUIRED]** 

      The name of the cache parameter group family. Valid values are: ``memcached1.4`` | ``redis2.6`` | ``redis2.8`` 

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'EngineDefaults': {
                'CacheParameterGroupFamily': 'string',
                'Marker': 'string',
                'Parameters': [
                    {
                        'ParameterName': 'string',
                        'ParameterValue': 'string',
                        'Description': 'string',
                        'Source': 'string',
                        'DataType': 'string',
                        'AllowedValues': 'string',
                        'IsModifiable': True|False,
                        'MinimumEngineVersion': 'string'
                    },
                ],
                'CacheNodeTypeSpecificParameters': [
                    {
                        'ParameterName': 'string',
                        'Description': 'string',
                        'Source': 'string',
                        'DataType': 'string',
                        'AllowedValues': 'string',
                        'IsModifiable': True|False,
                        'MinimumEngineVersion': 'string',
                        'CacheNodeTypeSpecificValues': [
                            {
                                'CacheNodeType': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeEngineDefaultParameters* action.

        
        

        - **EngineDefaults** *(dict) --* 

          Represents the output of a *DescribeEngineDefaultParameters* action.

          
          

          - **CacheParameterGroupFamily** *(string) --* 

            Specifies the name of the cache parameter group family to which the engine default parameters apply.

            
          

          - **Marker** *(string) --* 

            Provides an identifier to allow retrieval of paginated results.

            
          

          - **Parameters** *(list) --* 

            Contains a list of engine default parameters.

            
            

            - *(dict) --* 

              Describes an individual setting that controls some aspect of ElastiCache behavior.

              
              

              - **ParameterName** *(string) --* 

                The name of the parameter.

                
              

              - **ParameterValue** *(string) --* 

                The value of the parameter.

                
              

              - **Description** *(string) --* 

                A description of the parameter.

                
              

              - **Source** *(string) --* 

                The source of the parameter.

                
              

              - **DataType** *(string) --* 

                The valid data type for the parameter.

                
              

              - **AllowedValues** *(string) --* 

                The valid range of values for the parameter.

                
              

              - **IsModifiable** *(boolean) --* 

                Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

                
              

              - **MinimumEngineVersion** *(string) --* 

                The earliest cache engine version to which the parameter can apply.

                
          
        
          

          - **CacheNodeTypeSpecificParameters** *(list) --* 

            A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

            
            

            - *(dict) --* 

              A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a *cache.m1.large* cache node type would have a larger *maxmemory* value than a *cache.m1.small* type.

              
              

              - **ParameterName** *(string) --* 

                The name of the parameter.

                
              

              - **Description** *(string) --* 

                A description of the parameter.

                
              

              - **Source** *(string) --* 

                The source of the parameter value.

                
              

              - **DataType** *(string) --* 

                The valid data type for the parameter.

                
              

              - **AllowedValues** *(string) --* 

                The valid range of values for the parameter.

                
              

              - **IsModifiable** *(boolean) --* 

                Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

                
              

              - **MinimumEngineVersion** *(string) --* 

                The earliest cache engine version to which the parameter can apply.

                
              

              - **CacheNodeTypeSpecificValues** *(list) --* 

                A list of cache node types and their corresponding values for this parameter.

                
                

                - *(dict) --* 

                  A value that applies only to a certain cache node type.

                  
                  

                  - **CacheNodeType** *(string) --* 

                    The cache node type for which this value applies.

                    
                  

                  - **Value** *(string) --* 

                    The value for the cache node type.

                    
              
            
          
        
      
    

  .. py:method:: describe_events(**kwargs)

    

    The *DescribeEvents* action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

     

    By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

    

    **Request Syntax** 
    ::

      response = client.describe_events(
          SourceIdentifier='string',
          SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
          StartTime=datetime(2015, 1, 1),
          EndTime=datetime(2015, 1, 1),
          Duration=123,
          MaxRecords=123,
          Marker='string'
      )
    :type SourceIdentifier: string
    :param SourceIdentifier: 

      The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

      

    
    :type SourceType: string
    :param SourceType: 

      The event source to retrieve events for. If no value is specified, all events are returned.

       

      Valid values are: ``cache-cluster`` | ``cache-parameter-group`` | ``cache-security-group`` | ``cache-subnet-group`` 

      

    
    :type StartTime: datetime
    :param StartTime: 

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

      

    
    :type EndTime: datetime
    :param EndTime: 

      The end of the time interval for which to retrieve events, specified in ISO 8601 format.

      

    
    :type Duration: integer
    :param Duration: 

      The number of minutes' worth of events to retrieve.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'Events': [
                {
                    'SourceIdentifier': 'string',
                    'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
                    'Message': 'string',
                    'Date': datetime(2015, 1, 1)
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeEvents* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **Events** *(list) --* 

          A list of events. Each element in the list contains detailed information about one event.

          
          

          - *(dict) --* 

            Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

            
            

            - **SourceIdentifier** *(string) --* 

              The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

              
            

            - **SourceType** *(string) --* 

              Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

              
            

            - **Message** *(string) --* 

              The text of the event.

              
            

            - **Date** *(datetime) --* 

              The date and time when the event occurred.

              
        
      
    

  .. py:method:: describe_replication_groups(**kwargs)

    

    The *DescribeReplicationGroups* action returns information about a particular replication group. If no identifier is specified, *DescribeReplicationGroups* returns information about all replication groups.

    

    **Request Syntax** 
    ::

      response = client.describe_replication_groups(
          ReplicationGroupId='string',
          MaxRecords=123,
          Marker='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The identifier for the replication group to be described. This parameter is not case sensitive.

       

      If you do not specify this parameter, information about all replication groups is returned.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'ReplicationGroups': [
                {
                    'ReplicationGroupId': 'string',
                    'Description': 'string',
                    'Status': 'string',
                    'PendingModifiedValues': {
                        'PrimaryClusterId': 'string',
                        'AutomaticFailoverStatus': 'enabled'|'disabled'
                    },
                    'MemberClusters': [
                        'string',
                    ],
                    'NodeGroups': [
                        {
                            'NodeGroupId': 'string',
                            'Status': 'string',
                            'PrimaryEndpoint': {
                                'Address': 'string',
                                'Port': 123
                            },
                            'NodeGroupMembers': [
                                {
                                    'CacheClusterId': 'string',
                                    'CacheNodeId': 'string',
                                    'ReadEndpoint': {
                                        'Address': 'string',
                                        'Port': 123
                                    },
                                    'PreferredAvailabilityZone': 'string',
                                    'CurrentRole': 'string'
                                },
                            ]
                        },
                    ],
                    'SnapshottingClusterId': 'string',
                    'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReplicationGroups* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **ReplicationGroups** *(list) --* 

          A list of replication groups. Each item in the list contains detailed information about one replication group.

          
          

          - *(dict) --* 

            Contains all of the attributes of a specific replication group.

            
            

            - **ReplicationGroupId** *(string) --* 

              The identifier for the replication group.

              
            

            - **Description** *(string) --* 

              The description of the replication group.

              
            

            - **Status** *(string) --* 

              The current state of this replication group - *creating* , *available* , etc.

              
            

            - **PendingModifiedValues** *(dict) --* 

              A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

              
              

              - **PrimaryClusterId** *(string) --* 

                The primary cluster ID which will be applied immediately (if ``--apply-immediately`` was specified), or during the next maintenance window.

                
              

              - **AutomaticFailoverStatus** *(string) --* 

                Indicates the status of Multi-AZ for this replication group.

                 

                .. note::

                  

                  ElastiCache Multi-AZ replication groups are not supported on:

                   

                   
                  * Redis versions earlier than 2.8.6.
                   
                  * T1 and T2 cache node types.
                   

                   

                
          
            

            - **MemberClusters** *(list) --* 

              The names of all the cache clusters that are part of this replication group.

              
              

              - *(string) --* 
          
            

            - **NodeGroups** *(list) --* 

              A single element list with information about the nodes in the replication group.

              
              

              - *(dict) --* 

                Represents a collection of cache nodes in a replication group.

                
                

                - **NodeGroupId** *(string) --* 

                  The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

                  
                

                - **Status** *(string) --* 

                  The current state of this replication group - *creating* , *available* , etc.

                  
                

                - **PrimaryEndpoint** *(dict) --* 

                  Represents the information required for client programs to connect to a cache node.

                  
                  

                  - **Address** *(string) --* 

                    The DNS hostname of the cache node.

                    
                  

                  - **Port** *(integer) --* 

                    The port number that the cache engine is listening on.

                    
              
                

                - **NodeGroupMembers** *(list) --* 

                  A list containing information about individual nodes within the node group.

                  
                  

                  - *(dict) --* 

                    Represents a single node within a node group.

                    
                    

                    - **CacheClusterId** *(string) --* 

                      The ID of the cache cluster to which the node belongs.

                      
                    

                    - **CacheNodeId** *(string) --* 

                      The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                      
                    

                    - **ReadEndpoint** *(dict) --* 

                      Represents the information required for client programs to connect to a cache node.

                      
                      

                      - **Address** *(string) --* 

                        The DNS hostname of the cache node.

                        
                      

                      - **Port** *(integer) --* 

                        The port number that the cache engine is listening on.

                        
                  
                    

                    - **PreferredAvailabilityZone** *(string) --* 

                      The name of the Availability Zone in which the node is located.

                      
                    

                    - **CurrentRole** *(string) --* 

                      The role that is currently assigned to the node - *primary* or *replica* .

                      
                
              
            
          
            

            - **SnapshottingClusterId** *(string) --* 

              The cache cluster ID that is used as the daily snapshot source for the replication group.

              
            

            - **AutomaticFailover** *(string) --* 

              Indicates the status of Multi-AZ for this replication group.

               

              .. note::

                

                ElastiCache Multi-AZ replication groups are not supported on:

                 

                 
                * Redis versions earlier than 2.8.6.
                 
                * T1 and T2 cache node types.
                 

                 

              
        
      
    

  .. py:method:: describe_reserved_cache_nodes(**kwargs)

    

    The *DescribeReservedCacheNodes* action returns information about reserved cache nodes for this account, or about a specified reserved cache node.

    

    **Request Syntax** 
    ::

      response = client.describe_reserved_cache_nodes(
          ReservedCacheNodeId='string',
          ReservedCacheNodesOfferingId='string',
          CacheNodeType='string',
          Duration='string',
          ProductDescription='string',
          OfferingType='string',
          MaxRecords=123,
          Marker='string'
      )
    :type ReservedCacheNodeId: string
    :param ReservedCacheNodeId: 

      The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

      

    
    :type ReservedCacheNodesOfferingId: string
    :param ReservedCacheNodesOfferingId: 

      The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

      

    
    :type CacheNodeType: string
    :param CacheNodeType: 

      The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Duration: string
    :param Duration: 

      The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

       

      Valid Values: ``1 | 3 | 31536000 | 94608000`` 

      

    
    :type ProductDescription: string
    :param ProductDescription: 

      The product description filter value. Use this parameter to show only those reservations matching the specified product description.

      

    
    :type OfferingType: string
    :param OfferingType: 

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

       

      Valid values: ``"Light Utilization"|"Medium Utilization"|"Heavy Utilization"`` 

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'ReservedCacheNodes': [
                {
                    'ReservedCacheNodeId': 'string',
                    'ReservedCacheNodesOfferingId': 'string',
                    'CacheNodeType': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'Duration': 123,
                    'FixedPrice': 123.0,
                    'UsagePrice': 123.0,
                    'CacheNodeCount': 123,
                    'ProductDescription': 'string',
                    'OfferingType': 'string',
                    'State': 'string',
                    'RecurringCharges': [
                        {
                            'RecurringChargeAmount': 123.0,
                            'RecurringChargeFrequency': 'string'
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReservedCacheNodes* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **ReservedCacheNodes** *(list) --* 

          A list of reserved cache nodes. Each element in the list contains detailed information about one node.

          
          

          - *(dict) --* 

            Represents the output of a *PurchaseReservedCacheNodesOffering* action.

            
            

            - **ReservedCacheNodeId** *(string) --* 

              The unique identifier for the reservation.

              
            

            - **ReservedCacheNodesOfferingId** *(string) --* 

              The offering identifier.

              
            

            - **CacheNodeType** *(string) --* 

              The cache node type for the reserved cache nodes.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **StartTime** *(datetime) --* 

              The time the reservation started.

              
            

            - **Duration** *(integer) --* 

              The duration of the reservation in seconds.

              
            

            - **FixedPrice** *(float) --* 

              The fixed price charged for this reserved cache node.

              
            

            - **UsagePrice** *(float) --* 

              The hourly price charged for this reserved cache node.

              
            

            - **CacheNodeCount** *(integer) --* 

              The number of cache nodes that have been reserved.

              
            

            - **ProductDescription** *(string) --* 

              The description of the reserved cache node.

              
            

            - **OfferingType** *(string) --* 

              The offering type of this reserved cache node.

              
            

            - **State** *(string) --* 

              The state of the reserved cache node.

              
            

            - **RecurringCharges** *(list) --* 

              The recurring price charged to run this reserved cache node.

              
              

              - *(dict) --* 

                Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

                
                

                - **RecurringChargeAmount** *(float) --* 

                  The monetary amount of the recurring charge.

                  
                

                - **RecurringChargeFrequency** *(string) --* 

                  The frequency of the recurring charge.

                  
            
          
        
      
    

  .. py:method:: describe_reserved_cache_nodes_offerings(**kwargs)

    

    The *DescribeReservedCacheNodesOfferings* action lists available reserved cache node offerings.

    

    **Request Syntax** 
    ::

      response = client.describe_reserved_cache_nodes_offerings(
          ReservedCacheNodesOfferingId='string',
          CacheNodeType='string',
          Duration='string',
          ProductDescription='string',
          OfferingType='string',
          MaxRecords=123,
          Marker='string'
      )
    :type ReservedCacheNodesOfferingId: string
    :param ReservedCacheNodesOfferingId: 

      The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

       

      Example: ``438012d3-4052-4cc7-b2e3-8d3372e0e706`` 

      

    
    :type CacheNodeType: string
    :param CacheNodeType: 

      The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Duration: string
    :param Duration: 

      Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

       

      Valid Values: ``1 | 3 | 31536000 | 94608000`` 

      

    
    :type ProductDescription: string
    :param ProductDescription: 

      The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

      

    
    :type OfferingType: string
    :param OfferingType: 

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

       

      Valid Values: ``"Light Utilization"|"Medium Utilization"|"Heavy Utilization"`` 

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'ReservedCacheNodesOfferings': [
                {
                    'ReservedCacheNodesOfferingId': 'string',
                    'CacheNodeType': 'string',
                    'Duration': 123,
                    'FixedPrice': 123.0,
                    'UsagePrice': 123.0,
                    'ProductDescription': 'string',
                    'OfferingType': 'string',
                    'RecurringCharges': [
                        {
                            'RecurringChargeAmount': 123.0,
                            'RecurringChargeFrequency': 'string'
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReservedCacheNodesOfferings* action.

        
        

        - **Marker** *(string) --* 

          Provides an identifier to allow retrieval of paginated results.

          
        

        - **ReservedCacheNodesOfferings** *(list) --* 

          A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

          
          

          - *(dict) --* 

            Describes all of the attributes of a reserved cache node offering.

            
            

            - **ReservedCacheNodesOfferingId** *(string) --* 

              A unique identifier for the reserved cache node offering.

              
            

            - **CacheNodeType** *(string) --* 

              The cache node type for the reserved cache node.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Duration** *(integer) --* 

              The duration of the offering. in seconds.

              
            

            - **FixedPrice** *(float) --* 

              The fixed price charged for this offering.

              
            

            - **UsagePrice** *(float) --* 

              The hourly price charged for this offering.

              
            

            - **ProductDescription** *(string) --* 

              The cache engine used by the offering.

              
            

            - **OfferingType** *(string) --* 

              The offering type.

              
            

            - **RecurringCharges** *(list) --* 

              The recurring price charged to run this reserved cache node.

              
              

              - *(dict) --* 

                Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

                
                

                - **RecurringChargeAmount** *(float) --* 

                  The monetary amount of the recurring charge.

                  
                

                - **RecurringChargeFrequency** *(string) --* 

                  The frequency of the recurring charge.

                  
            
          
        
      
    

  .. py:method:: describe_snapshots(**kwargs)

    

    The *DescribeSnapshots* action returns information about cache cluster snapshots. By default, *DescribeSnapshots* lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

    

    **Request Syntax** 
    ::

      response = client.describe_snapshots(
          CacheClusterId='string',
          SnapshotName='string',
          SnapshotSource='string',
          Marker='string',
          MaxRecords=123
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

      

    
    :type SnapshotName: string
    :param SnapshotName: 

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

      

    
    :type SnapshotSource: string
    :param SnapshotSource: 

      If set to ``system`` , the output shows snapshots that were automatically created by ElastiCache. If set to ``user`` the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 50

       

      Constraints: minimum 20; maximum 50.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Marker': 'string',
            'Snapshots': [
                {
                    'SnapshotName': 'string',
                    'CacheClusterId': 'string',
                    'SnapshotStatus': 'string',
                    'SnapshotSource': 'string',
                    'CacheNodeType': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'NumCacheNodes': 123,
                    'PreferredAvailabilityZone': 'string',
                    'CacheClusterCreateTime': datetime(2015, 1, 1),
                    'PreferredMaintenanceWindow': 'string',
                    'TopicArn': 'string',
                    'Port': 123,
                    'CacheParameterGroupName': 'string',
                    'CacheSubnetGroupName': 'string',
                    'VpcId': 'string',
                    'AutoMinorVersionUpgrade': True|False,
                    'SnapshotRetentionLimit': 123,
                    'SnapshotWindow': 'string',
                    'NodeSnapshots': [
                        {
                            'CacheNodeId': 'string',
                            'CacheSize': 'string',
                            'CacheNodeCreateTime': datetime(2015, 1, 1),
                            'SnapshotCreateTime': datetime(2015, 1, 1)
                        },
                    ]
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeSnapshots* action.

        
        

        - **Marker** *(string) --* 

          An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

          
        

        - **Snapshots** *(list) --* 

          A list of snapshots. Each item in the list contains detailed information about one snapshot.

          
          

          - *(dict) --* 

            Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

            
            

            - **SnapshotName** *(string) --* 

              The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

              
            

            - **CacheClusterId** *(string) --* 

              The user-supplied identifier of the source cache cluster.

              
            

            - **SnapshotStatus** *(string) --* 

              The status of the snapshot. Valid values: ``creating`` | ``available`` | ``restoring`` | ``copying`` | ``deleting`` .

              
            

            - **SnapshotSource** *(string) --* 

              Indicates whether the snapshot is from an automatic backup (``automated`` ) or was created manually (``manual`` ).

              
            

            - **CacheNodeType** *(string) --* 

              The name of the compute and memory capacity node type for the source cache cluster.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Engine** *(string) --* 

              The name of the cache engine (*memcached* or *redis* ) used by the source cache cluster.

              
            

            - **EngineVersion** *(string) --* 

              The version of the cache engine version that is used by the source cache cluster.

              
            

            - **NumCacheNodes** *(integer) --* 

              The number of cache nodes in the source cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **PreferredAvailabilityZone** *(string) --* 

              The name of the Availability Zone in which the source cache cluster is located.

              
            

            - **CacheClusterCreateTime** *(datetime) --* 

              The date and time when the source cache cluster was created.

              
            

            - **PreferredMaintenanceWindow** *(string) --* 

              Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

               

               
              * ``sun`` 
               
              * ``mon`` 
               
              * ``tue`` 
               
              * ``wed`` 
               
              * ``thu`` 
               
              * ``fri`` 
               
              * ``sat`` 
               

               

              Example: ``sun:05:00-sun:09:00`` 

              
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

              
            

            - **Port** *(integer) --* 

              The port number used by each cache nodes in the source cache cluster.

              
            

            - **CacheParameterGroupName** *(string) --* 

              The cache parameter group that is associated with the source cache cluster.

              
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group associated with the source cache cluster.

              
            

            - **VpcId** *(string) --* 

              The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

              
            

            - **AutoMinorVersionUpgrade** *(boolean) --* 

              This parameter is currently disabled.

              
            

            - **SnapshotRetentionLimit** *(integer) --* 

              For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

               

              For manual snapshots, this field reflects the *SnapshotRetentionLimit* for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the *DeleteSnapshot* action. 

               

              **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

              
            

            - **SnapshotWindow** *(string) --* 

              The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

              
            

            - **NodeSnapshots** *(list) --* 

              A list of the cache nodes in the source cache cluster.

              
              

              - *(dict) --* 

                Represents an individual cache node in a snapshot of a cache cluster.

                
                

                - **CacheNodeId** *(string) --* 

                  The cache node identifier for the node in the source cache cluster.

                  
                

                - **CacheSize** *(string) --* 

                  The size of the cache on the source cache node.

                  
                

                - **CacheNodeCreateTime** *(datetime) --* 

                  The date and time when the cache node was created in the source cache cluster.

                  
                

                - **SnapshotCreateTime** *(datetime) --* 

                  The date and time when the source node's metadata and cache data set was obtained for the snapshot.

                  
            
          
        
      
    

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_waiter(waiter_name)

        


  .. py:method:: list_tags_for_resource(**kwargs)

    

    The *ListTagsForResource* action lists all cost allocation tags currently on the named resource. A *cost allocation tag* is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs.

     

    You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see `Using Cost Allocation Tags in Amazon ElastiCache`_ .

    

    **Request Syntax** 
    ::

      response = client.list_tags_for_resource(
          ResourceName='string'
      )
    :type ResourceName: string
    :param ResourceName: **[REQUIRED]** 

      The name of the resource for which you want the list of tags, for example ``arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster`` .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output from the *AddTagsToResource* , *ListTagsOnResource* , and *RemoveTagsFromResource* actions.

        
        

        - **TagList** *(list) --* 

          A list of cost allocation tags as key-value pairs. 

          
          

          - *(dict) --* 

            A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

            
            

            - **Key** *(string) --* 

              The key for the tag.

              
            

            - **Value** *(string) --* 

              The tag's value. May not be null.

              
        
      
    

  .. py:method:: modify_cache_cluster(**kwargs)

    

    The *ModifyCacheCluster* action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.

    

    **Request Syntax** 
    ::

      response = client.modify_cache_cluster(
          CacheClusterId='string',
          NumCacheNodes=123,
          CacheNodeIdsToRemove=[
              'string',
          ],
          AZMode='single-az'|'cross-az',
          NewAvailabilityZones=[
              'string',
          ],
          CacheSecurityGroupNames=[
              'string',
          ],
          SecurityGroupIds=[
              'string',
          ],
          PreferredMaintenanceWindow='string',
          NotificationTopicArn='string',
          CacheParameterGroupName='string',
          NotificationTopicStatus='string',
          ApplyImmediately=True|False,
          EngineVersion='string',
          AutoMinorVersionUpgrade=True|False,
          SnapshotRetentionLimit=123,
          SnapshotWindow='string'
      )
    :type CacheClusterId: string
    :param CacheClusterId: **[REQUIRED]** 

      The cache cluster identifier. This value is stored as a lowercase string.

      

    
    :type NumCacheNodes: integer
    :param NumCacheNodes: 

      The number of cache nodes that the cache cluster should have. If the value for ``NumCacheNodes`` is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

       

      If you are removing cache nodes, you must use the ``CacheNodeIdsToRemove`` parameter to provide the IDs of the specific cache nodes to remove.

       

      For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

       

      **Note:** Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ``ApplyImmediately`` .A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ``ModifyCacheCluster`` request and set *NumCacheNodes* equal to the number of cache nodes currently in the cache cluster.

      

    
    :type CacheNodeIdsToRemove: list
    :param CacheNodeIdsToRemove: 

      A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when *NumCacheNodes* is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of *NumCacheNodes* in the request.

       

      For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ``ModifyCacheCluser`` call is 5, you must list 2 (7 - 5) cache node IDs to remove.

      

    
      - *(string) --* 

      
  
    :type AZMode: string
    :param AZMode: 

      Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

       

      Valid values: ``single-az`` | ``cross-az`` .

       

      This option is only supported for Memcached cache clusters.

       

      .. note::

        

        You cannot specify ``single-az`` if the Memcached cache cluster already has cache nodes in different Availability Zones. If ``cross-az`` is specified, existing Memcached nodes remain in their current Availability Zone.

         

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the **Availability Zone Considerations** section of `Cache Node Considerations for Memcached`_ .

         

      

    
    :type NewAvailabilityZones: list
    :param NewAvailabilityZones: 

      The list of Availability Zones where the new Memcached cache nodes will be created.

       

      This parameter is only valid when *NumCacheNodes* in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

       

      This option is only supported on Memcached clusters.

       

      Scenarios: 

       
      *  **Scenario 1:** You have 3 active nodes and wish to add 2 nodes.Specify ``NumCacheNodes=5`` (3 + 2) and optionally specify two Availability Zones for the two new nodes.
       
      *  **Scenario 2:** You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.Specify ``NumCacheNodes=6`` ((3 + 2) + 1)
      and optionally specify an Availability Zone for the new node. 
      *  **Scenario 3:** You want to cancel all pending actions.Specify ``NumCacheNodes=3`` to cancel all pending actions.
       

       

       

      The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting ``NumCacheNodes`` to the number of current nodes.

       

      If ``cross-az`` is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the **Availability Zone Considerations** section of `Cache Node Considerations for Memcached`_ .

       

      **Impact of new add/remove requests upon pending requests** 

         Scenarios Pending action New Request Results   Scenario-1 Delete Delete The new delete, pending or immediate, replaces the pending delete.   Scenario-2 Delete Create The new create, pending or immediate, replaces the pending delete.   Scenario-3 Create Delete The new delete, pending or immediate, replaces the pending create.   Scenario-4 Create Create The new create is added to the pending create. **Important:** If the new create request is **Apply Immediately - Yes** , all creates are performed immediately. If the new create request is **Apply Immediately - No** , all creates are pending.   

      Example: ``NewAvailabilityZones.member.1=us-west-2aNewAvailabilityZones.member.2=us-west-2bNewAvailabilityZones.member.3=us-west-2c`` 

      

    
      - *(string) --* 

      
  
    :type CacheSecurityGroupNames: list
    :param CacheSecurityGroupNames: 

      A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

       

      This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

       

      Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

      

    
      - *(string) --* 

      
  
    :type SecurityGroupIds: list
    :param SecurityGroupIds: 

      Specifies the VPC Security Groups associated with the cache cluster.

       

      This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

      

    
      - *(string) --* 

      
  
    :type PreferredMaintenanceWindow: string
    :param PreferredMaintenanceWindow: 

      Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

       

       
      * ``sun`` 
       
      * ``mon`` 
       
      * ``tue`` 
       
      * ``wed`` 
       
      * ``thu`` 
       
      * ``fri`` 
       
      * ``sat`` 
       

       

      Example: ``sun:05:00-sun:09:00`` 

      

    
    :type NotificationTopicArn: string
    :param NotificationTopicArn: 

      The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

       

      .. note::

        The Amazon SNS topic owner must be same as the cache cluster owner. 

      

    
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

      The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the *ApplyImmediately* parameter is specified as *true* for this request.

      

    
    :type NotificationTopicStatus: string
    :param NotificationTopicStatus: 

      The status of the Amazon SNS notification topic. Notifications are sent only if the status is *active* .

       

      Valid values: ``active`` | ``inactive`` 

      

    
    :type ApplyImmediately: boolean
    :param ApplyImmediately: 

      If ``true`` , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the *PreferredMaintenanceWindow* setting for the cache cluster.

       

      If ``false`` , then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

       

      .. warning::

        If you perform a ``ModifyCacheCluster`` before a pending modification is applied, the pending modification is replaced by the newer modification.

       

      Valid values: ``true`` | ``false`` 

       

      Default: ``false`` 

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The upgraded version of the cache engine to be run on the cache nodes.

      

    
    :type AutoMinorVersionUpgrade: boolean
    :param AutoMinorVersionUpgrade: 

      This parameter is currently disabled.

      

    
    :type SnapshotRetentionLimit: integer
    :param SnapshotRetentionLimit: 

      The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

       

      **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

      

    
    :type SnapshotWindow: string
    :param SnapshotWindow: 

      The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. 

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheCluster': {
                'CacheClusterId': 'string',
                'ConfigurationEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ClientDownloadLandingPage': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'CacheClusterStatus': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'PendingModifiedValues': {
                    'NumCacheNodes': 123,
                    'CacheNodeIdsToRemove': [
                        'string',
                    ],
                    'EngineVersion': 'string'
                },
                'NotificationConfiguration': {
                    'TopicArn': 'string',
                    'TopicStatus': 'string'
                },
                'CacheSecurityGroups': [
                    {
                        'CacheSecurityGroupName': 'string',
                        'Status': 'string'
                    },
                ],
                'CacheParameterGroup': {
                    'CacheParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string',
                    'CacheNodeIdsToReboot': [
                        'string',
                    ]
                },
                'CacheSubnetGroupName': 'string',
                'CacheNodes': [
                    {
                        'CacheNodeId': 'string',
                        'CacheNodeStatus': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'Endpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'ParameterGroupStatus': 'string',
                        'SourceCacheNodeId': 'string',
                        'CustomerAvailabilityZone': 'string'
                    },
                ],
                'AutoMinorVersionUpgrade': True|False,
                'SecurityGroups': [
                    {
                        'SecurityGroupId': 'string',
                        'Status': 'string'
                    },
                ],
                'ReplicationGroupId': 'string',
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific cache cluster.

        
        

        - **CacheCluster** *(dict) --* 

          Contains all of the attributes of a specific cache cluster.

          
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

            
          

          - **ConfigurationEndpoint** *(dict) --* 

            Represents the information required for client programs to connect to a cache node.

            
            

            - **Address** *(string) --* 

              The DNS hostname of the cache node.

              
            

            - **Port** *(integer) --* 

              The port number that the cache engine is listening on.

              
        
          

          - **ClientDownloadLandingPage** *(string) --* 

            The URL of the web page where you can download the latest ElastiCache client library.

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used in this cache cluster.

            
          

          - **CacheClusterStatus** *(string) --* 

            The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

            
            

            - **NumCacheNodes** *(integer) --* 

              The new number of cache nodes for the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **CacheNodeIdsToRemove** *(list) --* 

              A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
            

            - **EngineVersion** *(string) --* 

              The new cache engine version that the cache cluster will run.

              
        
          

          - **NotificationConfiguration** *(dict) --* 

            Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

            
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the topic.

              
            

            - **TopicStatus** *(string) --* 

              The current state of the topic.

              
        
          

          - **CacheSecurityGroups** *(list) --* 

            A list of cache security group elements, composed of name and status sub-elements.

            
            

            - *(dict) --* 

              Represents a cache cluster's status within a particular cache security group.

              
              

              - **CacheSecurityGroupName** *(string) --* 

                The name of the cache security group.

                
              

              - **Status** *(string) --* 

                The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **CacheParameterGroup** *(dict) --* 

            The status of the cache parameter group.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **ParameterApplyStatus** *(string) --* 

              The status of parameter updates.

              
            

            - **CacheNodeIdsToReboot** *(list) --* 

              A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
        
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the cache cluster.

            
          

          - **CacheNodes** *(list) --* 

            A list of cache nodes that are members of the cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                
              

              - **CacheNodeStatus** *(string) --* 

                The current state of this cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created.

                
              

              - **Endpoint** *(dict) --* 

                The hostname for connecting to this cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **ParameterGroupStatus** *(string) --* 

                The status of the parameter group applied to this cache node.

                
              

              - **SourceCacheNodeId** *(string) --* 

                The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                
              

              - **CustomerAvailabilityZone** *(string) --* 

                The Availability Zone where this node was created and now resides.

                
          
        
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SecurityGroups** *(list) --* 

            A list of VPC Security Groups associated with the cache cluster.

            
            

            - *(dict) --* 

              Represents a single cache security group and its status.

              
              

              - **SecurityGroupId** *(string) --* 

                The identifier of the cache security group.

                
              

              - **Status** *(string) --* 

                The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **ReplicationGroupId** *(string) --* 

            The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

             

            Example: ``05:00-09:00`` 

            
      
    

  .. py:method:: modify_cache_parameter_group(**kwargs)

    

    The *ModifyCacheParameterGroup* action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

    

    **Request Syntax** 
    ::

      response = client.modify_cache_parameter_group(
          CacheParameterGroupName='string',
          ParameterNameValues=[
              {
                  'ParameterName': 'string',
                  'ParameterValue': 'string'
              },
          ]
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      The name of the cache parameter group to modify.

      

    
    :type ParameterNameValues: list
    :param ParameterNameValues: **[REQUIRED]** 

      An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

      

    
      - *(dict) --* 

        Describes a name-value pair that is used to update the value of a parameter.

        

      
        - **ParameterName** *(string) --* 

          The name of the parameter.

          

        
        - **ParameterValue** *(string) --* 

          The value of the parameter.

          

        
      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheParameterGroupName': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *ModifyCacheParameterGroup*  
         
        *  *ResetCacheParameterGroup*  
         

        
        

        - **CacheParameterGroupName** *(string) --* 

          The name of the cache parameter group.

          
    

  .. py:method:: modify_cache_subnet_group(**kwargs)

    

    The *ModifyCacheSubnetGroup* action modifies an existing cache subnet group.

    

    **Request Syntax** 
    ::

      response = client.modify_cache_subnet_group(
          CacheSubnetGroupName='string',
          CacheSubnetGroupDescription='string',
          SubnetIds=[
              'string',
          ]
      )
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: **[REQUIRED]** 

      The name for the cache subnet group. This value is stored as a lowercase string.

       

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

       

      Example: ``mysubnetgroup`` 

      

    
    :type CacheSubnetGroupDescription: string
    :param CacheSubnetGroupDescription: 

      A description for the cache subnet group.

      

    
    :type SubnetIds: list
    :param SubnetIds: 

      The EC2 subnet IDs for the cache subnet group.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSubnetGroup': {
                'CacheSubnetGroupName': 'string',
                'CacheSubnetGroupDescription': 'string',
                'VpcId': 'string',
                'Subnets': [
                    {
                        'SubnetIdentifier': 'string',
                        'SubnetAvailabilityZone': {
                            'Name': 'string'
                        }
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *CreateCacheSubnetGroup*  
         
        *  *ModifyCacheSubnetGroup*  
         

        
        

        - **CacheSubnetGroup** *(dict) --* 

          Represents the output of one of the following actions:

           

           
          *  *CreateCacheSubnetGroup*  
           
          *  *ModifyCacheSubnetGroup*  
           

          
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group.

            
          

          - **CacheSubnetGroupDescription** *(string) --* 

            The description of the cache subnet group.

            
          

          - **VpcId** *(string) --* 

            The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

            
          

          - **Subnets** *(list) --* 

            A list of subnets associated with the cache subnet group.

            
            

            - *(dict) --* 

              Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

              
              

              - **SubnetIdentifier** *(string) --* 

                The unique identifier for the subnet.

                
              

              - **SubnetAvailabilityZone** *(dict) --* 

                The Availability Zone associated with the subnet.

                
                

                - **Name** *(string) --* 

                  The name of the Availability Zone.

                  
            
          
        
      
    

  .. py:method:: modify_replication_group(**kwargs)

    

    The *ModifyReplicationGroup* action modifies the settings for a replication group.

    

    **Request Syntax** 
    ::

      response = client.modify_replication_group(
          ReplicationGroupId='string',
          ReplicationGroupDescription='string',
          PrimaryClusterId='string',
          SnapshottingClusterId='string',
          AutomaticFailoverEnabled=True|False,
          CacheSecurityGroupNames=[
              'string',
          ],
          SecurityGroupIds=[
              'string',
          ],
          PreferredMaintenanceWindow='string',
          NotificationTopicArn='string',
          CacheParameterGroupName='string',
          NotificationTopicStatus='string',
          ApplyImmediately=True|False,
          EngineVersion='string',
          AutoMinorVersionUpgrade=True|False,
          SnapshotRetentionLimit=123,
          SnapshotWindow='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: **[REQUIRED]** 

      The identifier of the replication group to modify.

      

    
    :type ReplicationGroupDescription: string
    :param ReplicationGroupDescription: 

      A description for the replication group. Maximum length is 255 characters.

      

    
    :type PrimaryClusterId: string
    :param PrimaryClusterId: 

      If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.

      

    
    :type SnapshottingClusterId: string
    :param SnapshottingClusterId: 

      The cache cluster ID that will be used as the daily snapshot source for the replication group.

      

    
    :type AutomaticFailoverEnabled: boolean
    :param AutomaticFailoverEnabled: 

      Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.

       

      Valid values: ``true`` | ``false`` 

       

      .. note::

        

        ElastiCache Multi-AZ replication groups are not supported on:

         

         
        * Redis versions earlier than 2.8.6.
         
        * T1 and T2 cache node types.
         

         

      

    
    :type CacheSecurityGroupNames: list
    :param CacheSecurityGroupNames: 

      A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

       

      This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).

       

      Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

      

    
      - *(string) --* 

      
  
    :type SecurityGroupIds: list
    :param SecurityGroupIds: 

      Specifies the VPC Security Groups associated with the cache clusters in the replication group.

       

      This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).

      

    
      - *(string) --* 

      
  
    :type PreferredMaintenanceWindow: string
    :param PreferredMaintenanceWindow: 

      Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

       

       
      * ``sun`` 
       
      * ``mon`` 
       
      * ``tue`` 
       
      * ``wed`` 
       
      * ``thu`` 
       
      * ``fri`` 
       
      * ``sat`` 
       

       

      Example: ``sun:05:00-sun:09:00`` 

      

    
    :type NotificationTopicArn: string
    :param NotificationTopicArn: 

      The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

       

      .. note::

        The Amazon SNS topic owner must be same as the replication group owner. 

      

    
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

      The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the *ApplyImmediately* parameter is specified as *true* for this request.

      

    
    :type NotificationTopicStatus: string
    :param NotificationTopicStatus: 

      The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is *active* .

       

      Valid values: ``active`` | ``inactive`` 

      

    
    :type ApplyImmediately: boolean
    :param ApplyImmediately: 

      If ``true`` , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the *PreferredMaintenanceWindow* setting for the replication group.

       

      If ``false`` , then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

       

      Valid values: ``true`` | ``false`` 

       

      Default: ``false`` 

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The upgraded version of the cache engine to be run on the cache clusters in the replication group.

      

    
    :type AutoMinorVersionUpgrade: boolean
    :param AutoMinorVersionUpgrade: 

      This parameter is currently disabled.

      

    
    :type SnapshotRetentionLimit: integer
    :param SnapshotRetentionLimit: 

      The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

       

      **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

      

    
    :type SnapshotWindow: string
    :param SnapshotWindow: 

      The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by *SnapshottingClusterId* .

       

      Example: ``05:00-09:00`` 

       

      If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReplicationGroup': {
                'ReplicationGroupId': 'string',
                'Description': 'string',
                'Status': 'string',
                'PendingModifiedValues': {
                    'PrimaryClusterId': 'string',
                    'AutomaticFailoverStatus': 'enabled'|'disabled'
                },
                'MemberClusters': [
                    'string',
                ],
                'NodeGroups': [
                    {
                        'NodeGroupId': 'string',
                        'Status': 'string',
                        'PrimaryEndpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'NodeGroupMembers': [
                            {
                                'CacheClusterId': 'string',
                                'CacheNodeId': 'string',
                                'ReadEndpoint': {
                                    'Address': 'string',
                                    'Port': 123
                                },
                                'PreferredAvailabilityZone': 'string',
                                'CurrentRole': 'string'
                            },
                        ]
                    },
                ],
                'SnapshottingClusterId': 'string',
                'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific replication group.

        
        

        - **ReplicationGroup** *(dict) --* 

          Contains all of the attributes of a specific replication group.

          
          

          - **ReplicationGroupId** *(string) --* 

            The identifier for the replication group.

            
          

          - **Description** *(string) --* 

            The description of the replication group.

            
          

          - **Status** *(string) --* 

            The current state of this replication group - *creating* , *available* , etc.

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

            
            

            - **PrimaryClusterId** *(string) --* 

              The primary cluster ID which will be applied immediately (if ``--apply-immediately`` was specified), or during the next maintenance window.

              
            

            - **AutomaticFailoverStatus** *(string) --* 

              Indicates the status of Multi-AZ for this replication group.

               

              .. note::

                

                ElastiCache Multi-AZ replication groups are not supported on:

                 

                 
                * Redis versions earlier than 2.8.6.
                 
                * T1 and T2 cache node types.
                 

                 

              
        
          

          - **MemberClusters** *(list) --* 

            The names of all the cache clusters that are part of this replication group.

            
            

            - *(string) --* 
        
          

          - **NodeGroups** *(list) --* 

            A single element list with information about the nodes in the replication group.

            
            

            - *(dict) --* 

              Represents a collection of cache nodes in a replication group.

              
              

              - **NodeGroupId** *(string) --* 

                The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

                
              

              - **Status** *(string) --* 

                The current state of this replication group - *creating* , *available* , etc.

                
              

              - **PrimaryEndpoint** *(dict) --* 

                Represents the information required for client programs to connect to a cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **NodeGroupMembers** *(list) --* 

                A list containing information about individual nodes within the node group.

                
                

                - *(dict) --* 

                  Represents a single node within a node group.

                  
                  

                  - **CacheClusterId** *(string) --* 

                    The ID of the cache cluster to which the node belongs.

                    
                  

                  - **CacheNodeId** *(string) --* 

                    The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                    
                  

                  - **ReadEndpoint** *(dict) --* 

                    Represents the information required for client programs to connect to a cache node.

                    
                    

                    - **Address** *(string) --* 

                      The DNS hostname of the cache node.

                      
                    

                    - **Port** *(integer) --* 

                      The port number that the cache engine is listening on.

                      
                
                  

                  - **PreferredAvailabilityZone** *(string) --* 

                    The name of the Availability Zone in which the node is located.

                    
                  

                  - **CurrentRole** *(string) --* 

                    The role that is currently assigned to the node - *primary* or *replica* .

                    
              
            
          
        
          

          - **SnapshottingClusterId** *(string) --* 

            The cache cluster ID that is used as the daily snapshot source for the replication group.

            
          

          - **AutomaticFailover** *(string) --* 

            Indicates the status of Multi-AZ for this replication group.

             

            .. note::

              

              ElastiCache Multi-AZ replication groups are not supported on:

               

               
              * Redis versions earlier than 2.8.6.
               
              * T1 and T2 cache node types.
               

               

            
      
    

  .. py:method:: purchase_reserved_cache_nodes_offering(**kwargs)

    

    The *PurchaseReservedCacheNodesOffering* action allows you to purchase a reserved cache node offering.

    

    **Request Syntax** 
    ::

      response = client.purchase_reserved_cache_nodes_offering(
          ReservedCacheNodesOfferingId='string',
          ReservedCacheNodeId='string',
          CacheNodeCount=123
      )
    :type ReservedCacheNodesOfferingId: string
    :param ReservedCacheNodesOfferingId: **[REQUIRED]** 

      The ID of the reserved cache node offering to purchase.

       

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

      

    
    :type ReservedCacheNodeId: string
    :param ReservedCacheNodeId: 

      A customer-specified identifier to track this reservation.

       

      Example: myreservationID

      

    
    :type CacheNodeCount: integer
    :param CacheNodeCount: 

      The number of cache node instances to reserve.

       

      Default: ``1`` 

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReservedCacheNode': {
                'ReservedCacheNodeId': 'string',
                'ReservedCacheNodesOfferingId': 'string',
                'CacheNodeType': 'string',
                'StartTime': datetime(2015, 1, 1),
                'Duration': 123,
                'FixedPrice': 123.0,
                'UsagePrice': 123.0,
                'CacheNodeCount': 123,
                'ProductDescription': 'string',
                'OfferingType': 'string',
                'State': 'string',
                'RecurringCharges': [
                    {
                        'RecurringChargeAmount': 123.0,
                        'RecurringChargeFrequency': 'string'
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *PurchaseReservedCacheNodesOffering* action.

        
        

        - **ReservedCacheNode** *(dict) --* 

          Represents the output of a *PurchaseReservedCacheNodesOffering* action.

          
          

          - **ReservedCacheNodeId** *(string) --* 

            The unique identifier for the reservation.

            
          

          - **ReservedCacheNodesOfferingId** *(string) --* 

            The offering identifier.

            
          

          - **CacheNodeType** *(string) --* 

            The cache node type for the reserved cache nodes.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **StartTime** *(datetime) --* 

            The time the reservation started.

            
          

          - **Duration** *(integer) --* 

            The duration of the reservation in seconds.

            
          

          - **FixedPrice** *(float) --* 

            The fixed price charged for this reserved cache node.

            
          

          - **UsagePrice** *(float) --* 

            The hourly price charged for this reserved cache node.

            
          

          - **CacheNodeCount** *(integer) --* 

            The number of cache nodes that have been reserved.

            
          

          - **ProductDescription** *(string) --* 

            The description of the reserved cache node.

            
          

          - **OfferingType** *(string) --* 

            The offering type of this reserved cache node.

            
          

          - **State** *(string) --* 

            The state of the reserved cache node.

            
          

          - **RecurringCharges** *(list) --* 

            The recurring price charged to run this reserved cache node.

            
            

            - *(dict) --* 

              Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

              
              

              - **RecurringChargeAmount** *(float) --* 

                The monetary amount of the recurring charge.

                
              

              - **RecurringChargeFrequency** *(string) --* 

                The frequency of the recurring charge.

                
          
        
      
    

  .. py:method:: reboot_cache_cluster(**kwargs)

    

    The *RebootCacheCluster* action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

     

    The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

     

    When the reboot is complete, a cache cluster event is created.

    

    **Request Syntax** 
    ::

      response = client.reboot_cache_cluster(
          CacheClusterId='string',
          CacheNodeIdsToReboot=[
              'string',
          ]
      )
    :type CacheClusterId: string
    :param CacheClusterId: **[REQUIRED]** 

      The cache cluster identifier. This parameter is stored as a lowercase string.

      

    
    :type CacheNodeIdsToReboot: list
    :param CacheNodeIdsToReboot: **[REQUIRED]** 

      A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheCluster': {
                'CacheClusterId': 'string',
                'ConfigurationEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ClientDownloadLandingPage': 'string',
                'CacheNodeType': 'string',
                'Engine': 'string',
                'EngineVersion': 'string',
                'CacheClusterStatus': 'string',
                'NumCacheNodes': 123,
                'PreferredAvailabilityZone': 'string',
                'CacheClusterCreateTime': datetime(2015, 1, 1),
                'PreferredMaintenanceWindow': 'string',
                'PendingModifiedValues': {
                    'NumCacheNodes': 123,
                    'CacheNodeIdsToRemove': [
                        'string',
                    ],
                    'EngineVersion': 'string'
                },
                'NotificationConfiguration': {
                    'TopicArn': 'string',
                    'TopicStatus': 'string'
                },
                'CacheSecurityGroups': [
                    {
                        'CacheSecurityGroupName': 'string',
                        'Status': 'string'
                    },
                ],
                'CacheParameterGroup': {
                    'CacheParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string',
                    'CacheNodeIdsToReboot': [
                        'string',
                    ]
                },
                'CacheSubnetGroupName': 'string',
                'CacheNodes': [
                    {
                        'CacheNodeId': 'string',
                        'CacheNodeStatus': 'string',
                        'CacheNodeCreateTime': datetime(2015, 1, 1),
                        'Endpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'ParameterGroupStatus': 'string',
                        'SourceCacheNodeId': 'string',
                        'CustomerAvailabilityZone': 'string'
                    },
                ],
                'AutoMinorVersionUpgrade': True|False,
                'SecurityGroups': [
                    {
                        'SecurityGroupId': 'string',
                        'Status': 'string'
                    },
                ],
                'ReplicationGroupId': 'string',
                'SnapshotRetentionLimit': 123,
                'SnapshotWindow': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Contains all of the attributes of a specific cache cluster.

        
        

        - **CacheCluster** *(dict) --* 

          Contains all of the attributes of a specific cache cluster.

          
          

          - **CacheClusterId** *(string) --* 

            The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

            
          

          - **ConfigurationEndpoint** *(dict) --* 

            Represents the information required for client programs to connect to a cache node.

            
            

            - **Address** *(string) --* 

              The DNS hostname of the cache node.

              
            

            - **Port** *(integer) --* 

              The port number that the cache engine is listening on.

              
        
          

          - **ClientDownloadLandingPage** *(string) --* 

            The URL of the web page where you can download the latest ElastiCache client library.

            
          

          - **CacheNodeType** *(string) --* 

            The name of the compute and memory capacity node type for the cache cluster.

             

            Valid node types are as follows:

             

             
            * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
             
            * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
             

            
             
            * Compute optimized: ``cache.c1.xlarge`` 
             
            * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
             
            * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
             

            
             

             

            **Notes:** 

             

             
            * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
             
            * Redis backup/restore is not supported for t2 instances.
             
            * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
             

             

            For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

            
          

          - **Engine** *(string) --* 

            The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

            
          

          - **EngineVersion** *(string) --* 

            The version of the cache engine version that is used in this cache cluster.

            
          

          - **CacheClusterStatus** *(string) --* 

            The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

            
          

          - **NumCacheNodes** *(integer) --* 

            The number of cache nodes in the cache cluster.

             

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

            
          

          - **PreferredAvailabilityZone** *(string) --* 

            The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

            
          

          - **CacheClusterCreateTime** *(datetime) --* 

            The date and time when the cache cluster was created.

            
          

          - **PreferredMaintenanceWindow** *(string) --* 

            Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

             

             
            * ``sun`` 
             
            * ``mon`` 
             
            * ``tue`` 
             
            * ``wed`` 
             
            * ``thu`` 
             
            * ``fri`` 
             
            * ``sat`` 
             

             

            Example: ``sun:05:00-sun:09:00`` 

            
          

          - **PendingModifiedValues** *(dict) --* 

            A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

            
            

            - **NumCacheNodes** *(integer) --* 

              The new number of cache nodes for the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **CacheNodeIdsToRemove** *(list) --* 

              A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
            

            - **EngineVersion** *(string) --* 

              The new cache engine version that the cache cluster will run.

              
        
          

          - **NotificationConfiguration** *(dict) --* 

            Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

            
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the topic.

              
            

            - **TopicStatus** *(string) --* 

              The current state of the topic.

              
        
          

          - **CacheSecurityGroups** *(list) --* 

            A list of cache security group elements, composed of name and status sub-elements.

            
            

            - *(dict) --* 

              Represents a cache cluster's status within a particular cache security group.

              
              

              - **CacheSecurityGroupName** *(string) --* 

                The name of the cache security group.

                
              

              - **Status** *(string) --* 

                The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **CacheParameterGroup** *(dict) --* 

            The status of the cache parameter group.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **ParameterApplyStatus** *(string) --* 

              The status of parameter updates.

              
            

            - **CacheNodeIdsToReboot** *(list) --* 

              A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

              
              

              - *(string) --* 
          
        
          

          - **CacheSubnetGroupName** *(string) --* 

            The name of the cache subnet group associated with the cache cluster.

            
          

          - **CacheNodes** *(list) --* 

            A list of cache nodes that are members of the cache cluster.

            
            

            - *(dict) --* 

              Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
              

              - **CacheNodeId** *(string) --* 

                The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                
              

              - **CacheNodeStatus** *(string) --* 

                The current state of this cache node.

                
              

              - **CacheNodeCreateTime** *(datetime) --* 

                The date and time when the cache node was created.

                
              

              - **Endpoint** *(dict) --* 

                The hostname for connecting to this cache node.

                
                

                - **Address** *(string) --* 

                  The DNS hostname of the cache node.

                  
                

                - **Port** *(integer) --* 

                  The port number that the cache engine is listening on.

                  
            
              

              - **ParameterGroupStatus** *(string) --* 

                The status of the parameter group applied to this cache node.

                
              

              - **SourceCacheNodeId** *(string) --* 

                The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                
              

              - **CustomerAvailabilityZone** *(string) --* 

                The Availability Zone where this node was created and now resides.

                
          
        
          

          - **AutoMinorVersionUpgrade** *(boolean) --* 

            This parameter is currently disabled.

            
          

          - **SecurityGroups** *(list) --* 

            A list of VPC Security Groups associated with the cache cluster.

            
            

            - *(dict) --* 

              Represents a single cache security group and its status.

              
              

              - **SecurityGroupId** *(string) --* 

                The identifier of the cache security group.

                
              

              - **Status** *(string) --* 

                The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                
          
        
          

          - **ReplicationGroupId** *(string) --* 

            The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

            
          

          - **SnapshotRetentionLimit** *(integer) --* 

            The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

             

            **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

            
          

          - **SnapshotWindow** *(string) --* 

            The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

             

            Example: ``05:00-09:00`` 

            
      
    

  .. py:method:: remove_tags_from_resource(**kwargs)

    

    The *RemoveTagsFromResource* action removes the tags identified by the ``TagKeys`` list from the named resource.

    

    **Request Syntax** 
    ::

      response = client.remove_tags_from_resource(
          ResourceName='string',
          TagKeys=[
              'string',
          ]
      )
    :type ResourceName: string
    :param ResourceName: **[REQUIRED]** 

      The name of the ElastiCache resource from which you want the listed tags removed, for example ``arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster`` .

      

    
    :type TagKeys: list
    :param TagKeys: **[REQUIRED]** 

      A list of ``TagKeys`` identifying the tags you want removed from the named resource. For example, ``TagKeys.member.1=Region`` removes the cost allocation tag with the key name ``Region`` from the resource named by the *ResourceName* parameter.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output from the *AddTagsToResource* , *ListTagsOnResource* , and *RemoveTagsFromResource* actions.

        
        

        - **TagList** *(list) --* 

          A list of cost allocation tags as key-value pairs. 

          
          

          - *(dict) --* 

            A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

            
            

            - **Key** *(string) --* 

              The key for the tag.

              
            

            - **Value** *(string) --* 

              The tag's value. May not be null.

              
        
      
    

  .. py:method:: reset_cache_parameter_group(**kwargs)

    

    The *ResetCacheParameterGroup* action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the *ResetAllParameters* and *CacheParameterGroupName* parameters.

    

    **Request Syntax** 
    ::

      response = client.reset_cache_parameter_group(
          CacheParameterGroupName='string',
          ResetAllParameters=True|False,
          ParameterNameValues=[
              {
                  'ParameterName': 'string',
                  'ParameterValue': 'string'
              },
          ]
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      The name of the cache parameter group to reset.

      

    
    :type ResetAllParameters: boolean
    :param ResetAllParameters: 

      If *true* , all parameters in the cache parameter group will be reset to default values. If *false* , no such action occurs.

       

      Valid values: ``true`` | ``false`` 

      

    
    :type ParameterNameValues: list
    :param ParameterNameValues: **[REQUIRED]** 

      An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.

      

    
      - *(dict) --* 

        Describes a name-value pair that is used to update the value of a parameter.

        

      
        - **ParameterName** *(string) --* 

          The name of the parameter.

          

        
        - **ParameterValue** *(string) --* 

          The value of the parameter.

          

        
      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheParameterGroupName': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *ModifyCacheParameterGroup*  
         
        *  *ResetCacheParameterGroup*  
         

        
        

        - **CacheParameterGroupName** *(string) --* 

          The name of the cache parameter group.

          
    

  .. py:method:: revoke_cache_security_group_ingress(**kwargs)

    

    The *RevokeCacheSecurityGroupIngress* action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized.

    

    **Request Syntax** 
    ::

      response = client.revoke_cache_security_group_ingress(
          CacheSecurityGroupName='string',
          EC2SecurityGroupName='string',
          EC2SecurityGroupOwnerId='string'
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: **[REQUIRED]** 

      The name of the cache security group to revoke ingress from.

      

    
    :type EC2SecurityGroupName: string
    :param EC2SecurityGroupName: **[REQUIRED]** 

      The name of the Amazon EC2 security group to revoke access from.

      

    
    :type EC2SecurityGroupOwnerId: string
    :param EC2SecurityGroupOwnerId: **[REQUIRED]** 

      The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSecurityGroup': {
                'OwnerId': 'string',
                'CacheSecurityGroupName': 'string',
                'Description': 'string',
                'EC2SecurityGroups': [
                    {
                        'Status': 'string',
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string'
                    },
                ]
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of one of the following actions:

         

         
        *  *AuthorizeCacheSecurityGroupIngress*  
         
        *  *CreateCacheSecurityGroup*  
         
        *  *RevokeCacheSecurityGroupIngress*  
         

        
        

        - **CacheSecurityGroup** *(dict) --* 

          Represents the output of one of the following actions:

           

           
          *  *AuthorizeCacheSecurityGroupIngress*  
           
          *  *CreateCacheSecurityGroup*  
           
          *  *RevokeCacheSecurityGroupIngress*  
           

          
          

          - **OwnerId** *(string) --* 

            The AWS account ID of the cache security group owner.

            
          

          - **CacheSecurityGroupName** *(string) --* 

            The name of the cache security group.

            
          

          - **Description** *(string) --* 

            The description of the cache security group.

            
          

          - **EC2SecurityGroups** *(list) --* 

            A list of Amazon EC2 security groups that are associated with this cache security group.

            
            

            - *(dict) --* 

              Provides ownership and status information for an Amazon EC2 security group.

              
              

              - **Status** *(string) --* 

                The status of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupName** *(string) --* 

                The name of the Amazon EC2 security group.

                
              

              - **EC2SecurityGroupOwnerId** *(string) --* 

                The AWS account ID of the Amazon EC2 security group owner.

                
          
        
      
    

==========
Paginators
==========


The available paginators are:

* :py:class:`ElastiCache.Paginator.describe_cache_clusters`


* :py:class:`ElastiCache.Paginator.describe_cache_engine_versions`


* :py:class:`ElastiCache.Paginator.describe_cache_parameter_groups`


* :py:class:`ElastiCache.Paginator.describe_cache_parameters`


* :py:class:`ElastiCache.Paginator.describe_cache_security_groups`


* :py:class:`ElastiCache.Paginator.describe_cache_subnet_groups`


* :py:class:`ElastiCache.Paginator.describe_engine_default_parameters`


* :py:class:`ElastiCache.Paginator.describe_events`


* :py:class:`ElastiCache.Paginator.describe_replication_groups`


* :py:class:`ElastiCache.Paginator.describe_reserved_cache_nodes`


* :py:class:`ElastiCache.Paginator.describe_reserved_cache_nodes_offerings`


* :py:class:`ElastiCache.Paginator.describe_snapshots`



.. py:class:: ElastiCache.Paginator.describe_cache_clusters

  ::

    
    paginator = client.get_paginator('describe_cache_clusters')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_clusters`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheClusterId='string',
          ShowCacheNodeInfo=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

      

    
    :type ShowCacheNodeInfo: boolean
    :param ShowCacheNodeInfo: 

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheClusters': [
                {
                    'CacheClusterId': 'string',
                    'ConfigurationEndpoint': {
                        'Address': 'string',
                        'Port': 123
                    },
                    'ClientDownloadLandingPage': 'string',
                    'CacheNodeType': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'CacheClusterStatus': 'string',
                    'NumCacheNodes': 123,
                    'PreferredAvailabilityZone': 'string',
                    'CacheClusterCreateTime': datetime(2015, 1, 1),
                    'PreferredMaintenanceWindow': 'string',
                    'PendingModifiedValues': {
                        'NumCacheNodes': 123,
                        'CacheNodeIdsToRemove': [
                            'string',
                        ],
                        'EngineVersion': 'string'
                    },
                    'NotificationConfiguration': {
                        'TopicArn': 'string',
                        'TopicStatus': 'string'
                    },
                    'CacheSecurityGroups': [
                        {
                            'CacheSecurityGroupName': 'string',
                            'Status': 'string'
                        },
                    ],
                    'CacheParameterGroup': {
                        'CacheParameterGroupName': 'string',
                        'ParameterApplyStatus': 'string',
                        'CacheNodeIdsToReboot': [
                            'string',
                        ]
                    },
                    'CacheSubnetGroupName': 'string',
                    'CacheNodes': [
                        {
                            'CacheNodeId': 'string',
                            'CacheNodeStatus': 'string',
                            'CacheNodeCreateTime': datetime(2015, 1, 1),
                            'Endpoint': {
                                'Address': 'string',
                                'Port': 123
                            },
                            'ParameterGroupStatus': 'string',
                            'SourceCacheNodeId': 'string',
                            'CustomerAvailabilityZone': 'string'
                        },
                    ],
                    'AutoMinorVersionUpgrade': True|False,
                    'SecurityGroups': [
                        {
                            'SecurityGroupId': 'string',
                            'Status': 'string'
                        },
                    ],
                    'ReplicationGroupId': 'string',
                    'SnapshotRetentionLimit': 123,
                    'SnapshotWindow': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheClusters* action.

        
        

        - **CacheClusters** *(list) --* 

          A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

          
          

          - *(dict) --* 

            Contains all of the attributes of a specific cache cluster.

            
            

            - **CacheClusterId** *(string) --* 

              The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

              
            

            - **ConfigurationEndpoint** *(dict) --* 

              Represents the information required for client programs to connect to a cache node.

              
              

              - **Address** *(string) --* 

                The DNS hostname of the cache node.

                
              

              - **Port** *(integer) --* 

                The port number that the cache engine is listening on.

                
          
            

            - **ClientDownloadLandingPage** *(string) --* 

              The URL of the web page where you can download the latest ElastiCache client library.

              
            

            - **CacheNodeType** *(string) --* 

              The name of the compute and memory capacity node type for the cache cluster.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Engine** *(string) --* 

              The name of the cache engine (*memcached* or *redis* ) to be used for this cache cluster.

              
            

            - **EngineVersion** *(string) --* 

              The version of the cache engine version that is used in this cache cluster.

              
            

            - **CacheClusterStatus** *(string) --* 

              The current state of this cache cluster, one of the following values: *available* , *creating* , *deleted* , *deleting* , *incompatible-network* , *modifying* , *rebooting cache cluster nodes* , *restore-failed* , or *snapshotting* .

              
            

            - **NumCacheNodes** *(integer) --* 

              The number of cache nodes in the cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **PreferredAvailabilityZone** *(string) --* 

              The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

              
            

            - **CacheClusterCreateTime** *(datetime) --* 

              The date and time when the cache cluster was created.

              
            

            - **PreferredMaintenanceWindow** *(string) --* 

              Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

               

               
              * ``sun`` 
               
              * ``mon`` 
               
              * ``tue`` 
               
              * ``wed`` 
               
              * ``thu`` 
               
              * ``fri`` 
               
              * ``sat`` 
               

               

              Example: ``sun:05:00-sun:09:00`` 

              
            

            - **PendingModifiedValues** *(dict) --* 

              A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

              
              

              - **NumCacheNodes** *(integer) --* 

                The new number of cache nodes for the cache cluster.

                 

                For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

                
              

              - **CacheNodeIdsToRemove** *(list) --* 

                A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                
                

                - *(string) --* 
            
              

              - **EngineVersion** *(string) --* 

                The new cache engine version that the cache cluster will run.

                
          
            

            - **NotificationConfiguration** *(dict) --* 

              Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

              
              

              - **TopicArn** *(string) --* 

                The Amazon Resource Name (ARN) that identifies the topic.

                
              

              - **TopicStatus** *(string) --* 

                The current state of the topic.

                
          
            

            - **CacheSecurityGroups** *(list) --* 

              A list of cache security group elements, composed of name and status sub-elements.

              
              

              - *(dict) --* 

                Represents a cache cluster's status within a particular cache security group.

                
                

                - **CacheSecurityGroupName** *(string) --* 

                  The name of the cache security group.

                  
                

                - **Status** *(string) --* 

                  The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                  
            
          
            

            - **CacheParameterGroup** *(dict) --* 

              The status of the cache parameter group.

              
              

              - **CacheParameterGroupName** *(string) --* 

                The name of the cache parameter group.

                
              

              - **ParameterApplyStatus** *(string) --* 

                The status of parameter updates.

                
              

              - **CacheNodeIdsToReboot** *(list) --* 

                A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

                
                

                - *(string) --* 
            
          
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group associated with the cache cluster.

              
            

            - **CacheNodes** *(list) --* 

              A list of cache nodes that are members of the cache cluster.

              
              

              - *(dict) --* 

                Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

                 

                Valid node types are as follows:

                 

                 
                * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
                 
                * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
                 

                
                 
                * Compute optimized: ``cache.c1.xlarge`` 
                 
                * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
                 
                * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
                 

                
                 

                 

                **Notes:** 

                 

                 
                * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
                 
                * Redis backup/restore is not supported for t2 instances.
                 
                * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
                 

                 

                For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

                
                

                - **CacheNodeId** *(string) --* 

                  The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

                  
                

                - **CacheNodeStatus** *(string) --* 

                  The current state of this cache node.

                  
                

                - **CacheNodeCreateTime** *(datetime) --* 

                  The date and time when the cache node was created.

                  
                

                - **Endpoint** *(dict) --* 

                  The hostname for connecting to this cache node.

                  
                  

                  - **Address** *(string) --* 

                    The DNS hostname of the cache node.

                    
                  

                  - **Port** *(integer) --* 

                    The port number that the cache engine is listening on.

                    
              
                

                - **ParameterGroupStatus** *(string) --* 

                  The status of the parameter group applied to this cache node.

                  
                

                - **SourceCacheNodeId** *(string) --* 

                  The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

                  
                

                - **CustomerAvailabilityZone** *(string) --* 

                  The Availability Zone where this node was created and now resides.

                  
            
          
            

            - **AutoMinorVersionUpgrade** *(boolean) --* 

              This parameter is currently disabled.

              
            

            - **SecurityGroups** *(list) --* 

              A list of VPC Security Groups associated with the cache cluster.

              
              

              - *(dict) --* 

                Represents a single cache security group and its status.

                
                

                - **SecurityGroupId** *(string) --* 

                  The identifier of the cache security group.

                  
                

                - **Status** *(string) --* 

                  The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

                  
            
          
            

            - **ReplicationGroupId** *(string) --* 

              The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

              
            

            - **SnapshotRetentionLimit** *(integer) --* 

              The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set *SnapshotRetentionLimit* to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

               

              **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

              
            

            - **SnapshotWindow** *(string) --* 

              The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

               

              Example: ``05:00-09:00`` 

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_cache_engine_versions

  ::

    
    paginator = client.get_paginator('describe_cache_engine_versions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_engine_versions`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          Engine='string',
          EngineVersion='string',
          CacheParameterGroupFamily='string',
          DefaultOnly=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type Engine: string
    :param Engine: 

      The cache engine to return. Valid values: ``memcached`` | ``redis`` 

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The cache engine version to return.

       

      Example: ``1.4.14`` 

      

    
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: 

      The name of a specific cache parameter group family to return details for.

       

      Constraints:

       

       
      * Must be 1 to 255 alphanumeric characters
       
      * First character must be a letter
       
      * Cannot end with a hyphen or contain two consecutive hyphens
       

      

    
    :type DefaultOnly: boolean
    :param DefaultOnly: 

      If *true* , specifies that only the default version of the specified engine or engine and major version combination is to be returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheEngineVersions': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'CacheEngineDescription': 'string',
                    'CacheEngineVersionDescription': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a  DescribeCacheEngineVersions action.

        
        

        - **CacheEngineVersions** *(list) --* 

          A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

          
          

          - *(dict) --* 

            Provides all of the details about a particular cache engine version.

            
            

            - **Engine** *(string) --* 

              The name of the cache engine.

              
            

            - **EngineVersion** *(string) --* 

              The version number of the cache engine.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family associated with this cache engine.

              
            

            - **CacheEngineDescription** *(string) --* 

              The description of the cache engine.

              
            

            - **CacheEngineVersionDescription** *(string) --* 

              The description of the cache engine version.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_cache_parameter_groups

  ::

    
    paginator = client.get_paginator('describe_cache_parameter_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_parameter_groups`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheParameterGroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

      The name of a specific cache parameter group to return details for.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheParameterGroups': [
                {
                    'CacheParameterGroupName': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'Description': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheParameterGroups* action.

        
        

        - **CacheParameterGroups** *(list) --* 

          A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

          
          

          - *(dict) --* 

            Represents the output of a *CreateCacheParameterGroup* action.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family that this cache parameter group is compatible with.

              
            

            - **Description** *(string) --* 

              The description for this cache parameter group.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_cache_parameters

  ::

    
    paginator = client.get_paginator('describe_cache_parameters')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_parameters`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheParameterGroupName='string',
          Source='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: **[REQUIRED]** 

      The name of a specific cache parameter group to return details for.

      

    
    :type Source: string
    :param Source: 

      The parameter types to return.

       

      Valid values: ``user`` | ``system`` | ``engine-default`` 

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Parameters': [
                {
                    'ParameterName': 'string',
                    'ParameterValue': 'string',
                    'Description': 'string',
                    'Source': 'string',
                    'DataType': 'string',
                    'AllowedValues': 'string',
                    'IsModifiable': True|False,
                    'MinimumEngineVersion': 'string'
                },
            ],
            'CacheNodeTypeSpecificParameters': [
                {
                    'ParameterName': 'string',
                    'Description': 'string',
                    'Source': 'string',
                    'DataType': 'string',
                    'AllowedValues': 'string',
                    'IsModifiable': True|False,
                    'MinimumEngineVersion': 'string',
                    'CacheNodeTypeSpecificValues': [
                        {
                            'CacheNodeType': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheParameters* action.

        
        

        - **Parameters** *(list) --* 

          A list of  Parameter instances.

          
          

          - *(dict) --* 

            Describes an individual setting that controls some aspect of ElastiCache behavior.

            
            

            - **ParameterName** *(string) --* 

              The name of the parameter.

              
            

            - **ParameterValue** *(string) --* 

              The value of the parameter.

              
            

            - **Description** *(string) --* 

              A description of the parameter.

              
            

            - **Source** *(string) --* 

              The source of the parameter.

              
            

            - **DataType** *(string) --* 

              The valid data type for the parameter.

              
            

            - **AllowedValues** *(string) --* 

              The valid range of values for the parameter.

              
            

            - **IsModifiable** *(boolean) --* 

              Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The earliest cache engine version to which the parameter can apply.

              
        
      
        

        - **CacheNodeTypeSpecificParameters** *(list) --* 

          A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

          
          

          - *(dict) --* 

            A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a *cache.m1.large* cache node type would have a larger *maxmemory* value than a *cache.m1.small* type.

            
            

            - **ParameterName** *(string) --* 

              The name of the parameter.

              
            

            - **Description** *(string) --* 

              A description of the parameter.

              
            

            - **Source** *(string) --* 

              The source of the parameter value.

              
            

            - **DataType** *(string) --* 

              The valid data type for the parameter.

              
            

            - **AllowedValues** *(string) --* 

              The valid range of values for the parameter.

              
            

            - **IsModifiable** *(boolean) --* 

              Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The earliest cache engine version to which the parameter can apply.

              
            

            - **CacheNodeTypeSpecificValues** *(list) --* 

              A list of cache node types and their corresponding values for this parameter.

              
              

              - *(dict) --* 

                A value that applies only to a certain cache node type.

                
                

                - **CacheNodeType** *(string) --* 

                  The cache node type for which this value applies.

                  
                

                - **Value** *(string) --* 

                  The value for the cache node type.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_cache_security_groups

  ::

    
    paginator = client.get_paginator('describe_cache_security_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_security_groups`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheSecurityGroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheSecurityGroupName: string
    :param CacheSecurityGroupName: 

      The name of the cache security group to return details for.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSecurityGroups': [
                {
                    'OwnerId': 'string',
                    'CacheSecurityGroupName': 'string',
                    'Description': 'string',
                    'EC2SecurityGroups': [
                        {
                            'Status': 'string',
                            'EC2SecurityGroupName': 'string',
                            'EC2SecurityGroupOwnerId': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheSecurityGroups* action.

        
        

        - **CacheSecurityGroups** *(list) --* 

          A list of cache security groups. Each element in the list contains detailed information about one group.

          
          

          - *(dict) --* 

            Represents the output of one of the following actions:

             

             
            *  *AuthorizeCacheSecurityGroupIngress*  
             
            *  *CreateCacheSecurityGroup*  
             
            *  *RevokeCacheSecurityGroupIngress*  
             

            
            

            - **OwnerId** *(string) --* 

              The AWS account ID of the cache security group owner.

              
            

            - **CacheSecurityGroupName** *(string) --* 

              The name of the cache security group.

              
            

            - **Description** *(string) --* 

              The description of the cache security group.

              
            

            - **EC2SecurityGroups** *(list) --* 

              A list of Amazon EC2 security groups that are associated with this cache security group.

              
              

              - *(dict) --* 

                Provides ownership and status information for an Amazon EC2 security group.

                
                

                - **Status** *(string) --* 

                  The status of the Amazon EC2 security group.

                  
                

                - **EC2SecurityGroupName** *(string) --* 

                  The name of the Amazon EC2 security group.

                  
                

                - **EC2SecurityGroupOwnerId** *(string) --* 

                  The AWS account ID of the Amazon EC2 security group owner.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_cache_subnet_groups

  ::

    
    paginator = client.get_paginator('describe_cache_subnet_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_subnet_groups`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheSubnetGroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheSubnetGroupName: string
    :param CacheSubnetGroupName: 

      The name of the cache subnet group to return details for.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'CacheSubnetGroups': [
                {
                    'CacheSubnetGroupName': 'string',
                    'CacheSubnetGroupDescription': 'string',
                    'VpcId': 'string',
                    'Subnets': [
                        {
                            'SubnetIdentifier': 'string',
                            'SubnetAvailabilityZone': {
                                'Name': 'string'
                            }
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeCacheSubnetGroups* action.

        
        

        - **CacheSubnetGroups** *(list) --* 

          A list of cache subnet groups. Each element in the list contains detailed information about one group.

          
          

          - *(dict) --* 

            Represents the output of one of the following actions:

             

             
            *  *CreateCacheSubnetGroup*  
             
            *  *ModifyCacheSubnetGroup*  
             

            
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group.

              
            

            - **CacheSubnetGroupDescription** *(string) --* 

              The description of the cache subnet group.

              
            

            - **VpcId** *(string) --* 

              The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

              
            

            - **Subnets** *(list) --* 

              A list of subnets associated with the cache subnet group.

              
              

              - *(dict) --* 

                Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

                
                

                - **SubnetIdentifier** *(string) --* 

                  The unique identifier for the subnet.

                  
                

                - **SubnetAvailabilityZone** *(dict) --* 

                  The Availability Zone associated with the subnet.

                  
                  

                  - **Name** *(string) --* 

                    The name of the Availability Zone.

                    
              
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_engine_default_parameters

  ::

    
    paginator = client.get_paginator('describe_engine_default_parameters')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_engine_default_parameters`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheParameterGroupFamily='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: **[REQUIRED]** 

      The name of the cache parameter group family. Valid values are: ``memcached1.4`` | ``redis2.6`` | ``redis2.8`` 

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'EngineDefaults': {
                'CacheParameterGroupFamily': 'string',
                'Marker': 'string',
                'Parameters': [
                    {
                        'ParameterName': 'string',
                        'ParameterValue': 'string',
                        'Description': 'string',
                        'Source': 'string',
                        'DataType': 'string',
                        'AllowedValues': 'string',
                        'IsModifiable': True|False,
                        'MinimumEngineVersion': 'string'
                    },
                ],
                'CacheNodeTypeSpecificParameters': [
                    {
                        'ParameterName': 'string',
                        'Description': 'string',
                        'Source': 'string',
                        'DataType': 'string',
                        'AllowedValues': 'string',
                        'IsModifiable': True|False,
                        'MinimumEngineVersion': 'string',
                        'CacheNodeTypeSpecificValues': [
                            {
                                'CacheNodeType': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ]
            },
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeEngineDefaultParameters* action.

        
        

        - **EngineDefaults** *(dict) --* 

          Represents the output of a *DescribeEngineDefaultParameters* action.

          
          

          - **CacheParameterGroupFamily** *(string) --* 

            Specifies the name of the cache parameter group family to which the engine default parameters apply.

            
          

          - **Marker** *(string) --* 

            Provides an identifier to allow retrieval of paginated results.

            
          

          - **Parameters** *(list) --* 

            Contains a list of engine default parameters.

            
            

            - *(dict) --* 

              Describes an individual setting that controls some aspect of ElastiCache behavior.

              
              

              - **ParameterName** *(string) --* 

                The name of the parameter.

                
              

              - **ParameterValue** *(string) --* 

                The value of the parameter.

                
              

              - **Description** *(string) --* 

                A description of the parameter.

                
              

              - **Source** *(string) --* 

                The source of the parameter.

                
              

              - **DataType** *(string) --* 

                The valid data type for the parameter.

                
              

              - **AllowedValues** *(string) --* 

                The valid range of values for the parameter.

                
              

              - **IsModifiable** *(boolean) --* 

                Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

                
              

              - **MinimumEngineVersion** *(string) --* 

                The earliest cache engine version to which the parameter can apply.

                
          
        
          

          - **CacheNodeTypeSpecificParameters** *(list) --* 

            A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

            
            

            - *(dict) --* 

              A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a *cache.m1.large* cache node type would have a larger *maxmemory* value than a *cache.m1.small* type.

              
              

              - **ParameterName** *(string) --* 

                The name of the parameter.

                
              

              - **Description** *(string) --* 

                A description of the parameter.

                
              

              - **Source** *(string) --* 

                The source of the parameter value.

                
              

              - **DataType** *(string) --* 

                The valid data type for the parameter.

                
              

              - **AllowedValues** *(string) --* 

                The valid range of values for the parameter.

                
              

              - **IsModifiable** *(boolean) --* 

                Indicates whether (``true`` ) or not (``false`` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

                
              

              - **MinimumEngineVersion** *(string) --* 

                The earliest cache engine version to which the parameter can apply.

                
              

              - **CacheNodeTypeSpecificValues** *(list) --* 

                A list of cache node types and their corresponding values for this parameter.

                
                

                - *(dict) --* 

                  A value that applies only to a certain cache node type.

                  
                  

                  - **CacheNodeType** *(string) --* 

                    The cache node type for which this value applies.

                    
                  

                  - **Value** *(string) --* 

                    The value for the cache node type.

                    
              
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_events

  ::

    
    paginator = client.get_paginator('describe_events')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_events`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          SourceIdentifier='string',
          SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
          StartTime=datetime(2015, 1, 1),
          EndTime=datetime(2015, 1, 1),
          Duration=123,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type SourceIdentifier: string
    :param SourceIdentifier: 

      The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

      

    
    :type SourceType: string
    :param SourceType: 

      The event source to retrieve events for. If no value is specified, all events are returned.

       

      Valid values are: ``cache-cluster`` | ``cache-parameter-group`` | ``cache-security-group`` | ``cache-subnet-group`` 

      

    
    :type StartTime: datetime
    :param StartTime: 

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

      

    
    :type EndTime: datetime
    :param EndTime: 

      The end of the time interval for which to retrieve events, specified in ISO 8601 format.

      

    
    :type Duration: integer
    :param Duration: 

      The number of minutes' worth of events to retrieve.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Events': [
                {
                    'SourceIdentifier': 'string',
                    'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
                    'Message': 'string',
                    'Date': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeEvents* action.

        
        

        - **Events** *(list) --* 

          A list of events. Each element in the list contains detailed information about one event.

          
          

          - *(dict) --* 

            Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

            
            

            - **SourceIdentifier** *(string) --* 

              The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

              
            

            - **SourceType** *(string) --* 

              Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

              
            

            - **Message** *(string) --* 

              The text of the event.

              
            

            - **Date** *(datetime) --* 

              The date and time when the event occurred.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_replication_groups

  ::

    
    paginator = client.get_paginator('describe_replication_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_replication_groups`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          ReplicationGroupId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The identifier for the replication group to be described. This parameter is not case sensitive.

       

      If you do not specify this parameter, information about all replication groups is returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReplicationGroups': [
                {
                    'ReplicationGroupId': 'string',
                    'Description': 'string',
                    'Status': 'string',
                    'PendingModifiedValues': {
                        'PrimaryClusterId': 'string',
                        'AutomaticFailoverStatus': 'enabled'|'disabled'
                    },
                    'MemberClusters': [
                        'string',
                    ],
                    'NodeGroups': [
                        {
                            'NodeGroupId': 'string',
                            'Status': 'string',
                            'PrimaryEndpoint': {
                                'Address': 'string',
                                'Port': 123
                            },
                            'NodeGroupMembers': [
                                {
                                    'CacheClusterId': 'string',
                                    'CacheNodeId': 'string',
                                    'ReadEndpoint': {
                                        'Address': 'string',
                                        'Port': 123
                                    },
                                    'PreferredAvailabilityZone': 'string',
                                    'CurrentRole': 'string'
                                },
                            ]
                        },
                    ],
                    'SnapshottingClusterId': 'string',
                    'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReplicationGroups* action.

        
        

        - **ReplicationGroups** *(list) --* 

          A list of replication groups. Each item in the list contains detailed information about one replication group.

          
          

          - *(dict) --* 

            Contains all of the attributes of a specific replication group.

            
            

            - **ReplicationGroupId** *(string) --* 

              The identifier for the replication group.

              
            

            - **Description** *(string) --* 

              The description of the replication group.

              
            

            - **Status** *(string) --* 

              The current state of this replication group - *creating* , *available* , etc.

              
            

            - **PendingModifiedValues** *(dict) --* 

              A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

              
              

              - **PrimaryClusterId** *(string) --* 

                The primary cluster ID which will be applied immediately (if ``--apply-immediately`` was specified), or during the next maintenance window.

                
              

              - **AutomaticFailoverStatus** *(string) --* 

                Indicates the status of Multi-AZ for this replication group.

                 

                .. note::

                  

                  ElastiCache Multi-AZ replication groups are not supported on:

                   

                   
                  * Redis versions earlier than 2.8.6.
                   
                  * T1 and T2 cache node types.
                   

                   

                
          
            

            - **MemberClusters** *(list) --* 

              The names of all the cache clusters that are part of this replication group.

              
              

              - *(string) --* 
          
            

            - **NodeGroups** *(list) --* 

              A single element list with information about the nodes in the replication group.

              
              

              - *(dict) --* 

                Represents a collection of cache nodes in a replication group.

                
                

                - **NodeGroupId** *(string) --* 

                  The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

                  
                

                - **Status** *(string) --* 

                  The current state of this replication group - *creating* , *available* , etc.

                  
                

                - **PrimaryEndpoint** *(dict) --* 

                  Represents the information required for client programs to connect to a cache node.

                  
                  

                  - **Address** *(string) --* 

                    The DNS hostname of the cache node.

                    
                  

                  - **Port** *(integer) --* 

                    The port number that the cache engine is listening on.

                    
              
                

                - **NodeGroupMembers** *(list) --* 

                  A list containing information about individual nodes within the node group.

                  
                  

                  - *(dict) --* 

                    Represents a single node within a node group.

                    
                    

                    - **CacheClusterId** *(string) --* 

                      The ID of the cache cluster to which the node belongs.

                      
                    

                    - **CacheNodeId** *(string) --* 

                      The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

                      
                    

                    - **ReadEndpoint** *(dict) --* 

                      Represents the information required for client programs to connect to a cache node.

                      
                      

                      - **Address** *(string) --* 

                        The DNS hostname of the cache node.

                        
                      

                      - **Port** *(integer) --* 

                        The port number that the cache engine is listening on.

                        
                  
                    

                    - **PreferredAvailabilityZone** *(string) --* 

                      The name of the Availability Zone in which the node is located.

                      
                    

                    - **CurrentRole** *(string) --* 

                      The role that is currently assigned to the node - *primary* or *replica* .

                      
                
              
            
          
            

            - **SnapshottingClusterId** *(string) --* 

              The cache cluster ID that is used as the daily snapshot source for the replication group.

              
            

            - **AutomaticFailover** *(string) --* 

              Indicates the status of Multi-AZ for this replication group.

               

              .. note::

                

                ElastiCache Multi-AZ replication groups are not supported on:

                 

                 
                * Redis versions earlier than 2.8.6.
                 
                * T1 and T2 cache node types.
                 

                 

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_reserved_cache_nodes

  ::

    
    paginator = client.get_paginator('describe_reserved_cache_nodes')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_reserved_cache_nodes`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          ReservedCacheNodeId='string',
          ReservedCacheNodesOfferingId='string',
          CacheNodeType='string',
          Duration='string',
          ProductDescription='string',
          OfferingType='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type ReservedCacheNodeId: string
    :param ReservedCacheNodeId: 

      The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

      

    
    :type ReservedCacheNodesOfferingId: string
    :param ReservedCacheNodesOfferingId: 

      The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

      

    
    :type CacheNodeType: string
    :param CacheNodeType: 

      The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Duration: string
    :param Duration: 

      The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

       

      Valid Values: ``1 | 3 | 31536000 | 94608000`` 

      

    
    :type ProductDescription: string
    :param ProductDescription: 

      The product description filter value. Use this parameter to show only those reservations matching the specified product description.

      

    
    :type OfferingType: string
    :param OfferingType: 

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

       

      Valid values: ``"Light Utilization"|"Medium Utilization"|"Heavy Utilization"`` 

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReservedCacheNodes': [
                {
                    'ReservedCacheNodeId': 'string',
                    'ReservedCacheNodesOfferingId': 'string',
                    'CacheNodeType': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'Duration': 123,
                    'FixedPrice': 123.0,
                    'UsagePrice': 123.0,
                    'CacheNodeCount': 123,
                    'ProductDescription': 'string',
                    'OfferingType': 'string',
                    'State': 'string',
                    'RecurringCharges': [
                        {
                            'RecurringChargeAmount': 123.0,
                            'RecurringChargeFrequency': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReservedCacheNodes* action.

        
        

        - **ReservedCacheNodes** *(list) --* 

          A list of reserved cache nodes. Each element in the list contains detailed information about one node.

          
          

          - *(dict) --* 

            Represents the output of a *PurchaseReservedCacheNodesOffering* action.

            
            

            - **ReservedCacheNodeId** *(string) --* 

              The unique identifier for the reservation.

              
            

            - **ReservedCacheNodesOfferingId** *(string) --* 

              The offering identifier.

              
            

            - **CacheNodeType** *(string) --* 

              The cache node type for the reserved cache nodes.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **StartTime** *(datetime) --* 

              The time the reservation started.

              
            

            - **Duration** *(integer) --* 

              The duration of the reservation in seconds.

              
            

            - **FixedPrice** *(float) --* 

              The fixed price charged for this reserved cache node.

              
            

            - **UsagePrice** *(float) --* 

              The hourly price charged for this reserved cache node.

              
            

            - **CacheNodeCount** *(integer) --* 

              The number of cache nodes that have been reserved.

              
            

            - **ProductDescription** *(string) --* 

              The description of the reserved cache node.

              
            

            - **OfferingType** *(string) --* 

              The offering type of this reserved cache node.

              
            

            - **State** *(string) --* 

              The state of the reserved cache node.

              
            

            - **RecurringCharges** *(list) --* 

              The recurring price charged to run this reserved cache node.

              
              

              - *(dict) --* 

                Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

                
                

                - **RecurringChargeAmount** *(float) --* 

                  The monetary amount of the recurring charge.

                  
                

                - **RecurringChargeFrequency** *(string) --* 

                  The frequency of the recurring charge.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_reserved_cache_nodes_offerings

  ::

    
    paginator = client.get_paginator('describe_reserved_cache_nodes_offerings')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_reserved_cache_nodes_offerings`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          ReservedCacheNodesOfferingId='string',
          CacheNodeType='string',
          Duration='string',
          ProductDescription='string',
          OfferingType='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type ReservedCacheNodesOfferingId: string
    :param ReservedCacheNodesOfferingId: 

      The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

       

      Example: ``438012d3-4052-4cc7-b2e3-8d3372e0e706`` 

      

    
    :type CacheNodeType: string
    :param CacheNodeType: 

      The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

       

      Valid node types are as follows:

       

       
      * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
       
      * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
       

      
       
      * Compute optimized: ``cache.c1.xlarge`` 
       
      * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
       
      * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
       

      
       

       

      **Notes:** 

       

       
      * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
       
      * Redis backup/restore is not supported for t2 instances.
       
      * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
       

       

      For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

      

    
    :type Duration: string
    :param Duration: 

      Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

       

      Valid Values: ``1 | 3 | 31536000 | 94608000`` 

      

    
    :type ProductDescription: string
    :param ProductDescription: 

      The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

      

    
    :type OfferingType: string
    :param OfferingType: 

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

       

      Valid Values: ``"Light Utilization"|"Medium Utilization"|"Heavy Utilization"`` 

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'ReservedCacheNodesOfferings': [
                {
                    'ReservedCacheNodesOfferingId': 'string',
                    'CacheNodeType': 'string',
                    'Duration': 123,
                    'FixedPrice': 123.0,
                    'UsagePrice': 123.0,
                    'ProductDescription': 'string',
                    'OfferingType': 'string',
                    'RecurringCharges': [
                        {
                            'RecurringChargeAmount': 123.0,
                            'RecurringChargeFrequency': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeReservedCacheNodesOfferings* action.

        
        

        - **ReservedCacheNodesOfferings** *(list) --* 

          A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

          
          

          - *(dict) --* 

            Describes all of the attributes of a reserved cache node offering.

            
            

            - **ReservedCacheNodesOfferingId** *(string) --* 

              A unique identifier for the reserved cache node offering.

              
            

            - **CacheNodeType** *(string) --* 

              The cache node type for the reserved cache node.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Duration** *(integer) --* 

              The duration of the offering. in seconds.

              
            

            - **FixedPrice** *(float) --* 

              The fixed price charged for this offering.

              
            

            - **UsagePrice** *(float) --* 

              The hourly price charged for this offering.

              
            

            - **ProductDescription** *(string) --* 

              The cache engine used by the offering.

              
            

            - **OfferingType** *(string) --* 

              The offering type.

              
            

            - **RecurringCharges** *(list) --* 

              The recurring price charged to run this reserved cache node.

              
              

              - *(dict) --* 

                Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

                
                

                - **RecurringChargeAmount** *(float) --* 

                  The monetary amount of the recurring charge.

                  
                

                - **RecurringChargeFrequency** *(string) --* 

                  The frequency of the recurring charge.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

.. py:class:: ElastiCache.Paginator.describe_snapshots

  ::

    
    paginator = client.get_paginator('describe_snapshots')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_snapshots`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          CacheClusterId='string',
          SnapshotName='string',
          SnapshotSource='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

      

    
    :type SnapshotName: string
    :param SnapshotName: 

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

      

    
    :type SnapshotSource: string
    :param SnapshotSource: 

      If set to ``system`` , the output shows snapshots that were automatically created by ElastiCache. If set to ``user`` the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Snapshots': [
                {
                    'SnapshotName': 'string',
                    'CacheClusterId': 'string',
                    'SnapshotStatus': 'string',
                    'SnapshotSource': 'string',
                    'CacheNodeType': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'NumCacheNodes': 123,
                    'PreferredAvailabilityZone': 'string',
                    'CacheClusterCreateTime': datetime(2015, 1, 1),
                    'PreferredMaintenanceWindow': 'string',
                    'TopicArn': 'string',
                    'Port': 123,
                    'CacheParameterGroupName': 'string',
                    'CacheSubnetGroupName': 'string',
                    'VpcId': 'string',
                    'AutoMinorVersionUpgrade': True|False,
                    'SnapshotRetentionLimit': 123,
                    'SnapshotWindow': 'string',
                    'NodeSnapshots': [
                        {
                            'CacheNodeId': 'string',
                            'CacheSize': 'string',
                            'CacheNodeCreateTime': datetime(2015, 1, 1),
                            'SnapshotCreateTime': datetime(2015, 1, 1)
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Represents the output of a *DescribeSnapshots* action.

        
        

        - **Snapshots** *(list) --* 

          A list of snapshots. Each item in the list contains detailed information about one snapshot.

          
          

          - *(dict) --* 

            Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

            
            

            - **SnapshotName** *(string) --* 

              The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

              
            

            - **CacheClusterId** *(string) --* 

              The user-supplied identifier of the source cache cluster.

              
            

            - **SnapshotStatus** *(string) --* 

              The status of the snapshot. Valid values: ``creating`` | ``available`` | ``restoring`` | ``copying`` | ``deleting`` .

              
            

            - **SnapshotSource** *(string) --* 

              Indicates whether the snapshot is from an automatic backup (``automated`` ) or was created manually (``manual`` ).

              
            

            - **CacheNodeType** *(string) --* 

              The name of the compute and memory capacity node type for the source cache cluster.

               

              Valid node types are as follows:

               

               
              * General purpose:  * Current generation: ``cache.t2.micro`` , ``cache.t2.small`` , ``cache.t2.medium`` , ``cache.m3.medium`` , ``cache.m3.large`` , ``cache.m3.xlarge`` , ``cache.m3.2xlarge`` 
               
              * Previous generation: ``cache.t1.micro`` , ``cache.m1.small`` , ``cache.m1.medium`` , ``cache.m1.large`` , ``cache.m1.xlarge`` 
               

              
               
              * Compute optimized: ``cache.c1.xlarge`` 
               
              * Memory optimized  * Current generation: ``cache.r3.large`` , ``cache.r3.xlarge`` , ``cache.r3.2xlarge`` , ``cache.r3.4xlarge`` , ``cache.r3.8xlarge`` 
               
              * Previous generation: ``cache.m2.xlarge`` , ``cache.m2.2xlarge`` , ``cache.m2.4xlarge`` 
               

              
               

               

              **Notes:** 

               

               
              * All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
               
              * Redis backup/restore is not supported for t2 instances.
               
              * Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
               

               

              For a complete listing of cache node types and specifications, see `Amazon ElastiCache Product Features and Details`_ and `Cache Node Type-Specific Parameters for Memcached`_ or `Cache Node Type-Specific Parameters for Redis`_ . 

              
            

            - **Engine** *(string) --* 

              The name of the cache engine (*memcached* or *redis* ) used by the source cache cluster.

              
            

            - **EngineVersion** *(string) --* 

              The version of the cache engine version that is used by the source cache cluster.

              
            

            - **NumCacheNodes** *(integer) --* 

              The number of cache nodes in the source cache cluster.

               

              For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

              
            

            - **PreferredAvailabilityZone** *(string) --* 

              The name of the Availability Zone in which the source cache cluster is located.

              
            

            - **CacheClusterCreateTime** *(datetime) --* 

              The date and time when the source cache cluster was created.

              
            

            - **PreferredMaintenanceWindow** *(string) --* 

              Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ``ddd`` are:

               

               
              * ``sun`` 
               
              * ``mon`` 
               
              * ``tue`` 
               
              * ``wed`` 
               
              * ``thu`` 
               
              * ``fri`` 
               
              * ``sat`` 
               

               

              Example: ``sun:05:00-sun:09:00`` 

              
            

            - **TopicArn** *(string) --* 

              The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

              
            

            - **Port** *(integer) --* 

              The port number used by each cache nodes in the source cache cluster.

              
            

            - **CacheParameterGroupName** *(string) --* 

              The cache parameter group that is associated with the source cache cluster.

              
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group associated with the source cache cluster.

              
            

            - **VpcId** *(string) --* 

              The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

              
            

            - **AutoMinorVersionUpgrade** *(boolean) --* 

              This parameter is currently disabled.

              
            

            - **SnapshotRetentionLimit** *(integer) --* 

              For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

               

              For manual snapshots, this field reflects the *SnapshotRetentionLimit* for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the *DeleteSnapshot* action. 

               

              **Important** If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

              
            

            - **SnapshotWindow** *(string) --* 

              The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

              
            

            - **NodeSnapshots** *(list) --* 

              A list of the cache nodes in the source cache cluster.

              
              

              - *(dict) --* 

                Represents an individual cache node in a snapshot of a cache cluster.

                
                

                - **CacheNodeId** *(string) --* 

                  The cache node identifier for the node in the source cache cluster.

                  
                

                - **CacheSize** *(string) --* 

                  The size of the cache on the source cache node.

                  
                

                - **CacheNodeCreateTime** *(datetime) --* 

                  The date and time when the cache node was created in the source cache cluster.

                  
                

                - **SnapshotCreateTime** *(datetime) --* 

                  The date and time when the source node's metadata and cache data set was obtained for the snapshot.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    

=======
Waiters
=======


The available waiters are:

* :py:class:`ElastiCache.Waiter.cache_cluster_available`


* :py:class:`ElastiCache.Waiter.cache_cluster_deleted`


* :py:class:`ElastiCache.Waiter.replication_group_available`


* :py:class:`ElastiCache.Waiter.replication_group_deleted`



.. py:class:: ElastiCache.Waiter.cache_cluster_available

  ::

    
    waiter = client.get_waiter('cache_cluster_available')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`ElastiCache.Client.describe_cache_clusters` every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          CacheClusterId='string',
          MaxRecords=123,
          Marker='string',
          ShowCacheNodeInfo=True|False
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    :type ShowCacheNodeInfo: boolean
    :param ShowCacheNodeInfo: 

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

      

    
    
    :returns: None

.. py:class:: ElastiCache.Waiter.cache_cluster_deleted

  ::

    
    waiter = client.get_waiter('cache_cluster_deleted')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`ElastiCache.Client.describe_cache_clusters` every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          CacheClusterId='string',
          MaxRecords=123,
          Marker='string',
          ShowCacheNodeInfo=True|False
      )
    :type CacheClusterId: string
    :param CacheClusterId: 

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    :type ShowCacheNodeInfo: boolean
    :param ShowCacheNodeInfo: 

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

      

    
    
    :returns: None

.. py:class:: ElastiCache.Waiter.replication_group_available

  ::

    
    waiter = client.get_waiter('replication_group_available')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`ElastiCache.Client.describe_replication_groups` every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          ReplicationGroupId='string',
          MaxRecords=123,
          Marker='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The identifier for the replication group to be described. This parameter is not case sensitive.

       

      If you do not specify this parameter, information about all replication groups is returned.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :returns: None

.. py:class:: ElastiCache.Waiter.replication_group_deleted

  ::

    
    waiter = client.get_waiter('replication_group_deleted')

  
  

  .. py:method:: wait(**kwargs)

    This polls :py:meth:`ElastiCache.Client.describe_replication_groups` every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.

    **Request Syntax** 
    ::

      waiter.wait(
          ReplicationGroupId='string',
          MaxRecords=123,
          Marker='string'
      )
    :type ReplicationGroupId: string
    :param ReplicationGroupId: 

      The identifier for the replication group to be described. This parameter is not case sensitive.

       

      If you do not specify this parameter, information about all replication groups is returned.

      

    
    :type MaxRecords: integer
    :param MaxRecords: 

      The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a marker is included in the response so that the remaining results can be retrieved.

       

      Default: 100

       

      Constraints: minimum 20; maximum 100.

      

    
    :type Marker: string
    :param Marker: 

      An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by *MaxRecords* .

      

    
    
    :returns: None