Skip to content

RuleGroupSummary

Source code in docs_src/capo_wafv2/types/rule_group_summary.py
class RuleGroupSummary(TypedDict, closed=True):
    name: NotRequired["capo_wafv2.types.entity_name.EntityName"]
    """<p>The name of the data type instance. You cannot change the name after you create the instance.</p>"""
    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>"""
    description: NotRequired["capo_wafv2.types.entity_description.EntityDescription"]
    """<p>A description of the rule group that helps with identification. </p>"""
    lock_token: NotRequired["capo_wafv2.types.lock_token.LockToken"]
    """<p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation. </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.

description instance-attribute

description: NotRequired[EntityDescription]

A description of the rule group that helps with identification.

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.

lock_token instance-attribute

lock_token: NotRequired[LockToken]

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

name instance-attribute

name: NotRequired[EntityName]

The name of the data type instance. You cannot change the name after you create the instance.