software.amazon.awssdk.services.wafv2.model

Class ManagedRuleGroupConfig

java.lang.Object

software.amazon.awssdk.services.wafv2.model.ManagedRuleGroupConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ManagedRuleGroupConfig.Builder,ManagedRuleGroupConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class ManagedRuleGroupConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ManagedRuleGroupConfig.Builder,ManagedRuleGroupConfig>

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ManagedRuleGroupConfig.Builder

Method Summary

Modifier and Type	Method and Description
AWSManagedRulesBotControlRuleSet	awsManagedRulesBotControlRuleSet() Additional configuration for using the Bot Control managed rule group.
static ManagedRuleGroupConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	loginPath() The path of the login endpoint for your application.
PasswordField	passwordField() Details about your login page password field.
PayloadType	payloadType() The payload type for your login endpoint, either JSON or form encoded.
String	payloadTypeAsString() The payload type for your login endpoint, either JSON or form encoded.
List<SdkField<?>>	sdkFields()
static Class<? extends ManagedRuleGroupConfig.Builder>	serializableBuilderClass()
ManagedRuleGroupConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UsernameField	usernameField() Details about your login page username field.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

loginPath

public final 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.

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.

payloadType

public final PayloadType payloadType()

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

If the service returns an enum value that is not available in the current SDK version, payloadType will return PayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadTypeAsString().

Returns:

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

See Also:

PayloadType

payloadTypeAsString

public final String payloadTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, payloadType will return PayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadTypeAsString().

Returns:

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

See Also:

PayloadType

usernameField

public final UsernameField usernameField()

Details about your login page username field.

Returns:

Details about your login page username field.

passwordField

public final PasswordField passwordField()

Details about your login page password field.

Returns:

Details about your login page password field.

awsManagedRulesBotControlRuleSet

public final 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.

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.

toBuilder

public ManagedRuleGroupConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ManagedRuleGroupConfig.Builder,ManagedRuleGroupConfig>

builder

public static ManagedRuleGroupConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ManagedRuleGroupConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo