CustomResponse (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.CustomResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomResponse()

Constructors
Constructor and Description
`CustomResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomResponseBodyKey()` References the response body that you want WAF to return to the web request client.
`Integer`	`getResponseCode()` The HTTP status code to return to the client.
`List<CustomHTTPHeader>`	`getResponseHeaders()` The HTTP headers to use in the response.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomResponseBodyKey(String customResponseBodyKey)` References the response body that you want WAF to return to the web request client.
`void`	`setResponseCode(Integer responseCode)` The HTTP status code to return to the client.
`void`	`setResponseHeaders(Collection<CustomHTTPHeader> responseHeaders)` The HTTP headers to use in the response.
`String`	`toString()` Returns a string representation of this object.
`CustomResponse`	`withCustomResponseBodyKey(String customResponseBodyKey)` References the response body that you want WAF to return to the web request client.
`CustomResponse`	`withResponseCode(Integer responseCode)` The HTTP status code to return to the client.
`CustomResponse`	`withResponseHeaders(Collection<CustomHTTPHeader> responseHeaders)` The HTTP headers to use in the response.
`CustomResponse`	`withResponseHeaders(CustomHTTPHeader... responseHeaders)` The HTTP headers to use in the response.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomResponse
```
public CustomResponse()
```
- Method Detail
  - setResponseCode
```
public void setResponseCode(Integer responseCode)
```
    The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
    
    Parameters:
    
    responseCode - The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
  - getResponseCode
```
public Integer getResponseCode()
```
    The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
    
    Returns:
    
    The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
  - withResponseCode
```
public CustomResponse withResponseCode(Integer responseCode)
```
    The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
    
    Parameters:
    
    responseCode - The HTTP status code to return to the client.
    
    For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomResponseBodyKey
```
public void setCustomResponseBodyKey(String customResponseBodyKey)
```
    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.
    
    Parameters:
    
    customResponseBodyKey - 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.
  - getCustomResponseBodyKey
```
public String getCustomResponseBodyKey()
```
    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.
    
    Returns:
    
    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.
  - withCustomResponseBodyKey
```
public CustomResponse withCustomResponseBodyKey(String customResponseBodyKey)
```
    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.
    
    Parameters:
    
    customResponseBodyKey - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseHeaders
```
public List<CustomHTTPHeader> getResponseHeaders()
```
    The HTTP headers to use in the response. 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.
    
    Returns:
    
    The HTTP headers to use in the response. 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.
  - setResponseHeaders
```
public void setResponseHeaders(Collection<CustomHTTPHeader> responseHeaders)
```
    The HTTP headers to use in the response. 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.
    
    Parameters:
    
    responseHeaders - The HTTP headers to use in the response. 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.
  - withResponseHeaders
```
public CustomResponse withResponseHeaders(CustomHTTPHeader... responseHeaders)
```
    The HTTP headers to use in the response. 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setResponseHeaders(java.util.Collection) or withResponseHeaders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    responseHeaders - The HTTP headers to use in the response. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResponseHeaders
```
public CustomResponse withResponseHeaders(Collection<CustomHTTPHeader> responseHeaders)
```
    The HTTP headers to use in the response. 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.
    
    Parameters:
    
    responseHeaders - The HTTP headers to use in the response. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CustomResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CustomResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomResponse

Method Detail

setResponseCode

getResponseCode

withResponseCode

setCustomResponseBodyKey

getCustomResponseBodyKey

withCustomResponseBodyKey

getResponseHeaders

setResponseHeaders

withResponseHeaders

withResponseHeaders

toString

equals

hashCode

clone

marshall