Skip to content

AwsWafv2RuleGroupDetails

Source code in docs_src/capo_securityhub/types/aws_wafv2_rule_group_details.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class AwsWafv2RuleGroupDetails(TypedDict, closed=True):
    capacity: NotRequired["capo_securityhub.types.long.Long"]
    """<p> The web ACL capacity units (WCUs) required for this rule group. </p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> A description of the rule group that helps with identification. </p>"""
    id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> A unique identifier for the rule group. </p>"""
    name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The name of the rule group. You cannot change the name of a rule group after you create it. </p>"""
    arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> The Amazon Resource Name (ARN) of the entity. </p>"""
    rules: NotRequired["capo_securityhub.types.aws_wafv2_rules_list.AwsWafv2RulesList"]
    """<p> The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. </p>"""
    scope: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p> Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool. </p>"""
    visibility_config: NotRequired[
        "capo_securityhub.types.aws_wafv2_visibility_config_details.AwsWafv2VisibilityConfigDetails"
    ]
    """<p> Defines and enables Amazon CloudWatch metrics and web request sample collection. </p>"""

arn instance-attribute 

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the entity.

capacity instance-attribute 

capacity: NotRequired[Long]

The web ACL capacity units (WCUs) required for this rule group.

description instance-attribute 

description: NotRequired[NonEmptyString]

A description of the rule group that helps with identification.

id instance-attribute 

id: NotRequired[NonEmptyString]

A unique identifier for the rule group.

name instance-attribute 

name: NotRequired[NonEmptyString]

The name of the rule group. You cannot change the name of a rule group after you create it.

rules instance-attribute 

rules: NotRequired[AwsWafv2RulesList]

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

scope instance-attribute 

scope: NotRequired[NonEmptyString]

Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

visibility_config instance-attribute 

visibility_config: NotRequired[AwsWafv2VisibilityConfigDetails]

Defines and enables Amazon CloudWatch metrics and web request sample collection.