AutomationRuleArgs

data class AutomationRuleArgs(val actions: Output<List<AutomationRulesActionArgs>>? = null, val criteria: Output<AutomationRulesFindingFiltersArgs>? = null, val description: Output<String>? = null, val isTerminal: Output<Boolean>? = null, val ruleName: Output<String>? = null, val ruleOrder: Output<Int>? = null, val ruleStatus: Output<AutomationRuleRuleStatus>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<AutomationRuleArgs>

The `AWS::SecurityHub::AutomationRule` resource specifies an automation rule based on input parameters. For more information, see Automation rules in the User Guide.

Example Usage

Example

No Java example available.

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(actions: Output<List<AutomationRulesActionArgs>>? = null, criteria: Output<AutomationRulesFindingFiltersArgs>? = null, description: Output<String>? = null, isTerminal: Output<Boolean>? = null, ruleName: Output<String>? = null, ruleOrder: Output<Int>? = null, ruleStatus: Output<AutomationRuleRuleStatus>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val actions: Output<List<AutomationRulesActionArgs>>? = null

One or more actions to update finding fields if a finding matches the conditions specified in `Criteria`.

Link copied to clipboard

A set of Security Finding Format (ASFF) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.

Link copied to clipboard
val description: Output<String>? = null

A description of the rule.

Link copied to clipboard
val isTerminal: Output<Boolean>? = null

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.

Link copied to clipboard
val ruleName: Output<String>? = null

The name of the rule.

Link copied to clipboard
val ruleOrder: Output<Int>? = null

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.

Link copied to clipboard

Whether the rule is active after it is created. If this parameter is equal to `ENABLED`, ASH applies the rule to findings and finding updates after the rule is created.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

User-defined tags associated with an automation rule.

Functions

Link copied to clipboard
open override fun toJava(): AutomationRuleArgs