com.amazonaws.services.securityhub.model

Class AwsWafv2CustomResponseDetails

java.lang.Object

com.amazonaws.services.securityhub.model.AwsWafv2CustomResponseDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsWafv2CustomResponseDetails
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 block.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AwsWafv2CustomResponseDetails()

Method Summary

Modifier and Type	Method and Description
AwsWafv2CustomResponseDetails	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<AwsWafv2CustomHttpHeader>	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<AwsWafv2CustomHttpHeader> responseHeaders) The HTTP headers to use in the response.
String	toString() Returns a string representation of this object.
AwsWafv2CustomResponseDetails	withCustomResponseBodyKey(String customResponseBodyKey) References the response body that you want WAF to return to the web request client.
AwsWafv2CustomResponseDetails	withResponseCode(Integer responseCode) The HTTP status code to return to the client.
AwsWafv2CustomResponseDetails	withResponseHeaders(AwsWafv2CustomHttpHeader... responseHeaders) The HTTP headers to use in the response.
AwsWafv2CustomResponseDetails	withResponseHeaders(Collection<AwsWafv2CustomHttpHeader> responseHeaders) The HTTP headers to use in the response.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AwsWafv2CustomResponseDetails

public AwsWafv2CustomResponseDetails()

Method Detail

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.

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.

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.

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.

withCustomResponseBodyKey

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

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

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 responses, 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 responses, 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 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.

withResponseCode

public AwsWafv2CustomResponseDetails 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 responses, 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 responses, 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.

getResponseHeaders

public List<AwsWafv2CustomHttpHeader> getResponseHeaders()

The HTTP headers to use in the response.

Returns:

The HTTP headers to use in the response.

setResponseHeaders

public void setResponseHeaders(Collection<AwsWafv2CustomHttpHeader> responseHeaders)

The HTTP headers to use in the response.

Parameters:

responseHeaders - The HTTP headers to use in the response.

withResponseHeaders

public AwsWafv2CustomResponseDetails withResponseHeaders(AwsWafv2CustomHttpHeader... responseHeaders)

The HTTP headers to use in the response.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withResponseHeaders

public AwsWafv2CustomResponseDetails withResponseHeaders(Collection<AwsWafv2CustomHttpHeader> responseHeaders)

The HTTP headers to use in the response.

Parameters:

responseHeaders - The HTTP headers to use in the response.

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 AwsWafv2CustomResponseDetails 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.