ElastiCache / Waiter / CacheClusterAvailable

CacheClusterAvailable#

class ElastiCache.Waiter.CacheClusterAvailable#
waiter = client.get_waiter('cache_cluster_available')
wait(**kwargs)#

Polls ElastiCache.Client.describe_cache_clusters() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    CacheClusterId='string',
    MaxRecords=123,
    Marker='string',
    ShowCacheNodeInfo=True|False,
    ShowCacheClustersNotInReplicationGroups=True|False,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • CacheClusterId (string) – The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn’t case sensitive.

  • MaxRecords (integer) –

    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.

  • Marker (string) – An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • ShowCacheNodeInfo (boolean) – An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

  • ShowCacheClustersNotInReplicationGroups (boolean) – An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 15

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 40

Returns:

None