Skip to content

CreateAutomationRuleV2Request

Source code in docs_src/capo_securityhub/types/create_automation_rule_v2_request.py
class CreateAutomationRuleV2Request(TypedDict, closed=True):
    rule_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the V2 automation rule.</p>"""
    rule_status: NotRequired["capo_securityhub.types.rule_status_v2.RuleStatusV2"]
    """<p>The status of the V2 automation rule.</p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A description of the V2 automation rule.</p>"""
    rule_order: NotRequired[
        "capo_securityhub.types.rule_order_value_v2.RuleOrderValueV2"
    ]
    """<p>The value for the rule priority.</p>"""
    criteria: NotRequired["capo_securityhub.types.criteria.Criteria"]
    """<p>The filtering type and configuration of the automation rule.</p>"""
    actions: NotRequired[
        "capo_securityhub.types.automation_rules_action_list_v2.AutomationRulesActionListV2"
    ]
    """<p>A list of actions to be performed when the rule criteria is met.</p>"""
    tags: NotRequired["capo_securityhub.types.tag_map.TagMap"]
    """<p>A list of key-value pairs associated with the V2 automation rule.</p>"""
    client_token: NotRequired["capo_securityhub.types.client_token.ClientToken"]
    """<p>A unique identifier used to ensure idempotency.</p>"""

actions instance-attribute

actions: NotRequired[AutomationRulesActionListV2]

A list of actions to be performed when the rule criteria is met.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique identifier used to ensure idempotency.

criteria instance-attribute

criteria: NotRequired[Criteria]

The filtering type and configuration of the automation rule.

description instance-attribute

description: NotRequired[NonEmptyString]

A description of the V2 automation rule.

rule_name instance-attribute

rule_name: NotRequired[NonEmptyString]

The name of the V2 automation rule.

rule_order instance-attribute

rule_order: NotRequired[RuleOrderValueV2]

The value for the rule priority.

rule_status instance-attribute

rule_status: NotRequired[RuleStatusV2]

The status of the V2 automation rule.

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs associated with the V2 automation rule.