Struct aws_sdk_securityhub::operation::create_automation_rule::CreateAutomationRuleInput

#[non_exhaustive]
pub struct CreateAutomationRuleInput {
    pub tags: Option<HashMap<String, String>>,
    pub rule_status: Option<RuleStatus>,
    pub rule_order: Option<i32>,
    pub rule_name: Option<String>,
    pub description: Option<String>,
    pub is_terminal: Option<bool>,
    pub criteria: Option<AutomationRulesFindingFilters>,
    pub actions: Option<Vec<AutomationRulesAction>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tags: Option<HashMap<String, String>>

User-defined tags associated with an automation rule.

rule_status: Option<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 .

rule_order: Option<i32>

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.

rule_name: Option<String>

The name of the rule.

description: Option<String>

A description of the rule.

is_terminal: Option<bool>

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.

criteria: Option<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.

actions: Option<Vec<AutomationRulesAction>>

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

Implementations

impl CreateAutomationRuleInput

pub fn tags(&self) -> Option<&HashMap<String, String>>

User-defined tags associated with an automation rule.

pub fn rule_status(&self) -> Option<&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 .

pub fn rule_order(&self) -> Option<i32>

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.

pub fn rule_name(&self) -> Option<&str>

The name of the rule.

pub fn description(&self) -> Option<&str>

A description of the rule.

pub fn is_terminal(&self) -> Option<bool>

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.

pub fn criteria(&self) -> Option<&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.

pub fn actions(&self) -> &[AutomationRulesAction]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions.is_none().

impl CreateAutomationRuleInput

pub fn builder() -> CreateAutomationRuleInputBuilder

Creates a new builder-style object to manufacture CreateAutomationRuleInput.

Trait Implementations

impl Clone for CreateAutomationRuleInput

fn clone(&self) -> CreateAutomationRuleInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateAutomationRuleInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateAutomationRuleInput

fn eq(&self, other: &CreateAutomationRuleInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateAutomationRuleInput