Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.RequestInspectionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.RequestInspectionProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

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

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

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.

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.*;
 RequestInspectionProperty requestInspectionProperty = RequestInspectionProperty.builder()
         .passwordField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .payloadType("payloadType")
         .usernameField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.RequestInspectionProperty.Builder	builder()
Object	getPasswordField()	The name of the field in the request payload that contains your customer's password.
String	getPayloadType()	The payload type for your login endpoint, either JSON or form encoded.
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

getPasswordField

@Stability(Stable)
@NotNull
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 .

See Also:

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

getPayloadType

@Stability(Stable)
@NotNull
String getPayloadType()

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

See Also:

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

getUsernameField

@Stability(Stable)
@NotNull
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

See Also:

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

builder

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

Returns:

a CfnWebACL.RequestInspectionProperty.Builder of CfnWebACL.RequestInspectionProperty