probe ElastiCache

describe_cache_cluster

Returns cache cluster data for given cluster

Try it in Reliably

Activity as code

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

Typeprobe
Modulechaosaws.elasticache.probes
Namedescribe_cache_cluster
Returnmapping

Usage

JSON

{
  "name": "describe-cache-cluster",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosaws.elasticache.probes",
    "func": "describe_cache_cluster",
    "arguments": {
      "cluster_id": ""
    }
  }
}

YAML

name: describe-cache-cluster
provider:
  arguments:
    cluster_id: ''
  func: describe_cache_cluster
  module: chaosaws.elasticache.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequired
cluster_idstringYes
show_node_infobooleanfalseNo

A full list of possible paths can be found: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache.Client.describe_cache_clusters

example

{
  "type": "probe",
  "name": "validate cache cluster engine",
  "tolerance": {
    "type": "jsonpath",
    "path": $.CacheClusters[0].Engine,
    "expect": "memcached"
  },
  "provider": {
    "type": "python",
    "module": "chaosaws.elasticache.probes",
    "func": "describe_cache_cluster",
    "arguments": {
      "cluster_id": "MyTestCluster"
    }
  }
}

Signature

def describe_cache_cluster(
        cluster_id: str,
        show_node_info: bool = False,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass

Related activities