Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class RiskExceptionConfigurationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.RiskExceptionConfigurationType

All Implemented Interfaces:

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

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

Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.

This data type is a request parameter of SetRiskConfiguration and a response parameter of DescribeRiskConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RiskExceptionConfigurationType.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	blockedIPRangeList()	An always-block IP address list.
static RiskExceptionConfigurationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockedIPRangeList()	For responses, this returns true if the service returned a value for the BlockedIPRangeList property.
int	hashCode()
boolean	hasSkippedIPRangeList()	For responses, this returns true if the service returned a value for the SkippedIPRangeList property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RiskExceptionConfigurationType.Builder>	serializableBuilderClass()
List<String>	skippedIPRangeList()	An always-allow IP address list.
RiskExceptionConfigurationType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasBlockedIPRangeList

public final boolean hasBlockedIPRangeList()

For responses, this returns true if the service returned a value for the BlockedIPRangeList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

blockedIPRangeList

public final List<String> blockedIPRangeList()

An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockedIPRangeList() method.

Returns:

An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation.

hasSkippedIPRangeList

public final boolean hasSkippedIPRangeList()

For responses, this returns true if the service returned a value for the SkippedIPRangeList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

skippedIPRangeList

public final List<String> skippedIPRangeList()

An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSkippedIPRangeList() method.

Returns:

An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation.

toBuilder

public RiskExceptionConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RiskExceptionConfigurationType.Builder,RiskExceptionConfigurationType>

builder

public static RiskExceptionConfigurationType.Builder builder()

serializableBuilderClass

public static Class<? extends RiskExceptionConfigurationType.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo