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

Class UserPoolAddOnsType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.UserPoolAddOnsType

All Implemented Interfaces:

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

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

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserPoolAddOnsType.Builder

Method Summary

Modifier and Type	Method	Description
AdvancedSecurityAdditionalFlowsType	advancedSecurityAdditionalFlows()	Advanced security configuration options for additional authentication types in your user pool, including custom authentication.
AdvancedSecurityModeType	advancedSecurityMode()	The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
String	advancedSecurityModeAsString()	The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.
static UserPoolAddOnsType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UserPoolAddOnsType.Builder>	serializableBuilderClass()
UserPoolAddOnsType.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

advancedSecurityMode

public final AdvancedSecurityModeType advancedSecurityMode()

The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

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

Returns:

The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

See Also:

AdvancedSecurityModeType

advancedSecurityModeAsString

public final String advancedSecurityModeAsString()

The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

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

Returns:

The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication.

See Also:

AdvancedSecurityModeType

advancedSecurityAdditionalFlows

public final AdvancedSecurityAdditionalFlowsType advancedSecurityAdditionalFlows()

Advanced security configuration options for additional authentication types in your user pool, including custom authentication.

Returns:

Advanced security configuration options for additional authentication types in your user pool, including custom authentication.

toBuilder

public UserPoolAddOnsType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserPoolAddOnsType.Builder,UserPoolAddOnsType>

builder

public static UserPoolAddOnsType.Builder builder()

serializableBuilderClass

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