Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Interface CfnWebACLPropsMixin.BlockActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACLPropsMixin.BlockActionProperty.Jsii$Proxy

Enclosing class:

CfnWebACLPropsMixin

@Stability(Stable)
public static interface CfnWebACLPropsMixin.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.cfnpropertymixins.services.wafv2.*;
 BlockActionProperty blockActionProperty = BlockActionProperty.builder()
         .customResponse(CustomResponseProperty.builder()
                 .customResponseBodyKey("customResponseBodyKey")
                 .responseCode(123)
                 .responseHeaders(List.of(CustomHTTPHeaderProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACLPropsMixin.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 Details

getCustomResponse

@Stability(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 .

Returns union: either IResolvable or CfnWebACLPropsMixin.CustomResponseProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html#cfn-wafv2-webacl-blockaction-customresponse

builder

@Stability(Stable)
static CfnWebACLPropsMixin.BlockActionProperty.Builder builder()

Returns:

a CfnWebACLPropsMixin.BlockActionProperty.Builder of CfnWebACLPropsMixin.BlockActionProperty