[ aws . eks ]

wait

Description

Wait until a particular condition is satisfied. Each subcommand polls an API until the listed requirement is met.

Available Commands

• addon-active
• addon-deleted
• certificate-authority-update-complete
• cluster-active
• cluster-deleted
• fargate-profile-active
• fargate-profile-deleted
• nodegroup-active
• nodegroup-deleted

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To wait for a cluster to become active

The following wait example uses the cluster-active waiter to pause and resume running only after a cluster named example becomes active.

aws eks wait cluster-active \
    --name example

This command produces no output.

For more information, see Create an Amazon EKS cluster in the Amazon EKS User Guide.

Example 2: To wait for a cluster to be deleted

The following wait example uses the cluster-deleted waiter to pause and resume running only after a cluster named example is deleted.

aws eks wait cluster-deleted \
    --name example

This command produces no output.

For more information, see Delete a cluster in the Amazon EKS User Guide.