Class: Aws::SecurityHub::Types::UpdateAutomationRulesRequestItem

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Specifies the parameters to update in an existing automation rule.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::AutomationRulesAction>

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

Returns:



29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#criteriaTypes::AutomationRulesFindingFilters

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.



29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the rule.

Returns:

  • (String)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#is_terminalBoolean

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:

  • (Boolean)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arnString

The Amazon Resource Name (ARN) for the rule.

Returns:

  • (String)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#rule_nameString

The name of the rule.

Returns:

  • (String)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#rule_orderInteger

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:

  • (Integer)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end

#rule_statusString

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:

  • (String)


29763
29764
29765
29766
29767
29768
29769
29770
29771
29772
29773
29774
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29763

class UpdateAutomationRulesRequestItem < Struct.new(
  :rule_arn,
  :rule_status,
  :rule_order,
  :description,
  :rule_name,
  :is_terminal,
  :criteria,
  :actions)
  SENSITIVE = []
  include Aws::Structure
end