Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.RequestInspectionACFPProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.RequestInspectionACFPProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

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

The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig .

In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.

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.*;
 RequestInspectionACFPProperty requestInspectionACFPProperty = RequestInspectionACFPProperty.builder()
         .payloadType("payloadType")
         // the properties below are optional
         .addressFields(List.of(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build()))
         .emailField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .passwordField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .phoneNumberFields(List.of(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build()))
         .usernameField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.RequestInspectionACFPProperty.Builder	builder()
default Object	getAddressFields()	The names of the fields in the request payload that contain your customer's primary physical address.
default Object	getEmailField()	The name of the field in the request payload that contains your customer's email.
default Object	getPasswordField()	The name of the field in the request payload that contains your customer's password.
String	getPayloadType()	The payload type for your account creation endpoint, either JSON or form encoded.
default Object	getPhoneNumberFields()	The names of the fields in the request payload that contain your customer's primary phone number.
default Object	getUsernameField()	The name of the field in the request payload that contains your customer's username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPayloadType

@Stability(Stable)
@NotNull
String getPayloadType()

The payload type for your account creation endpoint, either JSON or form encoded.

See Also:

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

getAddressFields

@Stability(Stable)
@Nullable
default Object getAddressFields()

The names of the fields in the request payload that contain your customer's primary physical address.

Order the address fields in the array exactly as they are ordered in the request payload.

How you specify the address fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1 , /form/primaryaddressline2 , and /form/primaryaddressline3 .

• For form encoded payload types, use the HTML form names.

For example, for an HTML form with input elements named primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 , the address fields identifiers are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWebACL.FieldIdentifierProperty>

See Also:

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

getEmailField

@Stability(Stable)
@Nullable
default Object getEmailField()

The name of the field in the request payload that contains your customer's email.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

For example, for the JSON payload { "form": { "email": "THE_EMAIL" } } , the email field specification is /form/email .

• For form encoded payload types, use the HTML form names.

For example, for an HTML form with the input element named email1 , the email field specification is email1 .

Returns union: either IResolvable or CfnWebACL.FieldIdentifierProperty

See Also:

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

getPasswordField

@Stability(Stable)
@Nullable
default Object getPasswordField()

The name of the field in the request payload that contains your customer's password.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , the password field specification is /form/password .

• For form encoded payload types, use the HTML form names.

For example, for an HTML form with the input element named password1 , the password field specification is password1 .

Returns union: either IResolvable or CfnWebACL.FieldIdentifierProperty

See Also:

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

getPhoneNumberFields

@Stability(Stable)
@Nullable
default Object getPhoneNumberFields()

The names of the fields in the request payload that contain your customer's primary phone number.

Order the phone number fields in the array exactly as they are ordered in the request payload.

How you specify the phone number fields depends on the request inspection payload type.

• For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } } , the phone number field identifiers are /form/primaryphoneline1 , /form/primaryphoneline2 , and /form/primaryphoneline3 .

• For form encoded payload types, use the HTML form names.

For example, for an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWebACL.FieldIdentifierProperty>

See Also:

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

getUsernameField

@Stability(Stable)
@Nullable
default Object getUsernameField()

The name of the field in the request payload that contains your customer's username.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer .

For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , the username field specification is /form/username .

• For form encoded payload types, use the HTML form names.

For example, for an HTML form with the input element named username1 , the username field specification is username1

Returns union: either IResolvable or CfnWebACL.FieldIdentifierProperty

See Also:

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

builder

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

Returns:

a CfnWebACL.RequestInspectionACFPProperty.Builder of CfnWebACL.RequestInspectionACFPProperty