action RDS

delete_db_instance

Deletes an RDS instance

Run it now
View details
Typeaction
Modulechaosaws.rds.actions
Namedelete_db_instance
Returnmapping

Usage

JSON

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

YAML

name: delete-db-instance
provider:
  arguments:
    db_instance_identifier: ""
  func: delete_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
skip_final_snapshotbooleantrueNoSkip Final SnapshotWhether the final snapshot of the database should be skipped
delete_automated_backupsbooleantrueNoDelete Automated BackupsWhether to delete the existing automated backups
  • db_instance_identifier: the identifier of the RDS instance to delete
  • skip_final_snapshot: boolean (true): determines whether or not to perform a final snapshot of the rds instance before deletion
  • db_snapshot_identifier: the identifier to give the final rds snapshot
  • delete_automated_backups: boolean (true): determines if the automated backups of the rds instance are deleted immediately

Signature

def delete_db_instance(
        db_instance_identifier: str,
        skip_final_snapshot: bool = True,
        db_snapshot_identifier: str = None,
        delete_automated_backups: bool = True,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass