Class CfnAutomationRule.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAutomationRule>
- Enclosing class:
CfnAutomationRule
CfnAutomationRule
.-
Method Summary
Modifier and TypeMethodDescriptionOne or more actions to update finding fields if a finding matches the conditions specified inCriteria
.actions
(IResolvable actions) One or more actions to update finding fields if a finding matches the conditions specified inCriteria
.build()
static CfnAutomationRule.Builder
criteria
(IResolvable criteria) A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.description
(String description) A description of the rule.isTerminal
(Boolean isTerminal) Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.isTerminal
(IResolvable isTerminal) Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.The name of the rule.An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.ruleStatus
(String ruleStatus) Whether the rule is active after it is created.User-defined tags associated with an automation rule.
-
Method Details
-
create
@Stability(Stable) public static CfnAutomationRule.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnAutomationRule.Builder
.
-
actions
One or more actions to update finding fields if a finding matches the conditions specified inCriteria
.- Parameters:
actions
- One or more actions to update finding fields if a finding matches the conditions specified inCriteria
. This parameter is required.- Returns:
this
- See Also:
-
actions
One or more actions to update finding fields if a finding matches the conditions specified inCriteria
.- Parameters:
actions
- One or more actions to update finding fields if a finding matches the conditions specified inCriteria
. This parameter is required.- Returns:
this
- See Also:
-
criteria
A set of AWS Security Finding Format (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 criteria specified in this parameter, Security Hub applies the rule action to the finding.- Parameters:
criteria
- A set of AWS Security Finding Format (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 criteria specified in this parameter, Security Hub applies the rule action to the finding. This parameter is required.- Returns:
this
- See Also:
-
criteria
@Stability(Stable) public CfnAutomationRule.Builder criteria(CfnAutomationRule.AutomationRulesFindingFiltersProperty criteria) A set of AWS Security Finding Format (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 criteria specified in this parameter, Security Hub applies the rule action to the finding.- Parameters:
criteria
- A set of AWS Security Finding Format (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 criteria specified in this parameter, Security Hub applies the rule action to the finding. This parameter is required.- Returns:
this
- See Also:
-
description
A description of the rule.- Parameters:
description
- A description of the rule. This parameter is required.- Returns:
this
- See Also:
-
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.
- Parameters:
isTerminal
- Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This parameter is required.- Returns:
this
- See Also:
-
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.
- Parameters:
isTerminal
- Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This parameter is required.- Returns:
this
- See Also:
-
ruleName
The name of the rule.- Parameters:
ruleName
- The name of the rule. This parameter is required.- Returns:
this
- See Also:
-
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.
- Parameters:
ruleOrder
- An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. This parameter is required.- Returns:
this
- See Also:
-
ruleStatus
Whether the rule is active after it is created.If this parameter is equal to
ENABLED
, Security Hub applies the rule to findings and finding updates after the rule is created.- Parameters:
ruleStatus
- Whether the rule is active after it is created. This parameter is required.- Returns:
this
- See Also:
-
tags
User-defined tags associated with an automation rule.- Parameters:
tags
- User-defined tags associated with an automation rule. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAutomationRule>
- Returns:
- a newly built instance of
CfnAutomationRule
.
-