software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.CustomResponseProperty.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnRuleGroup.CustomResponseProperty.Builder

Enclosing interface:

CfnRuleGroup.CustomResponseProperty

public static final class CfnRuleGroup.CustomResponseProperty.Builder
extends java.lang.Object

A builder for CfnRuleGroup.CustomResponseProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRuleGroup.CustomResponseProperty	build() Builds the configured instance.
CfnRuleGroup.CustomResponseProperty.Builder	customResponseBodyKey(java.lang.String customResponseBodyKey) Sets the value of CfnRuleGroup.CustomResponseProperty.getCustomResponseBodyKey()
CfnRuleGroup.CustomResponseProperty.Builder	responseCode(java.lang.Number responseCode) Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseCode()
CfnRuleGroup.CustomResponseProperty.Builder	responseHeaders(IResolvable responseHeaders) Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseHeaders()
CfnRuleGroup.CustomResponseProperty.Builder	responseHeaders(java.util.List<? extends java.lang.Object> responseHeaders) Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseHeaders()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

responseCode

public CfnRuleGroup.CustomResponseProperty.Builder responseCode(java.lang.Number responseCode)

Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseCode()

Parameters:

responseCode - The HTTP status code to return to the client. This parameter is required. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide .

Returns:

this

customResponseBodyKey

public CfnRuleGroup.CustomResponseProperty.Builder customResponseBodyKey(java.lang.String customResponseBodyKey)

Sets the value of CfnRuleGroup.CustomResponseProperty.getCustomResponseBodyKey()

Parameters:

customResponseBodyKey - References the response body that you want AWS 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:

this

responseHeaders

public CfnRuleGroup.CustomResponseProperty.Builder responseHeaders(IResolvable responseHeaders)

Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseHeaders()

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 AWS WAF quotas in the AWS WAF Developer Guide .

Returns:

this

responseHeaders

public CfnRuleGroup.CustomResponseProperty.Builder responseHeaders(java.util.List<? extends java.lang.Object> responseHeaders)

Sets the value of CfnRuleGroup.CustomResponseProperty.getResponseHeaders()

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 AWS WAF quotas in the AWS WAF Developer Guide .

Returns:

this

build

public CfnRuleGroup.CustomResponseProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRuleGroup.CustomResponseProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided