Package software.amazon.awssdk.services.wafv2.model

Class CustomResponse

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CustomResponse

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomResponse.Builder,CustomResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CustomResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomResponse.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CustomResponse.Builder	builder()
String	customResponseBodyKey()	References the response body that you want WAF to return to the web request client.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResponseHeaders()	For responses, this returns true if the service returned a value for the ResponseHeaders property.
Integer	responseCode()	The HTTP status code to return to the client.
List<CustomHTTPHeader>	responseHeaders()	The HTTP headers to use in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomResponse.Builder>	serializableBuilderClass()
CustomResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

responseCode

public final Integer responseCode()

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.

Returns:

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.

customResponseBodyKey

public final 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.

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.

hasResponseHeaders

public final boolean hasResponseHeaders()

For responses, this returns true if the service returned a value for the ResponseHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

responseHeaders

public final List<CustomHTTPHeader> responseHeaders()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResponseHeaders() method.

Returns:

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.

toBuilder

public CustomResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomResponse.Builder,CustomResponse>

builder

public static CustomResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CustomResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo