Skip to content

ManagedRuleSet

Source code in docs_src/capo_wafv2/types/managed_rule_set.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ManagedRuleSet(TypedDict, closed=True):
    name: "capo_wafv2.types.entity_name.EntityName"
    """<p>The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.</p> <p>This name is assigned to the corresponding managed rule group, which your customers can access and use. </p>"""
    id: "capo_wafv2.types.entity_id.EntityId"
    """<p>A unique identifier for the managed rule set. The ID is returned in the responses to commands like <code>list</code>. You provide it to operations like <code>get</code> and <code>update</code>.</p>"""
    arn: "capo_wafv2.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the entity.</p>"""
    description: NotRequired["capo_wafv2.types.entity_description.EntityDescription"]
    """<p>A description of the set that helps with identification. </p>"""
    published_versions: NotRequired[
        "capo_wafv2.types.published_versions.PublishedVersions"
    ]
    """<p>The versions of this managed rule set that are available for use by customers. </p>"""
    recommended_version: NotRequired[
        "capo_wafv2.types.version_key_string.VersionKeyString"
    ]
    """<p>The version that you would like your customers to use.</p>"""
    label_namespace: NotRequired["capo_wafv2.types.label_name.LabelName"]
    """<p>The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix. </p> <ul> <li> <p>The syntax for the label namespace prefix for a managed rule group is the following: </p> <p> <code>awswaf:managed:<vendor>:<rule group name></code>:</p> </li> <li> <p>When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: </p> <p> <code><label namespace>:<label from rule></code> </p> </li> </ul>"""

arn instance-attribute 

arn: ResourceArn

The Amazon Resource Name (ARN) of the entity.

description instance-attribute 

description: NotRequired[EntityDescription]

A description of the set that helps with identification.

id instance-attribute 

id: EntityId

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

label_namespace instance-attribute 

label_namespace: NotRequired[LabelName]

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

  • The syntax for the label namespace prefix for a managed rule group is the following:

    awswaf:managed:::

  • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

name instance-attribute 

name: EntityName

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

published_versions instance-attribute 

published_versions: NotRequired[PublishedVersions]

The versions of this managed rule set that are available for use by customers.

recommended_version instance-attribute 

recommended_version: NotRequired[VersionKeyString]

The version that you would like your customers to use.