UpdateAutomationRulesRequestItem
Specifies the parameters to update in an existing automation rule.
Contents
- RuleArn
-
The Amazon Resource Name (ARN) for the rule.
Type: String
Pattern:
.*\S.*Required: Yes
- Actions
-
One or more actions to update finding fields if a finding matches the conditions specified in
Criteria.Type: Array of AutomationRulesAction objects
Array Members: Fixed number of 1 item.
Required: No
- Criteria
-
A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
Type: AutomationRulesFindingFilters object
Required: No
- Description
-
A description of the rule.
Type: String
Pattern:
.*\S.*Required: No
- IsTerminal
-
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
Type: Boolean
Required: No
- RuleName
-
The name of the rule.
Type: String
Pattern:
.*\S.*Required: No
- RuleOrder
-
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- RuleStatus
-
Whether the rule is active after it is created. If this parameter is equal to
ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, useBatchUpdateAutomationRules.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: