Interface CfnWebACL.IRequestInspectionProperty

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnWebACL.IRequestInspectionProperty

Syntax (vb)

Public Interface CfnWebACL.IRequestInspectionProperty

Remarks

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig .

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-requestinspection.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 requestInspectionProperty = new RequestInspectionProperty {
                 PasswordField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 },
                 PayloadType = "payloadType",
                 UsernameField = new FieldIdentifierProperty {
                     Identifier = "identifier"
                 }
             };

Synopsis

Properties

PasswordField	The name of the field in the request payload that contains your customer's password.
PayloadType	The payload type for your login endpoint, either JSON or form encoded.
UsernameField	The name of the field in the request payload that contains your customer's username.

Properties

PasswordField

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

object PasswordField { get; }

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-requestinspection.html#cfn-wafv2-webacl-requestinspection-passwordfield

Type union: either IResolvable or CfnWebACL.IFieldIdentifierProperty

PayloadType

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

string PayloadType { get; }

Property Value

string

Remarks

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

UsernameField

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

object UsernameField { get; }

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-requestinspection.html#cfn-wafv2-webacl-requestinspection-usernamefield

Type union: either IResolvable or CfnWebACL.IFieldIdentifierProperty