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

Class AccountTakeoverActionType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AccountTakeoverActionType

All Implemented Interfaces:

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

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

The automated response to a risk level for adaptive authentication in full-function, or ENFORCED, mode. You can assign an action to each risk level that advanced security features evaluates.

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	AccountTakeoverActionType.Builder

Method Summary

Modifier and Type	Method	Description
static AccountTakeoverActionType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AccountTakeoverEventActionType	eventAction()	The action to take for the attempted account takeover action for the associated risk level.
String	eventActionAsString()	The action to take for the attempted account takeover action for the associated risk level.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
Boolean	sendNotification()	Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
static Class<? extends AccountTakeoverActionType.Builder>	serializableBuilderClass()
AccountTakeoverActionType.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

eventAction

public final AccountTakeoverEventActionType eventAction()

The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

• BLOCK: Block the request.

• MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

• MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

• NO_ACTION: Take no action. Permit sign-in.

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

Returns:

The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

• BLOCK: Block the request.

• MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

• MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

• NO_ACTION: Take no action. Permit sign-in.

See Also:

AccountTakeoverEventActionType

eventActionAsString

public final String eventActionAsString()

The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

• BLOCK: Block the request.

• MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

• MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

• NO_ACTION: Take no action. Permit sign-in.

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

Returns:

The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

• BLOCK: Block the request.

• MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

• MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

• NO_ACTION: Take no action. Permit sign-in.

See Also:

AccountTakeoverEventActionType

sendNotification

public final Boolean sendNotification()

Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

Returns:

Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

toBuilder

public AccountTakeoverActionType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccountTakeoverActionType.Builder,AccountTakeoverActionType>

builder

public static AccountTakeoverActionType.Builder builder()

serializableBuilderClass

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