Class: Aws::SecurityHub::Types::CreateAutomationRuleRequest

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::CreateAutomationRuleRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::AutomationRulesAction>

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

• #criteria ⇒ Types::AutomationRulesFindingFilters

  A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings.

• #description ⇒ String

  A description of the rule.

• #is_terminal ⇒ Boolean

  Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.

• #rule_name ⇒ String

  The name of the rule.

• #rule_order ⇒ Integer

  An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.

• #rule_status ⇒ String

  Whether the rule is active after it is created.

• #tags ⇒ Hash<String,String>

  User-defined tags associated with an automation rule.

Instance Attribute Details

#actions ⇒ Array<Types::AutomationRulesAction>

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

Returns:

• (Array<Types::AutomationRulesAction>)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#criteria ⇒ Types::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.

Returns:

• (Types::AutomationRulesFindingFilters)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#description ⇒ String

A description of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#is_terminal ⇒ Boolean

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)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#rule_name ⇒ String

The name of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#rule_order ⇒ Integer

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)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#rule_status ⇒ String

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` ][1].

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html

Returns:

• (String)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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

#tags ⇒ Hash<String,String>

User-defined tags associated with an automation rule.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 23552

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