

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



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



.. py:class:: ElastiCache.Client

  A low-level client representing Amazon ElastiCache
   

  Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

   

  With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

   

  In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

  ::

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

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  elasticache/client/add_tags_to_resource
  elasticache/client/authorize_cache_security_group_ingress
  elasticache/client/batch_apply_update_action
  elasticache/client/batch_stop_update_action
  elasticache/client/can_paginate
  elasticache/client/close
  elasticache/client/complete_migration
  elasticache/client/copy_serverless_cache_snapshot
  elasticache/client/copy_snapshot
  elasticache/client/create_cache_cluster
  elasticache/client/create_cache_parameter_group
  elasticache/client/create_cache_security_group
  elasticache/client/create_cache_subnet_group
  elasticache/client/create_global_replication_group
  elasticache/client/create_replication_group
  elasticache/client/create_serverless_cache
  elasticache/client/create_serverless_cache_snapshot
  elasticache/client/create_snapshot
  elasticache/client/create_user
  elasticache/client/create_user_group
  elasticache/client/decrease_node_groups_in_global_replication_group
  elasticache/client/decrease_replica_count
  elasticache/client/delete_cache_cluster
  elasticache/client/delete_cache_parameter_group
  elasticache/client/delete_cache_security_group
  elasticache/client/delete_cache_subnet_group
  elasticache/client/delete_global_replication_group
  elasticache/client/delete_replication_group
  elasticache/client/delete_serverless_cache
  elasticache/client/delete_serverless_cache_snapshot
  elasticache/client/delete_snapshot
  elasticache/client/delete_user
  elasticache/client/delete_user_group
  elasticache/client/describe_cache_clusters
  elasticache/client/describe_cache_engine_versions
  elasticache/client/describe_cache_parameter_groups
  elasticache/client/describe_cache_parameters
  elasticache/client/describe_cache_security_groups
  elasticache/client/describe_cache_subnet_groups
  elasticache/client/describe_engine_default_parameters
  elasticache/client/describe_events
  elasticache/client/describe_global_replication_groups
  elasticache/client/describe_replication_groups
  elasticache/client/describe_reserved_cache_nodes
  elasticache/client/describe_reserved_cache_nodes_offerings
  elasticache/client/describe_serverless_cache_snapshots
  elasticache/client/describe_serverless_caches
  elasticache/client/describe_service_updates
  elasticache/client/describe_snapshots
  elasticache/client/describe_update_actions
  elasticache/client/describe_user_groups
  elasticache/client/describe_users
  elasticache/client/disassociate_global_replication_group
  elasticache/client/export_serverless_cache_snapshot
  elasticache/client/failover_global_replication_group
  elasticache/client/get_paginator
  elasticache/client/get_waiter
  elasticache/client/increase_node_groups_in_global_replication_group
  elasticache/client/increase_replica_count
  elasticache/client/list_allowed_node_type_modifications
  elasticache/client/list_tags_for_resource
  elasticache/client/modify_cache_cluster
  elasticache/client/modify_cache_parameter_group
  elasticache/client/modify_cache_subnet_group
  elasticache/client/modify_global_replication_group
  elasticache/client/modify_replication_group
  elasticache/client/modify_replication_group_shard_configuration
  elasticache/client/modify_serverless_cache
  elasticache/client/modify_user
  elasticache/client/modify_user_group
  elasticache/client/purchase_reserved_cache_nodes_offering
  elasticache/client/rebalance_slots_in_global_replication_group
  elasticache/client/reboot_cache_cluster
  elasticache/client/remove_tags_from_resource
  elasticache/client/reset_cache_parameter_group
  elasticache/client/revoke_cache_security_group_ingress
  elasticache/client/start_migration
  elasticache/client/test_failover
  elasticache/client/test_migration


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  elasticache/paginator/DescribeCacheClusters
  elasticache/paginator/DescribeCacheEngineVersions
  elasticache/paginator/DescribeCacheParameterGroups
  elasticache/paginator/DescribeCacheParameters
  elasticache/paginator/DescribeCacheSecurityGroups
  elasticache/paginator/DescribeCacheSubnetGroups
  elasticache/paginator/DescribeEngineDefaultParameters
  elasticache/paginator/DescribeEvents
  elasticache/paginator/DescribeGlobalReplicationGroups
  elasticache/paginator/DescribeReplicationGroups
  elasticache/paginator/DescribeReservedCacheNodes
  elasticache/paginator/DescribeReservedCacheNodesOfferings
  elasticache/paginator/DescribeServerlessCacheSnapshots
  elasticache/paginator/DescribeServerlessCaches
  elasticache/paginator/DescribeServiceUpdates
  elasticache/paginator/DescribeSnapshots
  elasticache/paginator/DescribeUpdateActions
  elasticache/paginator/DescribeUserGroups
  elasticache/paginator/DescribeUsers


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  elasticache/waiter/CacheClusterAvailable
  elasticache/waiter/CacheClusterDeleted
  elasticache/waiter/ReplicationGroupAvailable
  elasticache/waiter/ReplicationGroupDeleted
