software.amazon.awscdk.services.wafv2

Interface CfnWebACL.BlockActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.BlockActionProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(value=Stable)
public static interface CfnWebACL.BlockActionProperty
extends software.amazon.jsii.JsiiSerializable

Specifies that AWS WAF should block the request and optionally defines additional custom handling for the response to the web request.

This is used in the context of other settings, for example to specify values for a rule action or a web ACL default action.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 BlockActionProperty blockActionProperty = BlockActionProperty.builder()
         .customResponse(CustomResponseProperty.builder()
                 .responseCode(123)
                 // the properties below are optional
                 .customResponseBodyKey("customResponseBodyKey")
                 .responseHeaders(List.of(CustomHTTPHeaderProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWebACL.BlockActionProperty.Builder A builder for CfnWebACL.BlockActionProperty
static class	CfnWebACL.BlockActionProperty.Jsii$Proxy An implementation for CfnWebACL.BlockActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.BlockActionProperty.Builder	builder()
default Object	getCustomResponse() Defines a custom response for the web request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomResponse

@Stability(value=Stable)
 @Nullable
default Object getCustomResponse()

Defines a custom response for the web request.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .

builder

@Stability(value=Stable)
static CfnWebACL.BlockActionProperty.Builder builder()

Returns:

a CfnWebACL.BlockActionProperty.Builder of CfnWebACL.BlockActionProperty