Skip to content

FirewallRuleTypeDefinition

Source code in docs_src/capo_route53resolver/types/firewall_rule_type_definition.py
class FirewallRuleTypeDefinition(TypedDict, closed=True):
    rule_type: NotRequired["capo_route53resolver.types.rule_type_name.RuleTypeName"]
    """<p>The category or class of the rule type, such as <code>FirewallAdvancedContentCategory</code> or <code>FirewallAdvancedThreatCategory</code>.</p>"""
    value: NotRequired["capo_route53resolver.types.rule_type_value.RuleTypeValue"]
    """<p>The specific identifier within the rule type category, such as <code>VIOLENCE_AND_HATE_SPEECH</code> or <code>PHISHING</code>.</p>"""
    display_name: NotRequired["capo_route53resolver.types.display_name.DisplayName"]
    """<p>The display name of the rule type.</p>"""
    description: NotRequired[
        "capo_route53resolver.types.rule_type_description.RuleTypeDescription"
    ]
    """<p>A description of the rule type.</p>"""
    subscription_info: NotRequired[
        "capo_route53resolver.types.subscription_info.SubscriptionInfo"
    ]
    """<p>For rule types that require an external subscription (today, only the <code>PartnerThreatProtection</code> variant), describes the Amazon Web Services Marketplace product that backs the rule type. Absent for rule types that are managed by Amazon Web Services and do not require a separate subscription. See <a>SubscriptionInfo</a>.</p>"""

description instance-attribute

description: NotRequired[RuleTypeDescription]

A description of the rule type.

display_name instance-attribute

display_name: NotRequired[DisplayName]

The display name of the rule type.

rule_type instance-attribute

rule_type: NotRequired[RuleTypeName]

The category or class of the rule type, such as FirewallAdvancedContentCategory or FirewallAdvancedThreatCategory.

subscription_info instance-attribute

subscription_info: NotRequired[SubscriptionInfo]

For rule types that require an external subscription (today, only the PartnerThreatProtection variant), describes the Amazon Web Services Marketplace product that backs the rule type. Absent for rule types that are managed by Amazon Web Services and do not require a separate subscription. See SubscriptionInfo.

value instance-attribute

value: NotRequired[RuleTypeValue]

The specific identifier within the rule type category, such as VIOLENCE_AND_HATE_SPEECH or PHISHING.