:doc:`EKS <../../eks>` / Waiter / ClusterActive

*************
ClusterActive
*************



.. py:class:: EKS.Waiter.ClusterActive

  ::

    
    waiter = client.get_waiter('cluster_active')

  
  

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

    Polls :py:meth:`EKS.Client.describe_cluster` every 30 seconds until a successful state is reached. An error is raised after 40 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeCluster>`_    


    **Request Syntax**
    ::

      waiter.wait(
          name='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type name: string
    :param name: **[REQUIRED]** 

      The name of your cluster.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      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