Package software.amazon.awssdk.services.securityhub.model

Interface CreateAutomationRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAutomationRuleRequest.Builder,CreateAutomationRuleRequest>, SdkBuilder<CreateAutomationRuleRequest.Builder,CreateAutomationRuleRequest>, SdkPojo, SdkRequest.Builder, SecurityHubRequest.Builder
Enclosing class:
CreateAutomationRuleRequest
public static interface CreateAutomationRuleRequest.Builder extends SecurityHubRequest.Builder, SdkPojo, CopyableBuilder<CreateAutomationRuleRequest.Builder,CreateAutomationRuleRequest>

  • Method Details

    • tags

      CreateAutomationRuleRequest.Builder tags(Map<String,String> tags)

      User-defined tags associated with an automation rule.

      Parameters:
      tags - User-defined tags associated with an automation rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleStatus

      CreateAutomationRuleRequest.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. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .

      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. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleStatus

      CreateAutomationRuleRequest.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. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .

      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. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ruleOrder

      CreateAutomationRuleRequest.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

      CreateAutomationRuleRequest.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

      CreateAutomationRuleRequest.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

      CreateAutomationRuleRequest.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 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 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:
      Returns a reference to this object so that method calls can be chained together.

    • criteria

      CreateAutomationRuleRequest.Builder criteria(AutomationRulesFindingFilters criteria)

      A set of 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 conditions specified in this parameter, Security Hub applies the rule action to the finding.

      Parameters:
      criteria - A set of 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 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 CreateAutomationRuleRequest.Builder criteria(Consumer<AutomationRulesFindingFilters.Builder> criteria)

      A set of 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 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:

    • actions

      CreateAutomationRuleRequest.Builder actions(Collection<AutomationRulesAction> actions)

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

      Parameters:
      actions - One or more actions to update finding fields if a finding matches the conditions specified in Criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      CreateAutomationRuleRequest.Builder actions(AutomationRulesAction... actions)

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

      Parameters:
      actions - One or more actions to update finding fields if a finding matches the conditions specified in Criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

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

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

      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<AutomationRulesAction>).

      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:

    • overrideConfiguration

      CreateAutomationRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAutomationRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.