ManagedRuleGroupConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.ManagedRuleGroupConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ManagedRuleGroupConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ManagedRuleGroupConfig()

Constructors
Constructor and Description
`ManagedRuleGroupConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ManagedRuleGroupConfig`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLoginPath()` The path of the login endpoint for your application.
`PasswordField`	`getPasswordField()` Details about your login page password field.
`String`	`getPayloadType()` The payload type for your login endpoint, either JSON or form encoded.
`UsernameField`	`getUsernameField()` Details about your login page username field.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLoginPath(String loginPath)` The path of the login endpoint for your application.
`void`	`setPasswordField(PasswordField passwordField)` Details about your login page password field.
`void`	`setPayloadType(String payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`void`	`setUsernameField(UsernameField usernameField)` Details about your login page username field.
`String`	`toString()` Returns a string representation of this object.
`ManagedRuleGroupConfig`	`withLoginPath(String loginPath)` The path of the login endpoint for your application.
`ManagedRuleGroupConfig`	`withPasswordField(PasswordField passwordField)` Details about your login page password field.
`ManagedRuleGroupConfig`	`withPayloadType(PayloadType payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`ManagedRuleGroupConfig`	`withPayloadType(String payloadType)` The payload type for your login endpoint, either JSON or form encoded.
`ManagedRuleGroupConfig`	`withUsernameField(UsernameField usernameField)` Details about your login page username field.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ManagedRuleGroupConfig
```
public ManagedRuleGroupConfig()
```
- Method Detail
  - setLoginPath
```
public void setLoginPath(String loginPath)
```
    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.
    
    Parameters:
    
    loginPath - 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.
  - getLoginPath
```
public 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.
    
    Returns:
    
    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.
  - withLoginPath
```
public ManagedRuleGroupConfig withLoginPath(String loginPath)
```
    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.
    
    Parameters:
    
    loginPath - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPayloadType
```
public void setPayloadType(String payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    See Also:
    
    PayloadType
  - getPayloadType
```
public String getPayloadType()
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    The payload type for your login endpoint, either JSON or form encoded.
    
    See Also:
    
    PayloadType
  - withPayloadType
```
public ManagedRuleGroupConfig withPayloadType(String payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadType
  - withPayloadType
```
public ManagedRuleGroupConfig withPayloadType(PayloadType payloadType)
```
    The payload type for your login endpoint, either JSON or form encoded.
    
    Parameters:
    
    payloadType - The payload type for your login endpoint, either JSON or form encoded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PayloadType
  - setUsernameField
```
public void setUsernameField(UsernameField usernameField)
```
    Details about your login page username field.
    
    Parameters:
    
    usernameField - Details about your login page username field.
  - getUsernameField
```
public UsernameField getUsernameField()
```
    Details about your login page username field.
    
    Returns:
    
    Details about your login page username field.
  - withUsernameField
```
public ManagedRuleGroupConfig withUsernameField(UsernameField usernameField)
```
    Details about your login page username field.
    
    Parameters:
    
    usernameField - Details about your login page username field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPasswordField
```
public void setPasswordField(PasswordField passwordField)
```
    Details about your login page password field.
    
    Parameters:
    
    passwordField - Details about your login page password field.
  - getPasswordField
```
public PasswordField getPasswordField()
```
    Details about your login page password field.
    
    Returns:
    
    Details about your login page password field.
  - withPasswordField
```
public ManagedRuleGroupConfig withPasswordField(PasswordField passwordField)
```
    Details about your login page password field.
    
    Parameters:
    
    passwordField - Details about your login page password field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ManagedRuleGroupConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ManagedRuleGroupConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ManagedRuleGroupConfig

Method Detail

setLoginPath

getLoginPath

withLoginPath

setPayloadType

getPayloadType

withPayloadType

withPayloadType

setUsernameField

getUsernameField

withUsernameField

setPasswordField

getPasswordField

withPasswordField

toString

equals

hashCode

clone

marshall