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

Class SignInPolicyType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.SignInPolicyType

All Implemented Interfaces:

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

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

The policy for allowed types of authentication in 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	SignInPolicyType.Builder

Method Summary

Modifier and Type	Method	Description
List<AuthFactorType>	allowedFirstAuthFactors()	The sign-in methods that a user pool supports as the first factor.
List<String>	allowedFirstAuthFactorsAsStrings()	The sign-in methods that a user pool supports as the first factor.
static SignInPolicyType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedFirstAuthFactors()	For responses, this returns true if the service returned a value for the AllowedFirstAuthFactors property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SignInPolicyType.Builder>	serializableBuilderClass()
SignInPolicyType.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

allowedFirstAuthFactors

public final List<AuthFactorType> allowedFirstAuthFactors()

The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.

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 hasAllowedFirstAuthFactors() method.

Returns:

The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.

hasAllowedFirstAuthFactors

public final boolean hasAllowedFirstAuthFactors()

For responses, this returns true if the service returned a value for the AllowedFirstAuthFactors 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.

allowedFirstAuthFactorsAsStrings

public final List<String> allowedFirstAuthFactorsAsStrings()

The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.

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 hasAllowedFirstAuthFactors() method.

Returns:

The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.

toBuilder

public SignInPolicyType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SignInPolicyType.Builder,SignInPolicyType>

builder

public static SignInPolicyType.Builder builder()

serializableBuilderClass

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