actionCloudWatch

delete_rule

Deletes a CloudWatch rule

Activity as code

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

Typeaction
Modulechaosaws.cloudwatch.actions
Namedelete_rule
Returnmapping

Usage

JSON

{
  "name": "delete-rule",
  "type": "action",
  "provider": {
    "type": "python",
    "module": "chaosaws.cloudwatch.actions",
    "func": "delete_rule",
    "arguments": {
      "rule_name": ""
    }
  }
}

YAML

name: delete-rule
provider:
  arguments:
    rule_name: ""
  func: delete_rule
  module: chaosaws.cloudwatch.actions
  type: python
type: action

Arguments

NameTypeDefaultRequiredTitleDescription
rule_namestringYesRule NameName of the rule to remove
forcebooleanfalseNoForceRemove all targets before removing the rule

All rule targets must be removed before deleting the rule. Set input argument force to True to force all rule targets to be deleted.

Signature

def delete_rule(rule_name: str,
                force: bool = False,
                configuration: Dict[str, Dict[str, str]] = None,
                secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass