actionRDS

stop_db_instance

Stops a RDS DB instance

Activity as code

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

Typeaction
Modulechaosaws.rds.actions
Namestop_db_instance
Returnmapping

Usage

JSON

{
  "name": "stop-db-instance",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.rds.actions",
    "func": "stop_db_instance",
    "arguments": {
      "db_instance_identifier": ""
    }
  }
}

YAML

name: stop-db-instance
provider:
  arguments:
    db_instance_identifier: ""
  func: stop_db_instance
  module: chaosaws.rds.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
db_instance_identifierstringYesDB Instance IDDatabase instance identifier
db_snapshot_identifierstringnullNoDN Snapshot IDDatabase snapshot identifier

Signature

def stop_db_instance(
        db_instance_identifier: str,
        db_snapshot_identifier: str = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass