Struct AutomationRulesMetadata

#[non_exhaustive]
pub struct AutomationRulesMetadata {
    pub rule_arn: Option<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 created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub created_by: Option<String>,
}

Metadata for automation rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.

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.

rule_arn: Option<String>

The Amazon Resource Name (ARN) for the 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.

created_at: Option<DateTime>

A timestamp that indicates when the rule was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

updated_at: Option<DateTime>

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

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

created_by: Option<String>

The principal that created a rule.

Implementations

impl AutomationRulesMetadata

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

The Amazon Resource Name (ARN) for the 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 created_at(&self) -> Option<&DateTime>

A timestamp that indicates when the rule was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

pub fn updated_at(&self) -> Option<&DateTime>

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

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

The principal that created a rule.

impl AutomationRulesMetadata

pub fn builder() -> AutomationRulesMetadataBuilder

Creates a new builder-style object to manufacture AutomationRulesMetadata.

Trait Implementations

impl Clone for AutomationRulesMetadata

fn clone(&self) -> AutomationRulesMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutomationRulesMetadata

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

Formats the value using the given formatter.

impl PartialEq for AutomationRulesMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AutomationRulesMetadata