Class CfnWebACL.RequestInspectionACFPProperty

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

Inheritance

object

CfnWebACL.RequestInspectionACFPProperty

Implements

CfnWebACL.IRequestInspectionACFPProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWebACL.RequestInspectionACFPProperty : CfnWebACL.IRequestInspectionACFPProperty

Syntax (vb)

Public Class CfnWebACL.RequestInspectionACFPProperty Implements CfnWebACL.IRequestInspectionACFPProperty

Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFv2;

             var requestInspectionACFPProperty = new RequestInspectionACFPProperty {
                 PayloadType = "payloadType",

                 // the properties below are optional
                 AddressFields = new [] { new FieldIdentifierProperty {
                     Identifier = "identifier"
                 } },
                 EmailField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 },
                 PasswordField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 },
                 PhoneNumberFields = new [] { new FieldIdentifierProperty {
                     Identifier = "identifier"
                 } },
                 UsernameField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 }
             };

Synopsis

Constructors

RequestInspectionACFPProperty()

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

Properties

AddressFields	The names of the fields in the request payload that contain your customer's primary physical address.
EmailField	The name of the field in the request payload that contains your customer's email.
PasswordField	The name of the field in the request payload that contains your customer's password.
PayloadType	The payload type for your account creation endpoint, either JSON or form encoded.
PhoneNumberFields	The names of the fields in the request payload that contain your customer's primary phone number.
UsernameField	The name of the field in the request payload that contains your customer's username.

Constructors

RequestInspectionACFPProperty()

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

public RequestInspectionACFPProperty()

Remarks

This is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig .

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.WAFv2;

             var requestInspectionACFPProperty = new RequestInspectionACFPProperty {
                 PayloadType = "payloadType",

                 // the properties below are optional
                 AddressFields = new [] { new FieldIdentifierProperty {
                     Identifier = "identifier"
                 } },
                 EmailField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 },
                 PasswordField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 },
                 PhoneNumberFields = new [] { new FieldIdentifierProperty {
                     Identifier = "identifier"
                 } },
                 UsernameField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 }
             };

Properties

AddressFields

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

public object? AddressFields { get; set; }

Property Value

object

Remarks

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 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 example, for an HTML form with input elements named primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 , the address fields identifiers are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 .

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

Type union: either IResolvable or (either IResolvable or CfnWebACL.IFieldIdentifierProperty)[]

EmailField

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

public object? EmailField { get; set; }

Property Value

object

Remarks

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

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

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

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

Type union: either IResolvable or CfnWebACL.IFieldIdentifierProperty

PasswordField

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

public object? PasswordField { get; set; }

Property Value

object

Remarks

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

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

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

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

Type union: either IResolvable or CfnWebACL.IFieldIdentifierProperty

PayloadType

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

public string PayloadType { get; set; }

Property Value

string

Remarks

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

PhoneNumberFields

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

public object? PhoneNumberFields { get; set; }

Property Value

object

Remarks

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 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 example, for an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 .

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

Type union: either IResolvable or (either IResolvable or CfnWebACL.IFieldIdentifierProperty)[]

UsernameField

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

public object? UsernameField { get; set; }

Property Value

object

Remarks

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

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

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

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

Type union: either IResolvable or CfnWebACL.IFieldIdentifierProperty

Implements

CfnWebACL.IRequestInspectionACFPProperty