Skip to content

GetRuleGroupRequest

Source code in docs_src/capo_wafv2/types/get_rule_group_request.py 
14
15
16
17
18
19
20
21
22
class GetRuleGroupRequest(TypedDict, closed=True):
    name: NotRequired["capo_wafv2.types.entity_name.EntityName"]
    """<p>The name of the rule group. You cannot change the name of a rule group after you create it.</p>"""
    scope: NotRequired["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>"""
    id: NotRequired["capo_wafv2.types.entity_id.EntityId"]
    """<p>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>"""
    arn: NotRequired["capo_wafv2.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the entity.</p>"""

arn instance-attribute 

arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the entity.

id instance-attribute 

id: NotRequired[EntityId]

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

name instance-attribute 

name: NotRequired[EntityName]

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

scope instance-attribute 

scope: NotRequired[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.