Skip to content

AwsWafv2CustomResponseDetails

Source code in docs_src/capo_securityhub/types/aws_wafv2_custom_response_details.py
class AwsWafv2CustomResponseDetails(TypedDict, closed=True):
    custom_response_body_key: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. </p>"""
    response_code: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p> The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html">Supported status codes for custom response</a> in the <i>WAF Developer Guide.</i> </p>"""
    response_headers: NotRequired[
        "capo_securityhub.types.aws_wafv2_insert_headers_list.AwsWafv2InsertHeadersList"
    ]
    """<p> The HTTP headers to use in the response. </p>"""

custom_response_body_key instance-attribute

custom_response_body_key: NotRequired[NonEmptyString]

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.

response_code instance-attribute

response_code: NotRequired[Integer]

The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

response_headers instance-attribute

response_headers: NotRequired[AwsWafv2InsertHeadersList]

The HTTP headers to use in the response.