wafv2/aws.sdk.kotlin.services.wafv2.model/CustomResponse

CustomResponse

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

Types

Builder

class Builder

Companion

object Companion

Properties

customResponseBodyKey

val customResponseBodyKey: String?

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. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

responseCode

val responseCode: Int

The HTTP status code to return to the client.

responseHeaders

val responseHeaders: List<CustomHttpHeader>?

The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

Functions

copy

inline fun copy(block: CustomResponse.Builder.() -> Unit = {}): CustomResponse

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String