actionRDS

failover_db_cluster

Forces a failover for a DB cluster

Activity as code

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

Typeaction
Modulechaosaws.rds.actions
Namefailover_db_cluster
Returnmapping

Usage

JSON

{
  "name": "failover-db-cluster",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.rds.actions",
    "func": "failover_db_cluster",
    "arguments": {
      "db_cluster_identifier": ""
    }
  }
}

YAML

name: failover-db-cluster
provider:
  arguments:
    db_cluster_identifier: ""
  func: failover_db_cluster
  module: chaosaws.rds.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
db_cluster_identifierstringYesDB Cluster IDDatabase cluster identifier
target_db_instance_identifierstringnullNoTarget DB Instance IDTarget database instance identifier

Signature

def failover_db_cluster(
        db_cluster_identifier: str,
        target_db_instance_identifier: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass