probeASG

wait_desired_equals_healthy

Wait until the desired number matches the number of healthy instances for each auto-scaling group

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosaws.asg.probes
Namewait_desired_equals_healthy
Returninteger

Returns: Integer (number of seconds it took to wait) or sys.maxsize in case of timeout

Usage

JSON

{
  "name": "wait-desired-equals-healthy",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.asg.probes",
    "func": "wait_desired_equals_healthy",
    "arguments": {
      "asg_names": []
    }
  }
}

YAML

name: wait-desired-equals-healthy
provider:
  arguments:
    asg_names: []
  func: wait_desired_equals_healthy
  module: chaosaws.asg.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
tagslistnullNoASG TagsList of AWS tags for to identify ASG by tags instead of by names
timeoutfloat300NoTimeoutTimeout in seconds for the operation

Signature

def wait_desired_equals_healthy(
        asg_names: List[str],
        configuration: Dict[str, Dict[str, str]] = None,
        timeout: Union[int, float] = 300,
        secrets: Dict[str, Dict[str, str]] = None) -> int:
    pass