software.amazon.awssdk.services.securityhub.model

Interface AutomationRulesConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutomationRulesConfig.Builder,AutomationRulesConfig>, SdkBuilder<AutomationRulesConfig.Builder,AutomationRulesConfig>, SdkPojo

Enclosing class:

AutomationRulesConfig

public static interface AutomationRulesConfig.Builder
extends SdkPojo, CopyableBuilder<AutomationRulesConfig.Builder,AutomationRulesConfig>

Method Summary

Modifier and Type	Method and Description
AutomationRulesConfig.Builder	actions(AutomationRulesAction... actions) One or more actions to update finding fields if a finding matches the defined criteria of the rule.
AutomationRulesConfig.Builder	actions(Collection<AutomationRulesAction> actions) One or more actions to update finding fields if a finding matches the defined criteria of the rule.
AutomationRulesConfig.Builder	actions(Consumer<AutomationRulesAction.Builder>... actions) One or more actions to update finding fields if a finding matches the defined criteria of the rule.
AutomationRulesConfig.Builder	createdAt(Instant createdAt) A timestamp that indicates when the rule was created.
AutomationRulesConfig.Builder	createdBy(String createdBy) The principal that created a rule.
AutomationRulesConfig.Builder	criteria(AutomationRulesFindingFilters criteria) A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that Security Hub uses to filter findings.
default AutomationRulesConfig.Builder	criteria(Consumer<AutomationRulesFindingFilters.Builder> criteria) A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that Security Hub uses to filter findings.
AutomationRulesConfig.Builder	description(String description) A description of the rule.
AutomationRulesConfig.Builder	isTerminal(Boolean isTerminal) Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
AutomationRulesConfig.Builder	ruleArn(String ruleArn) The Amazon Resource Name (ARN) of a rule.
AutomationRulesConfig.Builder	ruleName(String ruleName) The name of the rule.
AutomationRulesConfig.Builder	ruleOrder(Integer ruleOrder) An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
AutomationRulesConfig.Builder	ruleStatus(RuleStatus ruleStatus) Whether the rule is active after it is created.
AutomationRulesConfig.Builder	ruleStatus(String ruleStatus) Whether the rule is active after it is created.
AutomationRulesConfig.Builder	updatedAt(Instant updatedAt) A timestamp that indicates when the rule was most recently updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

ruleArn

AutomationRulesConfig.Builder ruleArn(String ruleArn)

The Amazon Resource Name (ARN) of a rule.

Parameters:

ruleArn - The Amazon Resource Name (ARN) of a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleStatus

AutomationRulesConfig.Builder ruleStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleStatus, RuleStatus

ruleStatus

AutomationRulesConfig.Builder ruleStatus(RuleStatus 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RuleStatus, RuleStatus

ruleOrder

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleName

AutomationRulesConfig.Builder ruleName(String ruleName)

The name of the rule.

Parameters:

ruleName - The name of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

AutomationRulesConfig.Builder description(String description)

A description of the rule.

Parameters:

description - A description of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

isTerminal

AutomationRulesConfig.Builder isTerminal(Boolean 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 the value of this field is set to true for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding.
 The default value of this field is false.

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 the value of this field is set to true for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding.
 The default value of this field is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

criteria

AutomationRulesConfig.Builder criteria(AutomationRulesFindingFilters criteria)

A set of Amazon Web Services Security Finding Format 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.

Parameters:

criteria - A set of Amazon Web Services Security Finding Format 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

criteria

default AutomationRulesConfig.Builder criteria(Consumer<AutomationRulesFindingFilters.Builder> criteria)

A set of Amazon Web Services Security Finding Format 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.

This is a convenience method that creates an instance of the AutomationRulesFindingFilters.Builder avoiding the need to create one manually via AutomationRulesFindingFilters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to criteria(AutomationRulesFindingFilters).

Parameters:

criteria - a consumer that will call methods on AutomationRulesFindingFilters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

criteria(AutomationRulesFindingFilters)

actions

AutomationRulesConfig.Builder actions(Collection<AutomationRulesAction> actions)

One or more actions to update finding fields if a finding matches the defined criteria of the rule.

Parameters:

actions - One or more actions to update finding fields if a finding matches the defined criteria of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

AutomationRulesConfig.Builder actions(AutomationRulesAction... actions)

One or more actions to update finding fields if a finding matches the defined criteria of the rule.

Parameters:

actions - One or more actions to update finding fields if a finding matches the defined criteria of the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

AutomationRulesConfig.Builder actions(Consumer<AutomationRulesAction.Builder>... actions)

One or more actions to update finding fields if a finding matches the defined criteria of the rule.

This is a convenience method that creates an instance of the AutomationRulesAction.Builder avoiding the need to create one manually via AutomationRulesAction.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on AutomationRulesAction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#actions(java.util.Collection)

createdAt

AutomationRulesConfig.Builder createdAt(Instant createdAt)

A timestamp that indicates when the rule was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Parameters:

createdAt - A timestamp that indicates when the rule was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

AutomationRulesConfig.Builder updatedAt(Instant updatedAt)

A timestamp that indicates when the rule was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Parameters:

updatedAt - A timestamp that indicates when the rule was most recently updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdBy

AutomationRulesConfig.Builder createdBy(String createdBy)

The principal that created a rule.

Parameters:

createdBy - The principal that created a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.