software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ManagedRuleGroupConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.ManagedRuleGroupConfigProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(value=Stable)
public static interface CfnWebACL.ManagedRuleGroupConfigProperty
extends software.amazon.jsii.JsiiSerializable

Additional information that's used by a managed rule group. Most managed rule groups don't require this.

Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet , to provide information about the sign-in page of your application.

You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration, for example UsernameField and PasswordField . The configuration that you provide depends on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual configuration objects: LoginPath , PasswordField , PayloadType and UsernameField .

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.ManagedRuleGroupConfigProperty.Builder	builder()
default String	getLoginPath() The path of the login endpoint for your application.
default Object	getPasswordField() Details about your login page password field.
default String	getPayloadType() The payload type for your login endpoint, either JSON or form encoded.
default Object	getUsernameField() Details about your login page username field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLoginPath

@Stability(value=Stable)
 @Nullable
default String getLoginPath()

The path of the login endpoint for your application.

For example, for the URL https://example.com/web/login , you would provide the path /web/login .

getPasswordField

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

Details about your login page password field.

getPayloadType

@Stability(value=Stable)
 @Nullable
default String getPayloadType()

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

getUsernameField

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

Details about your login page username field.

builder

@Stability(value=Stable)
static CfnWebACL.ManagedRuleGroupConfigProperty.Builder builder()

Returns:

a CfnWebACL.ManagedRuleGroupConfigProperty.Builder of CfnWebACL.ManagedRuleGroupConfigProperty