Creates an automation rule based on input parameters
Source:R/securityhub_operations.R
securityhub_create_automation_rule.RdCreates an automation rule based on input parameters.
See https://www.paws-r-sdk.com/docs/securityhub_create_automation_rule/ for full documentation.
Usage
securityhub_create_automation_rule(
Tags = NULL,
RuleStatus = NULL,
RuleOrder,
RuleName,
Description,
IsTerminal = NULL,
Criteria,
Actions
)Arguments
User-defined tags associated with an automation rule.
- RuleStatus
Whether the rule is active after it is created. If this parameter is equal to
ENABLED, Security Hub CSPM 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, usebatch_update_automation_rules.- RuleOrder
[required] An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first.
- RuleName
[required] The name of the rule.
- Description
[required] A description of the rule.
- 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 CSPM 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.
- Criteria
[required] A set of ASFF finding field attributes and corresponding expected values that Security Hub CSPM uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub CSPM applies the rule action to the finding.
- Actions
[required] One or more actions to update finding fields if a finding matches the conditions specified in
Criteria.