Module Values.CustomResponseSource

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.

Sourcetype nonrec t = {
  1. responseCode : ResponseStatusCode.t;
    (*

    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.

    *)
  2. customResponseBodyKey : EntityName.t option;
    (*

    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.

    *)
  3. responseHeaders : CustomHTTPHeaders.t option;
    (*

    The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

    *)
}
Sourceval context_ : string
Sourceval make : ?customResponseBodyKey:??? -> ?responseHeaders:??? -> responseCode:ResponseStatusCode.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of ResponseStatusCode.t | `List of [> `Structure of (string * [> `String of CustomHTTPHeaderName.t ]) list ] list | `String of EntityName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t