Skip to content

DescribeManagedRuleGroupRequest

Source code in docs_src/capo_wafv2/types/describe_managed_rule_group_request.py 
16
17
18
19
20
21
22
23
24
class DescribeManagedRuleGroupRequest(TypedDict, closed=True):
    vendor_name: "capo_wafv2.types.vendor_name.VendorName"
    """<p>The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.</p>"""
    name: "capo_wafv2.types.entity_name.EntityName"
    """<p>The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.</p>"""
    scope: "capo_wafv2.types.scope.Scope"
    """<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>"""
    version_name: NotRequired["capo_wafv2.types.version_key_string.VersionKeyString"]
    """<p>The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version. </p>"""

name instance-attribute 

name: EntityName

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

scope instance-attribute 

scope: Scope

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

vendor_name instance-attribute 

vendor_name: VendorName

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

version_name instance-attribute 

version_name: NotRequired[VersionKeyString]

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.