com.amazonaws.services.wafv2.model

Class ManagedRuleGroupConfig

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. Many managed rule groups don't require this.

Use the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

For example specifications, see the examples section of CreateWebACL.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ManagedRuleGroupConfig()

Method Summary

Modifier and Type	Method and Description
ManagedRuleGroupConfig	clone()
boolean	equals(Object obj)
AWSManagedRulesATPRuleSet	getAWSManagedRulesATPRuleSet() Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet.
AWSManagedRulesBotControlRuleSet	getAWSManagedRulesBotControlRuleSet() Additional configuration for using the Bot Control managed rule group.
String	getLoginPath() Deprecated.
PasswordField	getPasswordField() Deprecated.
String	getPayloadType() Deprecated.
UsernameField	getUsernameField() Deprecated.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAWSManagedRulesATPRuleSet(AWSManagedRulesATPRuleSet aWSManagedRulesATPRuleSet) Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet.
void	setAWSManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSet aWSManagedRulesBotControlRuleSet) Additional configuration for using the Bot Control managed rule group.
void	setLoginPath(String loginPath) Deprecated.
void	setPasswordField(PasswordField passwordField) Deprecated.
void	setPayloadType(String payloadType) Deprecated.
void	setUsernameField(UsernameField usernameField) Deprecated.
String	toString() Returns a string representation of this object.
ManagedRuleGroupConfig	withAWSManagedRulesATPRuleSet(AWSManagedRulesATPRuleSet aWSManagedRulesATPRuleSet) Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet.
ManagedRuleGroupConfig	withAWSManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSet aWSManagedRulesBotControlRuleSet) Additional configuration for using the Bot Control managed rule group.
ManagedRuleGroupConfig	withLoginPath(String loginPath) Deprecated.
ManagedRuleGroupConfig	withPasswordField(PasswordField passwordField) Deprecated.
ManagedRuleGroupConfig	withPayloadType(PayloadType payloadType) Deprecated.
ManagedRuleGroupConfig	withPayloadType(String payloadType) Deprecated.
ManagedRuleGroupConfig	withUsernameField(UsernameField usernameField) Deprecated.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ManagedRuleGroupConfig

public ManagedRuleGroupConfig()

Method Detail

setLoginPath

@Deprecated
public void setLoginPath(String loginPath)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

Parameters:

loginPath -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

getLoginPath

@Deprecated
public String getLoginPath()

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

Returns:

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

withLoginPath

@Deprecated
public ManagedRuleGroupConfig withLoginPath(String loginPath)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

Parameters:

loginPath -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPayloadType

@Deprecated
public void setPayloadType(String payloadType)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

payloadType -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

See Also:

PayloadType

getPayloadType

@Deprecated
public String getPayloadType()

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

See Also:

PayloadType

withPayloadType

@Deprecated
public ManagedRuleGroupConfig withPayloadType(String payloadType)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

payloadType -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PayloadType

withPayloadType

@Deprecated
public ManagedRuleGroupConfig withPayloadType(PayloadType payloadType)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

payloadType -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PayloadType

setUsernameField

@Deprecated
public void setUsernameField(UsernameField usernameField)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

usernameField -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

getUsernameField

@Deprecated
public UsernameField getUsernameField()

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

withUsernameField

@Deprecated
public ManagedRuleGroupConfig withUsernameField(UsernameField usernameField)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

usernameField -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPasswordField

@Deprecated
public void setPasswordField(PasswordField passwordField)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

passwordField -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

getPasswordField

@Deprecated
public PasswordField getPasswordField()

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

withPasswordField

@Deprecated
public ManagedRuleGroupConfig withPasswordField(PasswordField passwordField)

Deprecated.

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Parameters:

passwordField -

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet RequestInspection.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAWSManagedRulesBotControlRuleSet

public void setAWSManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSet aWSManagedRulesBotControlRuleSet)

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

Parameters:

aWSManagedRulesBotControlRuleSet - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

getAWSManagedRulesBotControlRuleSet

public AWSManagedRulesBotControlRuleSet getAWSManagedRulesBotControlRuleSet()

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

Returns:

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

withAWSManagedRulesBotControlRuleSet

public ManagedRuleGroupConfig withAWSManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSet aWSManagedRulesBotControlRuleSet)

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

Parameters:

aWSManagedRulesBotControlRuleSet - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAWSManagedRulesATPRuleSet

public void setAWSManagedRulesATPRuleSet(AWSManagedRulesATPRuleSet aWSManagedRulesATPRuleSet)

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

Parameters:

aWSManagedRulesATPRuleSet - Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

getAWSManagedRulesATPRuleSet

public AWSManagedRulesATPRuleSet getAWSManagedRulesATPRuleSet()

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

Returns:

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

withAWSManagedRulesATPRuleSet

public ManagedRuleGroupConfig withAWSManagedRulesATPRuleSet(AWSManagedRulesATPRuleSet aWSManagedRulesATPRuleSet)

Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

Parameters:

aWSManagedRulesATPRuleSet - Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.

For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.

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)

Specified by:

marshall in interface StructuredPojo