waiter

Documentation

Index

• func WaitForStack(ctx context.Context, cfnAPI awsapi.CloudFormation, stackID, stackName string, ...) (*types.Stack, error)
• type NextDelay
• type Waiter
  • func (w *Waiter) Wait(ctx context.Context) error
  • func (w *Waiter) WaitWithTimeout(timeout time.Duration) error

Functions

func WaitForStack

func WaitForStack(ctx context.Context, cfnAPI awsapi.CloudFormation, stackID, stackName string, nextDelay NextDelay) (*types.Stack, error)

WaitForStack waits for the cluster stack to reach a success or failure state, and returns the stack.

Types

type NextDelay

type NextDelay func(attempts int) time.Duration

NextDelay returns the amount of time to wait before the next retry given the number of attempts.

type Waiter

type Waiter struct {
	// NextDelay is the amount of time to wait before the next retry given the number of attempts.
	NextDelay NextDelay

	// Operation is the function to invoke.
	Operation func() (bool, error)
}

A Waiter keeps retrying the specified operation until it returns true, or an error.

func (*Waiter) Wait

func (w *Waiter) Wait(ctx context.Context) error

Wait waits for the specified operation to complete.

func (*Waiter) WaitWithTimeout

func (w *Waiter) WaitWithTimeout(timeout time.Duration) error

WaitWithTimeout is a wrapper around Wait that takes a timeout value instead of a Context, and returns a DeadlineExceeded error when the timeout expires. It exists to allow interfacing with code that is not using contexts yet.