Skip to content

AutomationRulesMetadata

Source code in docs_src/capo_securityhub/types/automation_rules_metadata.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class AutomationRulesMetadata(TypedDict, closed=True):
    rule_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The Amazon Resource Name (ARN) for the rule. </p>"""
    rule_status: NotRequired["capo_securityhub.types.rule_status.RuleStatus"]
    """<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub CSPM 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 <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html"> <code>BatchUpdateAutomationRules</code> </a>. </p>"""
    rule_order: NotRequired["capo_securityhub.types.rule_order_value.RuleOrderValue"]
    """<p>An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first. </p>"""
    rule_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The name of the rule. </p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> A description of the rule. </p>"""
    is_terminal: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>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 CSPM 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. </p>"""
    created_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p> A timestamp that indicates when the rule was created. </p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    updated_at: NotRequired["capo_securityhub.types.timestamp.Timestamp"]
    """<p> A timestamp that indicates when the rule was most recently updated. </p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    created_by: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The principal that created a rule. </p>"""

created_at instance-attribute 

created_at: NotRequired[Timestamp]

A timestamp that indicates when the rule was created.

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

created_by instance-attribute 

created_by: NotRequired[NonEmptyString]

The principal that created a rule.

description instance-attribute 

description: NotRequired[NonEmptyString]

A description of the rule.

is_terminal instance-attribute 

is_terminal: NotRequired[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 CSPM 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.

rule_arn instance-attribute 

rule_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) for the rule.

rule_name instance-attribute 

rule_name: NotRequired[NonEmptyString]

The name of the rule.

rule_order instance-attribute 

rule_order: NotRequired[RuleOrderValue]

An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first.

rule_status instance-attribute 

rule_status: NotRequired[RuleStatus]

Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub CSPM 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 .

updated_at instance-attribute 

updated_at: NotRequired[Timestamp]

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 CSPM, see Timestamps.