Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.FieldToProtectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.FieldToProtectProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.FieldToProtectProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a field type and keys to protect in stored web request data.

This is part of the data protection configuration for a web ACL.

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.*;
 FieldToProtectProperty fieldToProtectProperty = FieldToProtectProperty.builder()
         .fieldType("fieldType")
         // the properties below are optional
         .fieldKeys(List.of("fieldKeys"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.FieldToProtectProperty.Builder	builder()
default List<String>	getFieldKeys()	Specifies the keys to protect for the specified field type.
String	getFieldType()	Specifies the web request component type to protect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldType

@Stability(Stable)
@NotNull
String getFieldType()

Specifies the web request component type to protect.

See Also:

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

getFieldKeys

@Stability(Stable)
@Nullable
default List<String> getFieldKeys()

Specifies the keys to protect for the specified field type.

If you don't specify any key, then all keys for the field type are protected.

See Also:

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

builder

@Stability(Stable)
static CfnWebACL.FieldToProtectProperty.Builder builder()

Returns:

a CfnWebACL.FieldToProtectProperty.Builder of CfnWebACL.FieldToProtectProperty