Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.FieldIdentifierProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.FieldIdentifierProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

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

The identifier of a field in the web request payload that contains customer data.

This data type is used to specify fields in the RequestInspection and RequestInspectionACFP configurations, which are used in the managed rule group configurations AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet , respectively.

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.*;
 FieldIdentifierProperty fieldIdentifierProperty = FieldIdentifierProperty.builder()
         .identifier("identifier")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.FieldIdentifierProperty.Builder	builder()
String	getIdentifier()	The name of the field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentifier

@Stability(Stable)
@NotNull
String getIdentifier()

The name of the field.

When the PayloadType in the request inspection is JSON , this identifier must be in JSON pointer syntax. For example /form/username . For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

When the PayloadType is FORM_ENCODED , use the HTML form names. For example, username .

For more information, see the descriptions for each field type in the request inspection properties.

See Also:

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

builder

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

Returns:

a CfnWebACL.FieldIdentifierProperty.Builder of CfnWebACL.FieldIdentifierProperty