Package software.amazon.awscdk.services.securityhub

Class CfnAutomationRuleProps.Builder

java.lang.Object

software.amazon.awscdk.services.securityhub.CfnAutomationRuleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAutomationRuleProps>

Enclosing interface:

CfnAutomationRuleProps

@Stability(Stable)
public static final class CfnAutomationRuleProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAutomationRuleProps>

A builder for CfnAutomationRuleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAutomationRuleProps.Builder	actions(List<? extends Object> actions)	Sets the value of CfnAutomationRuleProps.getActions()
CfnAutomationRuleProps.Builder	actions(IResolvable actions)	Sets the value of CfnAutomationRuleProps.getActions()
CfnAutomationRuleProps	build()	Builds the configured instance.
CfnAutomationRuleProps.Builder	criteria(IResolvable criteria)	Sets the value of CfnAutomationRuleProps.getCriteria()
CfnAutomationRuleProps.Builder	criteria(CfnAutomationRule.AutomationRulesFindingFiltersProperty criteria)	Sets the value of CfnAutomationRuleProps.getCriteria()
CfnAutomationRuleProps.Builder	description(String description)	Sets the value of CfnAutomationRuleProps.getDescription()
CfnAutomationRuleProps.Builder	isTerminal(Boolean isTerminal)	Sets the value of CfnAutomationRuleProps.getIsTerminal()
CfnAutomationRuleProps.Builder	isTerminal(IResolvable isTerminal)	Sets the value of CfnAutomationRuleProps.getIsTerminal()
CfnAutomationRuleProps.Builder	ruleName(String ruleName)	Sets the value of CfnAutomationRuleProps.getRuleName()
CfnAutomationRuleProps.Builder	ruleOrder(Number ruleOrder)	Sets the value of CfnAutomationRuleProps.getRuleOrder()
CfnAutomationRuleProps.Builder	ruleStatus(String ruleStatus)	Sets the value of CfnAutomationRuleProps.getRuleStatus()
CfnAutomationRuleProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnAutomationRuleProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

actions

@Stability(Stable)
public CfnAutomationRuleProps.Builder actions(IResolvable actions)

Sets the value of CfnAutomationRuleProps.getActions()

Parameters:

actions - One or more actions to update finding fields if a finding matches the conditions specified in Criteria . This parameter is required.

Returns:

this

actions

@Stability(Stable)
public CfnAutomationRuleProps.Builder actions(List<? extends Object> actions)

Sets the value of CfnAutomationRuleProps.getActions()

Parameters:

actions - One or more actions to update finding fields if a finding matches the conditions specified in Criteria . This parameter is required.

Returns:

this

criteria

@Stability(Stable)
public CfnAutomationRuleProps.Builder criteria(IResolvable criteria)

Sets the value of CfnAutomationRuleProps.getCriteria()

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

criteria

@Stability(Stable)
public CfnAutomationRuleProps.Builder criteria(CfnAutomationRule.AutomationRulesFindingFiltersProperty criteria)

Sets the value of CfnAutomationRuleProps.getCriteria()

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

description

@Stability(Stable)
public CfnAutomationRuleProps.Builder description(String description)

Sets the value of CfnAutomationRuleProps.getDescription()

Parameters:

description - A description of the rule. This parameter is required.

Returns:

this

ruleName

@Stability(Stable)
public CfnAutomationRuleProps.Builder ruleName(String ruleName)

Sets the value of CfnAutomationRuleProps.getRuleName()

Parameters:

ruleName - The name of the rule. This parameter is required.

Returns:

this

ruleOrder

@Stability(Stable)
public CfnAutomationRuleProps.Builder ruleOrder(Number ruleOrder)

Sets the value of CfnAutomationRuleProps.getRuleOrder()

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. Security Hub applies rules with lower values for this parameter first.

Returns:

this

isTerminal

@Stability(Stable)
public CfnAutomationRuleProps.Builder isTerminal(Boolean isTerminal)

Sets the value of CfnAutomationRuleProps.getIsTerminal()

Parameters:

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.

Returns:

this

isTerminal

@Stability(Stable)
public CfnAutomationRuleProps.Builder isTerminal(IResolvable isTerminal)

Sets the value of CfnAutomationRuleProps.getIsTerminal()

Parameters:

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.

Returns:

this

ruleStatus

@Stability(Stable)
public CfnAutomationRuleProps.Builder ruleStatus(String ruleStatus)

Sets the value of CfnAutomationRuleProps.getRuleStatus()

Parameters:

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.

Returns:

this

tags

@Stability(Stable)
public CfnAutomationRuleProps.Builder tags(Map<String,String> tags)

Sets the value of CfnAutomationRuleProps.getTags()

Parameters:

tags - User-defined tags associated with an automation rule.

Returns:

this

build

@Stability(Stable)
public CfnAutomationRuleProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAutomationRuleProps>

Returns:

a new instance of CfnAutomationRuleProps

Throws:

NullPointerException - if any required attribute was not provided