EKS / Waiter / ClusterActive

ClusterActive#

class EKS.Waiter.ClusterActive#
waiter = client.get_waiter('cluster_active')
wait(**kwargs)#

Polls EKS.Client.describe_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • name (string) –

    [REQUIRED]

    The name of the cluster to describe.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

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

    • MaxAttempts (integer) –

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

Returns:

None